czmq-ffi-gen 0.9.1-x86-mingw32

data/lib/czmq-ffi-gen/czmq/ffi/zuuid.rb

@@ -0,0 +1,227 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # UUID support class
+    # @note This class is 100% generated using zproject.
+    class Zuuid
+      # Raised when one tries to use an instance of {Zuuid} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zuuid_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        __undef_finalizer if @finalizer
+        @ptr = nil
+        ptr_ptr
+      end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
+
+      # Create a new UUID object.
+      # @return [CZMQ::Zuuid]
+      def self.new()
+        ptr = ::CZMQ::FFI.zuuid_new()
+        __new ptr
+      end
+
+      # Create UUID object from supplied ZUUID_LEN-octet value.
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zuuid]
+      def self.new_from(source)
+        ptr = ::CZMQ::FFI.zuuid_new_from(source)
+        __new ptr
+      end
+
+      # Destroy a specified UUID object.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zuuid_destroy(self_p)
+        result
+      end
+
+      # Set UUID to new supplied ZUUID_LEN-octet value.
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def set(source)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_set(self_p, source)
+        result
+      end
+
+      # Set UUID to new supplied string value skipping '-' and '{' '}'
+      # optional delimiters. Return 0 if OK, else returns -1.         
+      #
+      # @param source [String, #to_s, nil]
+      # @return [Integer]
+      def set_str(source)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_set_str(self_p, source)
+        result
+      end
+
+      # Return UUID binary data.
+      #
+      # @return [::FFI::Pointer]
+      def data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_data(self_p)
+        result
+      end
+
+      # Return UUID binary size
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_size(self_p)
+        result
+      end
+
+      # Returns UUID as string
+      #
+      # @return [String]
+      def str()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_str(self_p)
+        result
+      end
+
+      # Return UUID in the canonical string format: 8-4-4-4-12, in lower
+      # case. Caller does not modify or free returned value. See        
+      # http://en.wikipedia.org/wiki/Universally_unique_identifier      
+      #
+      # @return [String]
+      def str_canonical()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_str_canonical(self_p)
+        result
+      end
+
+      # Store UUID blob in target array
+      #
+      # @param target [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def export(target)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_export(self_p, target)
+        result
+      end
+
+      # Check if UUID is same as supplied value
+      #
+      # @param compare [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def eq(compare)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_eq(self_p, compare)
+        result
+      end
+
+      # Check if UUID is different from supplied value
+      #
+      # @param compare [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def neq(compare)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_neq(self_p, compare)
+        result
+      end
+
+      # Make copy of UUID object; if uuid is null, or memory was exhausted,
+      # returns null.                                                      
+      #
+      # @return [Zuuid]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_dup(self_p)
+        result = Zuuid.__new result, false
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zuuid_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

data/lib/czmq-ffi-gen/errors.rb

@@ -0,0 +1,12 @@
+# This is only used to be able to read get the last ZMQ error.
+module CZMQ::FFI::Errors
+  # @return [String] error code of the last (ZMQ) error
+  def self.errno
+    CZMQ::FFI::LibZMQ.zmq_errno
+  end
+
+  # @return [String] the string representation of the last (ZMQ) error
+  def self.strerror
+    CZMQ::FFI::LibZMQ.zmq_strerror(CZMQ::FFI::LibZMQ.zmq_errno)
+  end
+end

data/lib/czmq-ffi-gen/gem_version.rb

@@ -0,0 +1,5 @@
+module CZMQ
+  module FFI
+    GEM_VERSION = "0.9.1"
+  end
+end

data/lib/czmq-ffi-gen/legacy.rb

@@ -0,0 +1,16 @@
+module CZMQ::FFI
+  if available?
+    opts = {
+      blocking: true  # only necessary on MRI to deal with the GIL.
+    }
+
+    ##
+    # NOTE: this is to support the current stable release, CZMQ 3.0.2
+    #
+    # attach zsys_has_curve (as zproc_has_curve), if zproc_has_curve isn't
+    # available
+    unless methods.include? :zproc_has_curve
+      attach_function :zproc_has_curve, :zsys_has_curve, [], :bool, **opts
+    end
+  end
+end

