czmq-ffi-gen 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 119e644dab9cbe66ebf0d0064d2e8b9d06ff40ab
-  data.tar.gz: f74423436c46aa8bcbcf1fd3025d8511e2d3906b
+  metadata.gz: 9ddc4ee13a1ddc22fe67e85944c03518113c53bf
+  data.tar.gz: 97c237e933b61b8777a028ec104ce2afc3703c17
 SHA512:
-  metadata.gz: da31baf796d2cda0b860db2534308e91953c513540df8ad55c24df04eb2e7f55547b074fc7be147d7b9d93e0552bc267fa3d25eeefa45ab13fd097fa6b8b71c9
-  data.tar.gz: c4f0f6ace9dc9f45c4d4dfdeb8ffd4deb9714b33ab68bb741ab22775b0e4cdc3a517a3adb33035a4e50b0f3b11a9ea7d1b35b3e623633785b6bfb64cc4e44fd7
+  metadata.gz: 5caa19323558d2a38336802bae75cb1ed64de047f288d20531079a77fdb555a642115e6e864329c4315b6def1bcde496f56ed153c608965de2c6c7c4ad9ee7bc
+  data.tar.gz: d8dd4d88b96b568a0ddfbd0f47b7462b346bea823c003f0d402f0f134598ce57257cf4c1f3517803d2b0392a6a0830a99432a7330d62c7438b6fd403a58fb7f8

data/CHANGES.md

@@ -1,3 +1,12 @@
+0.5.0 (01/14/2016)
+-----
+* add CZMQ::FFI::Errors
+  - hand-written code to interact with libzmq
+  - .errno returns error code of last (ZMQ) error
+  - .strerror returns string representation of last (ZMQ) error
+* upgrade CZMQ low-level binding to
+  - add Zchunk
+
 0.4.1 (01/06/2016)
 -----
 * upgrade CZMQ low-level binding to

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

