czmq-ffi-gen 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3da0e81176fb0b1958a764932b2b3f5425aca69
-  data.tar.gz: 5321cfea3e669fedc76bdb678f69f96949af5883
+  metadata.gz: 0e7ea1498763380b45d14e2f37c8ca736ff24921
+  data.tar.gz: 30cb33214dc70fa3694bd58abbca662da97ca055
 SHA512:
-  metadata.gz: 597331314771987231a1b4564d025d32b54fa92c88efed7b091f273c30d869adcec03a675d1fbc3436e2f3dee5b857e7d4f5f56f678394fd7f7ee85389d6da8b
-  data.tar.gz: 3106a49ea1589d01034dadcef47b44562ed58313249ffcd317df778f13a2877471a6d1e209812b5d896fd152f7d4c70e781e488b5daa71450c0da779fcbe72e8
+  metadata.gz: 9b97a31986a2c80ee13ad7220ea965e457c94a814b39a763b50e4743787fe3bbc9b5455cf1a9abf4968afffea10fa5b8e5aeeb63d1d0e5a05e49d6e551470601
+  data.tar.gz: c6c557a7bf8038ed758b75832d64f0c5ed852e0d3ea5c6e50f5cebe6650c5b8e071d209345895f05e13ed66c217a2097af106f71ea321fdd9bd1261353645e2c

data/CHANGES.md

@@ -1,3 +1,9 @@
+0.7.0 (01/21/2016)
+-----
+* add support for current stable release 3.0.2 of CZMQ
+* upgrade CZMQ low-level binding to
+  - gracefully handle absent draft functions
+
 0.6.0 (01/15/2016)
 -----
 * upgrade CZMQ low-level binding to

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015, Patrik Wenger
+Copyright (c) 2016, Patrik Wenger
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/README.md

@@ -23,51 +23,64 @@ The actual generated code lies in CZMQ, which is Git submodule of this
 repository, registered under `vendor/czmq`.
 
 So if you're not happy with any of the generated code, go have a closer look at