data/lib/czmq-ffi-gen/libzmq.rb

@@ -0,0 +1,18 @@
+# Bare minimum to get some things directly from the ZMQ library itself
+# (without the CZMQ wrapper).
+module CZMQ::FFI::LibZMQ
+  extend ::FFI::Library
+
+  lib_name = 'libzmq'
+  lib_paths = ['/usr/local/lib', '/opt/local/lib', '/usr/lib64']
+    .map { |path| "#{path}/#{lib_name}.#{::FFI::Platform::LIBSUFFIX}" }
+  ffi_lib lib_paths + [lib_name]
+
+  opts = {
+    blocking: true  # only necessary on MRI to deal with the GIL.
+  }
+
+  attach_function :zmq_strerror, [:int], :string, **opts
+  attach_function :zmq_errno, [], :int, **opts
+  attach_function :zmq_version, [:pointer, :pointer, :pointer], :void, **opts
+end

data/lib/czmq-ffi-gen/signals.rb

@@ -0,0 +1,27 @@
+module CZMQ
+  module FFI
+
+    attach_function :zsys_handler_set, [:pointer], :void, blocking: true
+
+    # This is used to disable CZMQ's signal handling so blocking calls can be
+    # interrupted using Ctrl-C.
+    module Signals
+      module_function
+
+      @default_handling_disabled = false
+
+      # Disables default SIGINT/SIGTERM handling of CZMQ.
+      # @return [void]
+      def disable_default_handling
+        FFI.zsys_handler_set(nil)
+        @default_handling_disabled = true
+      end
+
+      # @return [Boolean] whether the CZMQ's default signal handling has been
+      #   disabled
+      def default_handling_disabled?
+        @default_handling_disabled
+      end
+    end
+  end
+end

data/lib/czmq-ffi-gen/vendor.rb

@@ -0,0 +1,5 @@
+base_dir = File.expand_path(File.join(__dir__, "..", ".."))
+vendor_bin_dir = File.join(base_dir, "vendor", "local", "bin")
+if File.exist?(vendor_bin_dir)
+  ENV["PATH"] = [vendor_bin_dir, ENV["PATH"]].join(File::PATH_SEPARATOR)
+end

data/lib/czmq-ffi-gen/versions.rb

@@ -0,0 +1,19 @@
+require_relative "gem_version"
+require_relative "libzmq"
+
+module CZMQ
+  module FFI
+    # CZMQ library version
+    CZMQ_VERSION = VERSION
+
+    # @deprecated Use {CZMQ_VERSION} instead.
+    LIBRARY_VERSION = CZMQ_VERSION
+
+    # ZMQ library version
+    ZMQ_VERSION = begin
+      version = Array.new(3) { ::FFI::MemoryPointer.new(:int) }
+      LibZMQ.zmq_version(*version)
+      version.map { |n| n.get_int(0) }.join(".")
+    end
+  end
+end

data/vendor/local/include/czmq.h

@@ -0,0 +1,31 @@
+/*  =========================================================================
+    CZMQ - a high-level binding in C for ZeroMQ
+
+    Copyright (c) the Contributors as noted in the AUTHORS file.
+    This file is part of CZMQ, the high-level C binding for 0MQ:
+    http://czmq.zeromq.org.
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    =========================================================================
+*/
+
+#ifndef __CZMQ_H_INCLUDED__
+#define __CZMQ_H_INCLUDED__
+
+//  These are signatures for handler functions that customize the
+//  behavior of CZMQ containers. These are shared between all CZMQ
+//  container types.
+
+//  -- destroy an item
+typedef void (czmq_destructor) (void **item);
+//  -- duplicate an item
+typedef void *(czmq_duplicator) (const void *item);
+//  - compare two items, for sorting
+typedef int (czmq_comparator) (const void *item1, const void *item2);
+
+//  Include the project library file
+#include "czmq_library.h"
+
+#endif