@@ -0,0 +1,388 @@
+################################################################################
+#  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
+
+    # 
+    # @note This class is 100% generated using zproject.
+    class Zchunk
+      # Raised when one tries to use an instance of {Zchunk} 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.zchunk_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 chunk of the specified size. If you specify the data, it   
+      # is copied into the chunk. If you do not specify the data, the chunk is  
+      # allocated and left empty, and you can then add data using zchunk_append.
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [CZMQ::Zchunk]
+      def self.new(data, size)
+        size = Integer(size)
+        ptr = ::CZMQ::FFI.zchunk_new(data, size)
+        __new ptr
+      end
+
+      # Destroy a chunk
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zchunk_destroy(self_p)
+        result
+      end
+
+      # Resizes chunk max_size as requested; chunk_cur size is set to zero
+      #
+      # @param size [Integer, #to_int, #to_i]
+      # @return [void]
+      def resize(size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zchunk_resize(self_p, size)
+        result
+      end
+
+      # Return chunk cur size
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_size(self_p)
+        result
+      end
+
+      # Return chunk max size
+      #
+      # @return [Integer]
+      def max_size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_max_size(self_p)
+        result
+      end
+
+      # Return chunk data
+      #
+      # @return [::FFI::Pointer]
+      def data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_data(self_p)
+        result
+      end
+
+      # Set chunk data from user-supplied data; truncate if too large. Data may
+      # be null. Returns actual size of chunk                                  
+      #
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def set(data, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zchunk_set(self_p, data, size)
+        result
+      end
+
+      # Fill chunk data from user-supplied octet
+      #
+      # @param filler [Integer, #to_int, #to_i]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def fill(filler, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        filler = Integer(filler)
+        size = Integer(size)
+        result = ::CZMQ::FFI.zchunk_fill(self_p, filler, size)
+        result
+      end
+
+      # Append user-supplied data to chunk, return resulting chunk size. If the 
+      # data would exceeded the available space, it is truncated. If you want to
+      # grow the chunk to accommodate new data, use the zchunk_extend method.   
+      #
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def append(data, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zchunk_append(self_p, data, size)
+        result
+      end
+
+      # Append user-supplied data to chunk, return resulting chunk size. If the
+      # data would exceeded the available space, the chunk grows in size.      
+      #
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def extend(data, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zchunk_extend(self_p, data, size)
+        result
+      end
+
+      # Copy as much data from 'source' into the chunk as possible; returns the  
+      # new size of chunk. If all data from 'source' is used, returns exhausted  
+      # on the source chunk. Source can be consumed as many times as needed until
+      # it is exhausted. If source was already exhausted, does not change chunk. 
+      #
+      # @param source [Zchunk, #__ptr]
+      # @return [Integer]
+      def consume(source)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        source = source.__ptr if source
+        result = ::CZMQ::FFI.zchunk_consume(self_p, source)
+        result
+      end
+
+      # Returns true if the chunk was exhausted by consume methods, or if the
+      # chunk has a size of zero.                                            
+      #
+      # @return [Boolean]
+      def exhausted()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_exhausted(self_p)
+        result
+      end
+
+      # Read chunk from an open file descriptor
+      #
+      # @param handle [::FFI::Pointer, #to_ptr]
+      # @param bytes [Integer, #to_int, #to_i]
+      # @return [Zchunk]
+      def self.read(handle, bytes)
+        bytes = Integer(bytes)
+        result = ::CZMQ::FFI.zchunk_read(handle, bytes)
+        result = Zchunk.__new result, true
+        result
+      end
+
+      # Write chunk to an open file descriptor
+      #
+      # @param handle [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def write(handle)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_write(self_p, handle)
+        result
+      end
+
+      # Try to slurp an entire file into a chunk. Will read up to maxsize of  
+      # the file. If maxsize is 0, will attempt to read the entire file and   
+      # fail with an assertion if that cannot fit into memory. Returns a new  
+      # chunk containing the file data, or NULL if the file could not be read.
+      #
+      # @param filename [String, #to_s, nil]
+      # @param maxsize [Integer, #to_int, #to_i]
+      # @return [Zchunk]
+      def self.slurp(filename, maxsize)
+        maxsize = Integer(maxsize)
+        result = ::CZMQ::FFI.zchunk_slurp(filename, maxsize)
+        result = Zchunk.__new result, true
+        result
+      end
+
+      # Create copy of chunk, as new chunk object. Returns a fresh zchunk_t   
+      # object, or null if there was not enough heap memory. If chunk is null,
+      # returns null.                                                         
+      #
+      # @return [Zchunk]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_dup(self_p)
+        result = Zchunk.__new result, true
+        result
+      end
+
+      # Return chunk data encoded as printable hex string. Caller must free
+      # string when finished with it.                                      
+      #
+      # @return [::FFI::AutoPointer]
+      def strhex()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_strhex(self_p)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Return chunk data copied into freshly allocated string
+      # Caller must free string when finished with it.        
+      #
+      # @return [::FFI::AutoPointer]
+      def strdup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_strdup(self_p)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Return TRUE if chunk body is equal to string, excluding terminator
+      #
+      # @param string [String, #to_s, nil]
+      # @return [Boolean]
+      def streq(string)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_streq(self_p, string)
+        result
+      end
+
+      # Transform zchunk into a zframe that can be sent in a message.
+      #
+      # @return [Zframe]
+      def pack()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_pack(self_p)
+        result = Zframe.__new result, true
+        result
+      end
+
+      # Transform a zframe into a zchunk.
+      #
+      # @param frame [Zframe, #__ptr]
+      # @return [Zchunk]
+      def self.unpack(frame)
+        frame = frame.__ptr if frame
+        result = ::CZMQ::FFI.zchunk_unpack(frame)
+        result = Zchunk.__new result, true
+        result
+      end
+
+      # Calculate SHA1 digest for chunk, using zdigest class.
+      #
+      # @return [String]
+      def digest()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_digest(self_p)
+        result
+      end
+
+      # Dump chunk to FILE stream, for debugging and tracing.
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def fprint(file)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_fprint(self_p, file)
+        result
+      end
+
+      # Dump message to stderr, for debugging and tracing.
+      # See zchunk_fprint for details                     
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zchunk_print(self_p)
+        result
+      end
+
+      # Probe the supplied object, and report if it looks like a zchunk_t.
+      #
+      # @param self_ [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def self.is(self_)
+        result = ::CZMQ::FFI.zchunk_is(self_)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zchunk_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/zconfig.rb

@@ -350,9 +350,10 @@ module CZMQ
 
       # Load a config tree from a memory chunk
       #
-      # @param chunk [::FFI::Pointer, #to_ptr]
+      # @param chunk [Zchunk, #__ptr]
       # @return [Zconfig]
       def self.chunk_load(chunk)
+        chunk = chunk.__ptr if chunk
         result = ::CZMQ::FFI.zconfig_chunk_load(chunk)
         result = Zconfig.__new result, false
         result
@@ -360,11 +361,12 @@ module CZMQ
 
       # Save a config tree to a new memory chunk
       #
-      # @return [::FFI::Pointer]
+      # @return [Zchunk]
       def chunk_save()
         raise DestroyedError unless @ptr
         self_p = @ptr
         result = ::CZMQ::FFI.zconfig_chunk_save(self_p)
+        result = Zchunk.__new result, false
         result
       end
 

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

@@ -259,12 +259,13 @@ module CZMQ
       #
       # @param bytes [Integer, #to_int, #to_i]
       # @param offset [::FFI::Pointer, #to_ptr]
-      # @return [::FFI::Pointer]
+      # @return [Zchunk]
       def read(bytes, offset)
         raise DestroyedError unless @ptr
         self_p = @ptr
         bytes = Integer(bytes)
         result = ::CZMQ::FFI.zfile_read(self_p, bytes, offset)
+        result = Zchunk.__new result, true
         result
       end
 
@@ -281,12 +282,13 @@ module CZMQ
       # Write chunk to file at specified position
       # Return 0 if OK, else -1                  
       #
-      # @param chunk [::FFI::Pointer, #to_ptr]
+      # @param chunk [Zchunk, #__ptr]
       # @param offset [::FFI::Pointer, #to_ptr]
       # @return [Integer]
       def write(chunk, offset)
         raise DestroyedError unless @ptr
         self_p = @ptr
+        chunk = chunk.__ptr if chunk
         result = ::CZMQ::FFI.zfile_write(self_p, chunk, offset)
         result
       end

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

@@ -112,6 +112,35 @@ module CZMQ
 
       require_relative 'ffi/zcertstore'
 
+      attach_function :zchunk_new, [:pointer, :size_t], :pointer, **opts
+      attach_function :zchunk_destroy, [:pointer], :void, **opts
+      attach_function :zchunk_resize, [:pointer, :size_t], :void, **opts
+      attach_function :zchunk_size, [:pointer], :size_t, **opts
+      attach_function :zchunk_max_size, [:pointer], :size_t, **opts
+      attach_function :zchunk_data, [:pointer], :pointer, **opts
+      attach_function :zchunk_set, [:pointer, :pointer, :size_t], :size_t, **opts
+      attach_function :zchunk_fill, [:pointer, :char, :size_t], :size_t, **opts
+      attach_function :zchunk_append, [:pointer, :pointer, :size_t], :size_t, **opts
+      attach_function :zchunk_extend, [:pointer, :pointer, :size_t], :size_t, **opts
+      attach_function :zchunk_consume, [:pointer, :pointer], :size_t, **opts
+      attach_function :zchunk_exhausted, [:pointer], :bool, **opts
+      attach_function :zchunk_read, [:pointer, :size_t], :pointer, **opts
+      attach_function :zchunk_write, [:pointer, :pointer], :int, **opts
+      attach_function :zchunk_slurp, [:string, :size_t], :pointer, **opts
+      attach_function :zchunk_dup, [:pointer], :pointer, **opts
+      attach_function :zchunk_strhex, [:pointer], :pointer, **opts
+      attach_function :zchunk_strdup, [:pointer], :pointer, **opts
+      attach_function :zchunk_streq, [:pointer, :string], :bool, **opts
+      attach_function :zchunk_pack, [:pointer], :pointer, **opts
+      attach_function :zchunk_unpack, [:pointer], :pointer, **opts
+      attach_function :zchunk_digest, [:pointer], :string, **opts
+      attach_function :zchunk_fprint, [:pointer, :pointer], :void, **opts
+      attach_function :zchunk_print, [:pointer], :void, **opts
+      attach_function :zchunk_is, [:pointer], :bool, **opts
+      attach_function :zchunk_test, [:bool], :void, **opts
+
+      require_relative 'ffi/zchunk'
+
       attach_function :zconfig_new, [:string, :pointer], :pointer, **opts
       attach_function :zconfig_load, [:string], :pointer, **opts
       attach_function :zconfig_loadf, [:string, :varargs], :pointer, **opts

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

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

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

@@ -1,5 +1,5 @@
 module CZMQ
   module FFI
-    GEM_VERSION = "0.4.1"
+    GEM_VERSION = "0.5.0"
   end
 end

data/lib/czmq-ffi-gen.rb

@@ -1,5 +1,6 @@
 require_relative "czmq-ffi-gen/czmq/ffi"
 require_relative "czmq-ffi-gen/gem_version"
 require_relative "czmq-ffi-gen/library_version"
+require_relative "czmq-ffi-gen/errors"
 require_relative "czmq-ffi-gen/signals"
 CZMQ::FFI.available? or raise LoadError, "libczmq is not available"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czmq-ffi-gen
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -99,6 +99,7 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/zarmour.rb
 - lib/czmq-ffi-gen/czmq/ffi/zcert.rb
 - lib/czmq-ffi-gen/czmq/ffi/zcertstore.rb
+- lib/czmq-ffi-gen/czmq/ffi/zchunk.rb
 - lib/czmq-ffi-gen/czmq/ffi/zconfig.rb
 - lib/czmq-ffi-gen/czmq/ffi/zdir.rb
 - lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb
@@ -116,6 +117,7 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/zstr.rb
 - lib/czmq-ffi-gen/czmq/ffi/ztrie.rb
 - lib/czmq-ffi-gen/czmq/ffi/zuuid.rb
+- lib/czmq-ffi-gen/errors.rb
 - lib/czmq-ffi-gen/gem_version.rb
 - lib/czmq-ffi-gen/library_version.rb
 - lib/czmq-ffi-gen/signals.rb