-CZMQ or zproject, which is used by CZMQ to generate the low-level binding.
+[CZMQ](https://github.com/zeromq/czmq) (or
+[zproject](https://github.com/zeromq/zproject), which is used by CZMQ to
+generate the low-level binding).
 
 ### API Documentation
 For that same reason, API documentation of unreleased code (directly off this
 repository), like
 [rubydoc.info/github/paddor/czmq-ffi-gen](http://www.rubydoc.info/github/paddor/czmq-ffi-gen)
 **does NOT include any of the generated code**. _Rubydoc.info_ doesn't check
-out Git submodules as part of its documentation procedure. However, API
-documentation of the **released gem should work** just fine, as the gem release
-process will include all required source files directly within the gem.
-
-**Check out**
-[http://www.rubydoc.info/gems/czmq-ffi-gen](http://www.rubydoc.info/gems/czmq-ffi-gen)
-for the API documentation.
-
-## Supported Rubies
-
-Tested on CI with these:
-
-* Ruby 2.2.4
-* JRuby HEAD (>= 9.0.0.0)
-* Rubinius
+out Git submodules as part of its documentation procedure.
 
+However, the API documentation of the **released** gem should include all the
+code, as the gem release process will include all required source files
+directly within the gem.
 
-### Known NOT to work
+Check out
+[http://www.rubydoc.info/gems/czmq-ffi-gen](http://www.rubydoc.info/gems/czmq-ffi-gen)
+for the API documentation **for the released gem**.
 
-* JRuby 1.7.x
-  * doesn't work because of the use of the double splat operator (`**opts`)
+## Requirements
 
-## Installation
+* CZMQ >= 3.0
+* ZMQ >= 4.0
 
-This gem requires the presence of the CZMQ library, which in turn requires the
-ZMQ library. For **security mechanisms** like CURVE, you'll need
-[libsodium](https://github.com/jedisct1/libsodium) and at least ZMQ 4.0.
+For security mechanisms like CURVE, you'll need:
+* [libsodium](https://github.com/jedisct1/libsodium)<Paste>
 
 On OSX using homebrew, run:
 
     $ brew install libsodium
     $ brew install zmq --with-libsodium
-    $ brew install czmq
+    $ brew install czmq --HEAD
 
 If you're running Linux, go check [this page](http://zeromq.org/distro:_start)
 to get more help. Make sure to install CZMQ, not only ZMQ.
 
-To then use this gem, add this line to your application's Gemfile:
+**Note**: The option `--HEAD` is recommended because this binding is generated
+directly from CZMQ's master branch. However, it's not required.
+
+### Supported Rubies
+
+See [.travis.yml](https://github.com/paddor/czmq-ffi-gen/blob/master/.travis.yml)
+for a list of Ruby versions against which czmq-ffi-gen is tested.
+
+At the time of writing, these include:
+
+* MRI 2.3, 2.2.4, 2.1.8
+* Rubinius (HEAD)
+* JRuby 9000 (HEAD)
+
+#### Known NOT to work
+
+* JRuby 1.7.x and MRI < 2.0
+  * doesn't work because of the use of the double splat operator (`**opts`)
+
+## Installation
+
+To use this gem, add this line to your application's Gemfile:
 
 ```ruby
 gem 'czmq-ffi-gen'

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

@@ -6,7 +6,7 @@
 module CZMQ
   module FFI
 
-    # The zactor class provides a simple actor framework.
+    # provides a simple actor framework
     # @note This class is 100% generated using zproject.
     class Zactor
       # Raised when one tries to use an instance of {Zactor} after

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

@@ -6,7 +6,7 @@
 module CZMQ
   module FFI
 
-    # zarmour - armoured text encoding and decoding
+    # armoured text encoding and decoding
     # @note This class is 100% generated using zproject.
     class Zarmour
       # Raised when one tries to use an instance of {Zarmour} after

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

@@ -6,7 +6,7 @@
 module CZMQ
   module FFI
 
-    # zcert - work with CURVE security certificates
+    # work with CURVE security certificates
     # @note This class is 100% generated using zproject.
     class Zcert
       # Raised when one tries to use an instance of {Zcert} after

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

@@ -6,7 +6,7 @@
 module CZMQ
   module FFI
 
-    # zcertstore - work with CURVE security certificate stores
+    # work with CURVE security certificate stores
     # @note This class is 100% generated using zproject.
     class Zcertstore
       # Raised when one tries to use an instance of {Zcertstore} after

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

@@ -6,7 +6,7 @@
 module CZMQ
   module FFI
 
-    # 
+    # work with memory chunks
     # @note This class is 100% generated using zproject.
     class Zchunk
       # Raised when one tries to use an instance of {Zchunk} after

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

@@ -0,0 +1,140 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # millisecond clocks and delays
+    # @note This class is 100% generated using zproject.
+    class Zclock
+      # Raised when one tries to use an instance of {Zclock} 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
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          "WARNING: "\
+          "Objects of type #{self} cannot be destroyed implicitly. "\
+          "Please call the correct destroy method with the relevant arguments."
+        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
+
+      # Sleep for a number of milliseconds
+      #
+      # @param msecs [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.sleep(msecs)
+        msecs = Integer(msecs)
+        result = ::CZMQ::FFI.zclock_sleep(msecs)
+        result
+      end
+
+      # Return current system clock as milliseconds. Note that this clock can  
+      # jump backwards (if the system clock is changed) so is unsafe to use for
+      # timers and time offsets. Use zclock_mono for that instead.             
+      #
+      # @return [::FFI::Pointer]
+      def self.time()
+        result = ::CZMQ::FFI.zclock_time()
+        result
+      end
+
+      # Return current monotonic clock in milliseconds. Use this when you compute
+      # time offsets. The monotonic clock is not affected by system changes and  
+      # so will never be reset backwards, unlike a system clock.                 
+      #
+      # @return [::FFI::Pointer]
+      def self.mono()
+        result = ::CZMQ::FFI.zclock_mono()
+        result
+      end
+
+      # Return current monotonic clock in microseconds. Use this when you compute
+      # time offsets. The monotonic clock is not affected by system changes and  
+      # so will never be reset backwards, unlike a system clock.                 
+      #
+      # @return [::FFI::Pointer]
+      def self.usecs()
+        result = ::CZMQ::FFI.zclock_usecs()
+        result
+      end
+
+      # Return formatted date/time as fresh string. Free using zstr_free().
+      #
+      # @return [::FFI::AutoPointer]
+      def self.timestr()
+        result = ::CZMQ::FFI.zclock_timestr()
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zclock_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

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

@@ -0,0 +1,156 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # zdigest - provides hashing functions (SHA-1 at present)
+    # @note This class is 100% generated using zproject.
+    class Zdigest
+      # Raised when one tries to use an instance of {Zdigest} 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.zdigest_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
+
+      # Constructor - creates new digest object, which you use to build up a
+      # digest by repeatedly calling zdigest_update() on chunks of data.    
+      # @return [CZMQ::Zdigest]
+      def self.new()
+        ptr = ::CZMQ::FFI.zdigest_new()
+        __new ptr
+      end
+
+      # Destroy a digest object
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zdigest_destroy(self_p)
+        result
+      end
+
+      # Add buffer into digest calculation
+      #
+      # @param buffer [::FFI::Pointer, #to_ptr]
+      # @param length [Integer, #to_int, #to_i]
+      # @return [void]
+      def update(buffer, length)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        length = Integer(length)
+        result = ::CZMQ::FFI.zdigest_update(self_p, buffer, length)
+        result
+      end
+
+      # Return final digest hash data. If built without crypto support, returns
+      # NULL.                                                                  
+      #
+      # @return [::FFI::Pointer]
+      def data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdigest_data(self_p)
+        result
+      end
+
+      # Return final digest hash size
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdigest_size(self_p)
+        result
+      end
+
+      # Return digest as printable hex string; caller should not modify nor   
+      # free this string. After calling this, you may not use zdigest_update()
+      # on the same digest. If built without crypto support, returns NULL.    
+      #
+      # @return [::FFI::Pointer]
+      def string()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdigest_string(self_p)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zdigest_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

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

@@ -90,7 +90,7 @@ module CZMQ
       end
 
       # Create a new callback of the following type:
-      # DEPRECATED as clumsy -- use zhash_first/_next instead
+      # Callback function for zhash_foreach method. Deprecated.
       #     typedef int (zhash_foreach_fn) (                 
       #         const char *key, void *item, void *argument);
       #
@@ -383,11 +383,9 @@ module CZMQ
         result
       end
 
-      # DEPRECATED as clumsy -- use zhash_first/_next instead                  
       # Apply function to each item in the hash table. Items are iterated in no
       # defined order. Stops if callback function returns non-zero and returns 
-      # final return code from callback function (zero = success).             
-      # Callback function for zhash_foreach method                             
+      # final return code from callback function (zero = success). Deprecated. 
       #
       # @param callback [::FFI::Pointer, #to_ptr]
       # @param argument [::FFI::Pointer, #to_ptr]

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

@@ -308,11 +308,12 @@ module CZMQ
       # table. Uses the key_duplicator to duplicate all keys and sets the
       # key_destructor as destructor for the list.                       
       #
-      # @return [::FFI::Pointer]
+      # @return [Zlistx]
       def keys()
         raise DestroyedError unless @ptr
         self_p = @ptr
         result = ::CZMQ::FFI.zhashx_keys(self_p)
+        result = Zlistx.__new result, true
         result
       end
 
@@ -320,11 +321,12 @@ module CZMQ
       # table. Uses the duplicator to duplicate all items and sets the
       # destructor as destructor for the list.                        
       #
-      # @return [::FFI::Pointer]
+      # @return [Zlistx]
       def values()
         raise DestroyedError unless @ptr
         self_p = @ptr
         result = ::CZMQ::FFI.zhashx_values(self_p)
+        result = Zlistx.__new result, true
         result
       end