data/vendor/local/include/czmq_library.h

@@ -0,0 +1,199 @@
+/*  =========================================================================
+    czmq - generated layer of public API
+
+    Copyright (c) the Contributors as noted in the AUTHORS file.       
+    This file is part of CZMQ, the high-level C binding for 0MQ:       
+    http://czmq.zeromq.org.                                            
+                                                                       
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.           
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+    =========================================================================
+*/
+
+#ifndef CZMQ_LIBRARY_H_INCLUDED
+#define CZMQ_LIBRARY_H_INCLUDED
+
+//  Set up environment for the application
+#include "czmq_prelude.h"
+
+//  External dependencies
+#include <zmq.h>
+
+//  CZMQ version macros for compile-time API detection
+#define CZMQ_VERSION_MAJOR 3
+#define CZMQ_VERSION_MINOR 0
+#define CZMQ_VERSION_PATCH 3
+
+#define CZMQ_MAKE_VERSION(major, minor, patch) \
+    ((major) * 10000 + (minor) * 100 + (patch))
+#define CZMQ_VERSION \
+    CZMQ_MAKE_VERSION(CZMQ_VERSION_MAJOR, CZMQ_VERSION_MINOR, CZMQ_VERSION_PATCH)
+
+#if defined (__WINDOWS__)
+#   if defined CZMQ_STATIC
+#       define CZMQ_EXPORT
+#   elif defined CZMQ_INTERNAL_BUILD
+#       if defined DLL_EXPORT
+#           define CZMQ_EXPORT __declspec(dllexport)
+#       else
+#           define CZMQ_EXPORT
+#       endif
+#   elif defined CZMQ_EXPORTS
+#       define CZMQ_EXPORT __declspec(dllexport)
+#   else
+#       define CZMQ_EXPORT __declspec(dllimport)
+#   endif
+#else
+#   define CZMQ_EXPORT
+#endif
+
+//  Opaque class structures to allow forward references
+//  These classes are stable or legacy and built in all releases
+typedef struct _zactor_t zactor_t;
+#define ZACTOR_T_DEFINED
+typedef struct _zarmour_t zarmour_t;
+#define ZARMOUR_T_DEFINED
+typedef struct _zcert_t zcert_t;
+#define ZCERT_T_DEFINED
+typedef struct _zcertstore_t zcertstore_t;
+#define ZCERTSTORE_T_DEFINED
+typedef struct _zchunk_t zchunk_t;
+#define ZCHUNK_T_DEFINED
+typedef struct _zclock_t zclock_t;
+#define ZCLOCK_T_DEFINED
+typedef struct _zconfig_t zconfig_t;
+#define ZCONFIG_T_DEFINED
+typedef struct _zdigest_t zdigest_t;
+#define ZDIGEST_T_DEFINED
+typedef struct _zdir_t zdir_t;
+#define ZDIR_T_DEFINED
+typedef struct _zdir_patch_t zdir_patch_t;
+#define ZDIR_PATCH_T_DEFINED
+typedef struct _zfile_t zfile_t;
+#define ZFILE_T_DEFINED
+typedef struct _zframe_t zframe_t;
+#define ZFRAME_T_DEFINED
+typedef struct _zhash_t zhash_t;
+#define ZHASH_T_DEFINED
+typedef struct _zhashx_t zhashx_t;
+#define ZHASHX_T_DEFINED
+typedef struct _ziflist_t ziflist_t;
+#define ZIFLIST_T_DEFINED
+typedef struct _zlist_t zlist_t;
+#define ZLIST_T_DEFINED
+typedef struct _zlistx_t zlistx_t;
+#define ZLISTX_T_DEFINED
+typedef struct _zloop_t zloop_t;
+#define ZLOOP_T_DEFINED
+typedef struct _zmsg_t zmsg_t;
+#define ZMSG_T_DEFINED
+typedef struct _zpoller_t zpoller_t;
+#define ZPOLLER_T_DEFINED
+typedef struct _zsock_t zsock_t;
+#define ZSOCK_T_DEFINED
+typedef struct _zstr_t zstr_t;
+#define ZSTR_T_DEFINED
+typedef struct _zuuid_t zuuid_t;
+#define ZUUID_T_DEFINED
+typedef struct _zauth_t zauth_t;
+#define ZAUTH_T_DEFINED
+typedef struct _zbeacon_t zbeacon_t;
+#define ZBEACON_T_DEFINED
+typedef struct _zgossip_t zgossip_t;
+#define ZGOSSIP_T_DEFINED
+typedef struct _zmonitor_t zmonitor_t;
+#define ZMONITOR_T_DEFINED
+typedef struct _zproxy_t zproxy_t;
+#define ZPROXY_T_DEFINED
+typedef struct _zrex_t zrex_t;
+#define ZREX_T_DEFINED
+typedef struct _zsys_t zsys_t;
+#define ZSYS_T_DEFINED
+typedef struct _zauth_v2_t zauth_v2_t;
+#define ZAUTH_V2_T_DEFINED
+typedef struct _zbeacon_v2_t zbeacon_v2_t;
+#define ZBEACON_V2_T_DEFINED
+typedef struct _zctx_t zctx_t;
+#define ZCTX_T_DEFINED
+typedef struct _zmonitor_v2_t zmonitor_v2_t;
+#define ZMONITOR_V2_T_DEFINED
+typedef struct _zmutex_t zmutex_t;
+#define ZMUTEX_T_DEFINED
+typedef struct _zproxy_v2_t zproxy_v2_t;
+#define ZPROXY_V2_T_DEFINED
+typedef struct _zsocket_t zsocket_t;
+#define ZSOCKET_T_DEFINED
+typedef struct _zsockopt_t zsockopt_t;
+#define ZSOCKOPT_T_DEFINED
+typedef struct _zthread_t zthread_t;
+#define ZTHREAD_T_DEFINED
+//  Draft classes are by default not built in stable releases
+#ifdef CZMQ_BUILD_DRAFT_API
+typedef struct _zproc_t zproc_t;
+#define ZPROC_T_DEFINED
+typedef struct _ztimerset_t ztimerset_t;
+#define ZTIMERSET_T_DEFINED
+typedef struct _ztrie_t ztrie_t;
+#define ZTRIE_T_DEFINED
+#endif // CZMQ_BUILD_DRAFT_API
+
+
+//  Public classes, each with its own header file
+#include "zactor.h"
+#include "zarmour.h"
+#include "zcert.h"
+#include "zcertstore.h"
+#include "zchunk.h"
+#include "zclock.h"
+#include "zconfig.h"
+#include "zdigest.h"
+#include "zdir.h"
+#include "zdir_patch.h"
+#include "zfile.h"
+#include "zframe.h"
+#include "zhash.h"
+#include "zhashx.h"
+#include "ziflist.h"
+#include "zlist.h"
+#include "zlistx.h"
+#include "zloop.h"
+#include "zmsg.h"
+#include "zpoller.h"
+#include "zsock.h"
+#include "zstr.h"
+#include "zuuid.h"
+#include "zauth.h"
+#include "zbeacon.h"
+#include "zgossip.h"
+#include "zmonitor.h"
+#include "zproxy.h"
+#include "zrex.h"
+#include "zsys.h"
+#include "zauth_v2.h"
+#include "zbeacon_v2.h"
+#include "zctx.h"
+#include "zmonitor_v2.h"
+#include "zmutex.h"
+#include "zproxy_v2.h"
+#include "zsocket.h"
+#include "zsockopt.h"
+#include "zthread.h"
+#ifdef CZMQ_BUILD_DRAFT_API
+#include "zproc.h"
+#include "ztimerset.h"
+#include "ztrie.h"
+#endif // CZMQ_BUILD_DRAFT_API
+
+#endif
+/*
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+*/