czmq-ffi-gen 0.16.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01af8ea49e46213bfd113905ae0c0e82591f090784045b7f803ec0de70273e29
-  data.tar.gz: ce938a832189bcdf6d971542d71ea64482d62dd28b8c61258d3315c22a94a92c
+  metadata.gz: 54df901872241cd24a89cf112ef7c5ad4d70add201cdb0530711e3164f59b7a1
+  data.tar.gz: 160874a60cb895fd1e958a3859cb72c945b2702fbe0a5a48c49f22effba3643d
 SHA512:
-  metadata.gz: 0f269c4fe0979fa544f3749808ec732841294e8452efba9ebb9ea950ffbe06d73b9636f7a83adec8c767e89d403d8f1011186b185dd03bd4932000b567c4b131
-  data.tar.gz: ad42c6a169ff472aa570cd3322763328e70283fffacd8c76a0f8021e9cdfd5a89c327cd7aba4bfec2a37f161b1e5c2f31d9411e54bb599d3abe1f3078b0b99d1
+  metadata.gz: e351142eac434718b4c43ab75254265858507aebfef8a26b306c0d25c40c20bb622b927806ff206c8d7071a86425b4b97c852a8493ef48589a5c2d1d3b2db687
+  data.tar.gz: cd5ef8113db2134e84a4d36ecb5c99ecf81aef397b354db2786a63c5659a35c2a5767ceb110ffc83da6e75ea647dd1fecd09678c619132829b3ff17d940a20bd

data/README.md

@@ -1,4 +1,4 @@
-[![pipeline status](https://gitlab.com/paddor/czmq-ffi-gen/badges/master/pipeline.svg)](https://gitlab.com/paddor/czmq-ffi-gen/commits/master)
+![Specs status](https://github.com/paddor/czmq-ffi-gen/workflows/Specs/badge.svg)
 
 # Generated CZMQ::FFI
 
@@ -42,27 +42,13 @@ for the API documentation **for the released gem**.
 
 ## Requirements
 
-* CZMQ >= 4.1
-* ZMQ >= 4.2
+* CZMQ >= 4.2
+* ZMQ >= 4.3
 
-For security mechanisms like CURVE, you can use an external library:
-* [libsodium](https://github.com/jedisct1/libsodium)
-
-On macOS using homebrew, run:
+On macOS using Homebrew, run:
 
     $ brew install czmq
 
-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.
-
-### Supported Rubies
-
-The latest MRI (currently the 2.6 series) is tested on CI.
-
-The following *SHOULD* work, but are untested:
-* Rubinius
-* JRuby 9000
-
 
 ## Installation
 

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

@@ -135,6 +135,7 @@ module CZMQ
       attach_function :zcertstore_empty, [:pointer], :void, **opts
       attach_function :zcertstore_print, [:pointer], :void, **opts
       attach_function :zcertstore_certs, [:pointer], :pointer, **opts
+      attach_function :zcertstore_state, [:pointer], :pointer, **opts
       attach_function :zcertstore_test, [:bool], :void, **opts
 
       require_relative 'ffi/zcertstore'
@@ -307,6 +308,7 @@ module CZMQ
       attach_function :zframe_eq, [:pointer, :pointer], :bool, **opts
       attach_function :zframe_reset, [:pointer, :pointer, :size_t], :void, **opts
       attach_function :zframe_print, [:pointer, :string], :void, **opts
+      attach_function :zframe_print_n, [:pointer, :string, :size_t], :void, **opts
       attach_function :zframe_is, [:pointer], :bool, **opts
       attach_function :zframe_test, [:bool], :void, **opts
 
@@ -501,6 +503,7 @@ module CZMQ
       attach_function :zmsg_encode, [:pointer], :pointer, **opts
       attach_function :zmsg_dup, [:pointer], :pointer, **opts
       attach_function :zmsg_print, [:pointer], :void, **opts
+      attach_function :zmsg_print_n, [:pointer, :size_t], :void, **opts
       attach_function :zmsg_eq, [:pointer, :pointer], :bool, **opts
       attach_function :zmsg_signal, [:pointer], :int, **opts
       attach_function :zmsg_is, [:pointer], :bool, **opts
@@ -564,6 +567,7 @@ module CZMQ
       attach_function :zsock_new_dish, [:string], :pointer, **opts
       attach_function :zsock_new_gather, [:string], :pointer, **opts
       attach_function :zsock_new_scatter, [:string], :pointer, **opts
+      attach_function :zsock_new_dgram, [:string], :pointer, **opts
       attach_function :zsock_destroy, [:pointer], :void, **opts
       attach_function :zsock_bind, [:pointer, :string, :varargs], :int, **opts
       attach_function :zsock_endpoint, [:pointer], :string, **opts
@@ -589,6 +593,23 @@ module CZMQ
       attach_function :zsock_is, [:pointer], :bool, **opts
       attach_function :zsock_resolve, [:pointer], :pointer, **opts
       attach_function :zsock_has_in, [:pointer], :bool, **opts
+      attach_function :zsock_set_only_first_subscribe, [:pointer, :int], :void, **opts
+      attach_function :zsock_set_hello_msg, [:pointer, :pointer], :void, **opts
+      attach_function :zsock_set_disconnect_msg, [:pointer, :pointer], :void, **opts
+      attach_function :zsock_set_wss_trust_system, [:pointer, :int], :void, **opts
+      attach_function :zsock_set_wss_hostname, [:pointer, :string], :void, **opts
+      attach_function :zsock_set_wss_trust_pem, [:pointer, :string], :void, **opts
+      attach_function :zsock_set_wss_cert_pem, [:pointer, :string], :void, **opts
+      attach_function :zsock_set_wss_key_pem, [:pointer, :string], :void, **opts
+      attach_function :zsock_out_batch_size, [:pointer], :int, **opts
+      attach_function :zsock_set_out_batch_size, [:pointer, :int], :void, **opts
+      attach_function :zsock_in_batch_size, [:pointer], :int, **opts
+      attach_function :zsock_set_in_batch_size, [:pointer, :int], :void, **opts
+      attach_function :zsock_socks_password, [:pointer], :pointer, **opts
+      attach_function :zsock_set_socks_password, [:pointer, :string], :void, **opts
+      attach_function :zsock_socks_username, [:pointer], :pointer, **opts
+      attach_function :zsock_set_socks_username, [:pointer, :string], :void, **opts
+      attach_function :zsock_set_xpub_manual_last_value, [:pointer, :int], :void, **opts
       attach_function :zsock_router_notify, [:pointer], :int, **opts
       attach_function :zsock_set_router_notify, [:pointer, :int], :void, **opts
       attach_function :zsock_multicast_loop, [:pointer], :int, **opts
@@ -819,12 +840,17 @@ module CZMQ
       attach_function :zsys_pipehwm, [], :size_t, **opts
       attach_function :zsys_set_ipv6, [:int], :void, **opts
       attach_function :zsys_ipv6, [], :int, **opts
+      attach_function :zsys_ipv6_available, [], :bool, **opts
       attach_function :zsys_set_interface, [:string], :void, **opts
       attach_function :zsys_interface, [], :string, **opts
       attach_function :zsys_set_ipv6_address, [:string], :void, **opts
       attach_function :zsys_ipv6_address, [], :string, **opts
       attach_function :zsys_set_ipv6_mcast_address, [:string], :void, **opts
       attach_function :zsys_ipv6_mcast_address, [], :string, **opts
+      attach_function :zsys_set_ipv4_mcast_address, [:string], :void, **opts
+      attach_function :zsys_ipv4_mcast_address, [], :string, **opts
+      attach_function :zsys_set_mcast_ttl, [:char], :void, **opts
+      attach_function :zsys_mcast_ttl, [], :char, **opts
       attach_function :zsys_set_auto_use_fd, [:int], :void, **opts
       attach_function :zsys_auto_use_fd, [], :int, **opts
       attach_function :zsys_zprintf, [:string, :pointer], :pointer, **opts
@@ -951,6 +977,38 @@ module CZMQ
       attach_function :zhttp_response_test, [:bool], :void, **opts
 
       require_relative 'ffi/zhttp_response'
+
+      attach_function :zosc_new, [:string], :pointer, **opts
+      attach_function :zosc_fromframe, [:pointer], :pointer, **opts
+      attach_function :zosc_frommem, [:pointer, :size_t], :pointer, **opts
+      attach_function :zosc_create, [:string, :string, :varargs], :pointer, **opts
+      attach_function :zosc_destroy, [:pointer], :void, **opts
+      attach_function :zosc_size, [:pointer], :size_t, **opts
+      attach_function :zosc_data, [:pointer], :pointer, **opts
+      attach_function :zosc_address, [:pointer], :string, **opts
+      attach_function :zosc_format, [:pointer], :string, **opts
+      attach_function :zosc_append, [:pointer, :string, :varargs], :int, **opts
+      attach_function :zosc_retr, [:pointer, :string, :varargs], :int, **opts
+      attach_function :zosc_dup, [:pointer], :pointer, **opts
+      attach_function :zosc_pack, [:pointer], :pointer, **opts
+      attach_function :zosc_packx, [:pointer], :pointer, **opts
+      attach_function :zosc_unpack, [:pointer], :pointer, **opts
+      attach_function :zosc_print, [:pointer], :void, **opts
+      attach_function :zosc_is, [:pointer], :bool, **opts
+      attach_function :zosc_first, [:pointer, :pointer], :pointer, **opts
+      attach_function :zosc_next, [:pointer, :pointer], :pointer, **opts
+      attach_function :zosc_last, [:pointer, :pointer], :pointer, **opts
+      attach_function :zosc_pop_int32, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_int64, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_float, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_double, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_string, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_char, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_bool, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_pop_midi, [:pointer, :pointer], :int, **opts
+      attach_function :zosc_test, [:bool], :void, **opts
+
+      require_relative 'ffi/zosc'
     end
   end
 end

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

@@ -205,6 +205,16 @@ module CZMQ
         result
       end
 
+      # Return the state stored in certstore
+      #
+      # @return [::FFI::Pointer]
+      def state()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcertstore_state(self_p)
+        result
+      end
+
       # Self test of this class
       #
       # @param verbose [Boolean]

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

@@ -351,6 +351,7 @@ module CZMQ
 
       # Send message to zsys log sink (may be stdout, or system facility as
       # configured by zsys_set_logstream). Prefix shows before frame, if not null.
+      # Long messages are truncated.
       #
       # @param prefix [String, #to_s, nil]
       # @return [void]
@@ -361,6 +362,22 @@ module CZMQ
         result
       end
 
+      # Send message to zsys log sink (may be stdout, or system facility as
+      # configured by zsys_set_logstream). Prefix shows before frame, if not null.
+      # Message length is specified; no truncation unless length is zero.
+      # Backwards compatible with zframe_print when length is zero.
+      #
+      # @param prefix [String, #to_s, nil]
+      # @param length [Integer, #to_int, #to_i]
+      # @return [void]
+      def print_n(prefix, length)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        length = Integer(length)
+        result = ::CZMQ::FFI.zframe_print_n(self_p, prefix, length)
+        result
+      end
+
       # Probe the supplied object, and report if it looks like a zframe_t.
       #
       # @param self_ [::FFI::Pointer, #to_ptr]

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

@@ -454,6 +454,7 @@ module CZMQ
 
       # Send message to zsys log sink (may be stdout, or system facility as
       # configured by zsys_set_logstream).
+      # Long messages are truncated.
       #
       # @return [void]
       def print()
@@ -463,6 +464,21 @@ module CZMQ
         result
       end
 
+      # Send message to zsys log sink (may be stdout, or system facility as
+      # configured by zsys_set_logstream).
+      # Message length is specified; no truncation unless length is zero.
+      # Backwards compatible with zframe_print when length is zero.
+      #
+      # @param size [Integer, #to_int, #to_i]
+      # @return [void]
+      def print_n(size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zmsg_print_n(self_p, size)
+        result
+      end
+
       # Return true if the two messages have the same number of frames and each
       # frame in the first message is identical to the corresponding frame in the
       # other message. As with zframe_eq, return false if either message is NULL.

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

@@ -0,0 +1,487 @@
+################################################################################
+#  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
+
+    # Create and decode Open Sound Control messages. (OSC)
+    #
+    # OSC is a serialisation format (and usually transported over UDP) which is
+    # supported by many applications and appliances. It is a de facto protocol
+    # for networking sound synthesizers, computers, and other multimedia devices
+    # for purposes such as musical performance or show control. It is also often
+    # used for rapid prototyping purposes due to the support by many applications
+    # and frameworks in this field. With ZeroMQ's DGRAM sockets it is possible
+    # to use ZeroMQ to send and receive OSC messages which can be understood by
+    # any device supporting OSC.
+    #
+    # Example creating an OSC message:
+    #
+    #     zosc_t* conm = zosc_create("/someaddress", "iihfdscF",
+    #                         1, 2, 3, 3.14, 6.283185307179586, "greetings", 'q');
+    #
+    # Decoding a message:
+    #
+    #     int rc = zosc_retr(oscmsg, "iihfdscF", &intx, &inty, &intz, &floatz,
+    #                         &doublez, &strings, &charq, &someBool);
+    #
+    # See the class's test method for more examples how to use the class.
+    # @note This class is 100% generated using zproject.
+    class Zosc
+      # Raised when one tries to use an instance of {Zosc} 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.zosc_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 empty OSC message with the specified address string.
+      # @param address [String, #to_s, nil]
+      # @return [CZMQ::Zosc]
+      def self.new(address)
+        ptr = ::CZMQ::FFI.zosc_new(address)
+        __new ptr
+      end
+
+      # Create a new OSC message from the specified zframe. Takes ownership of
+      # the zframe.
+      # @param frame [Zframe, #__ptr]
+      # @return [CZMQ::Zosc]
+      def self.fromframe(frame)
+        frame = frame.__ptr if frame
+        ptr = ::CZMQ::FFI.zosc_fromframe(frame)
+        __new ptr
+      end
+
+      # Create a new zosc message from memory. Take ownership of the memory
+      # and calling free on the data after construction.
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [CZMQ::Zosc]
+      def self.frommem(data, size)
+        size = Integer(size)
+        ptr = ::CZMQ::FFI.zosc_frommem(data, size)
+        __new ptr
+      end
+
+      # Create a new zosc message from the given format and arguments.
+      # The format type tags are as follows:
+      #   i - 32bit integer
+      #   h - 64bit integer
+      #   f - 32bit floating point number (IEEE)
+      #   d - 64bit (double) floating point number
+      #   s - string (NULL terminated)
+      #   t = timetag: an OSC timetag in NTP format (uint64_t)
+      #   S - symbol
+      #   c - char
+      #   m - 4 byte midi packet (8 digits hexadecimal)
+      #   T - TRUE (no value required)
+      #   F - FALSE (no value required)
+      #   N - NIL (no value required)
+      #   I - Impulse (for triggers) or INFINITUM (no value required)
+      #   b - binary blob
+      # @param address [String, #to_s, nil]
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>]
+      # @return [CZMQ::Zosc]
+      def self.create(address, format, *args)
+        ptr = ::CZMQ::FFI.zosc_create(address, format, *args)
+        __new ptr
+      end
+
+      # Destroy an OSC message
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zosc_destroy(self_p)
+        result
+      end
+
+      # Return chunk data size
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_size(self_p)
+        result
+      end
+
+      # Return OSC chunk data. Caller does not own the data!
+      #
+      # @return [::FFI::Pointer]
+      def data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_data(self_p)
+        result
+      end
+
+      # Return the OSC address string
+      #
+      # @return [String]
+      def address()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_address(self_p)
+        result
+      end
+
+      # Return the OSC format of the message.
+      #   i - 32bit integer
+      #   h - 64bit integer
+      #   f - 32bit floating point number (IEEE)
+      #   d - 64bit (double) floating point number
+      #   s - string (NULL terminated)
+      #   t = timetag: an OSC timetag in NTP format (uint64_t)
+      #   S - symbol
+      #   c - char
+      #   m - 4 byte midi packet (8 digits hexadecimal)
+      #   T - TRUE (no value required)
+      #   F - FALSE (no value required)
+      #   N - NIL (no value required)
+      #   I - Impulse (for triggers) or INFINITUM (no value required)
+      #   b - binary blob
+      #
+      # @return [String]
+      def format()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_format(self_p)
+        result
+      end
+
+      # Append data to the osc message. The format describes the data that
+      # needs to be appended in the message. This essentially relocates all
+      # data!
+      # The format type tags are as follows:
+      #   i - 32bit integer
+      #   h - 64bit integer
+      #   f - 32bit floating point number (IEEE)
+      #   d - 64bit (double) floating point number
+      #   s - string (NULL terminated)
+      #   t = timetag: an OSC timetag in NTP format (uint64_t)
+      #   S - symbol
+      #   c - char
+      #   m - 4 byte midi packet (8 digits hexadecimal)
+      #   T - TRUE (no value required)
+      #   F - FALSE (no value required)
+      #   N - NIL (no value required)
+      #   I - Impulse (for triggers) or INFINITUM (no value required)
+      #   b - binary blob
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def append(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_append(self_p, format, *args)
+        result
+      end
+
+      # Retrieve the values provided by the given format. Note that zosc_retr
+      # creates the objects and the caller must destroy them when finished.
+      # The supplied pointers do not need to be initialized. Returns 0 if
+      # successful, or -1 if it failed to retrieve a value in which case the
+      # pointers are not modified. If an argument pointer is NULL is skips the
+      # value. See the format method for a detailed list op type tags for the
+      # format string.
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def retr(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_retr(self_p, format, *args)
+        result
+      end
+
+      # Create copy of the message, as new chunk object. Returns a fresh zosc_t
+      # object, or null if there was not enough heap memory. If chunk is null,
+      # returns null.
+      #
+      # @return [Zosc]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_dup(self_p)
+        result = Zosc.__new result, true
+        result
+      end
+
+      # Transform zosc into a zframe that can be sent in a message.
+      #
+      # @return [Zframe]
+      def pack()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pack(self_p)
+        result = Zframe.__new result, true
+        result
+      end
+
+      # Transform zosc into a zframe that can be sent in a message.
+      # Take ownership of the chunk.
+      #
+      # @param self_p [#__ptr_give_ref]
+      # @return [Zframe]
+      def self.packx(self_p)
+        self_p = self_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zosc_packx(self_p)
+        result = Zframe.__new result, true
+        result
+      end
+
+      # Transform a zframe into a zosc.
+      #
+      # @param frame [Zframe, #__ptr]
+      # @return [Zosc]
+      def self.unpack(frame)
+        frame = frame.__ptr if frame
+        result = ::CZMQ::FFI.zosc_unpack(frame)
+        result = Zosc.__new result, true
+        result
+      end
+
+      # Dump OSC message to stdout, for debugging and tracing.
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_print(self_p)
+        result
+      end
+
+      # Probe the supplied object, and report if it looks like a zosc_t.
+      #
+      # @param self_ [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def self.is(self_)
+        result = ::CZMQ::FFI.zosc_is(self_)
+        result
+      end
+
+      # Return a pointer to the item at the head of the OSC data.
+      # Sets the given char argument to the type tag of the data.
+      # If the message is empty, returns NULL and the sets the
+      # given char to NULL.
+      #
+      # @param type [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::Pointer]
+      def first(type)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_first(self_p, type)
+        result
+      end
+
+      # Return the next item of the OSC message. If the list is empty, returns
+      # NULL. To move to the start of the OSC message call zosc_first ().
+      #
+      # @param type [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::Pointer]
+      def next(type)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_next(self_p, type)
+        result
+      end
+
+      # Return a pointer to the item at the tail of the OSC message.
+      # Sets the given char argument to the type tag of the data. If
+      # the message is empty, returns NULL.
+      #
+      # @param type [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::Pointer]
+      def last(type)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_last(self_p, type)
+        result
+      end
+
+      # Set the provided 32 bit integer from value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_int32(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_int32(self_p, val)
+        result
+      end
+
+      # Set the provided 64 bit integer from the value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_int64(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_int64(self_p, val)
+        result
+      end
+
+      # Set the provided float from the value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_float(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_float(self_p, val)
+        result
+      end
+
+      # Set the provided double from the value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_double(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_double(self_p, val)
+        result
+      end
+
+      # Set the provided string from the value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success. Caller owns the string!
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_string(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_string(self_p, val)
+        result
+      end
+
+      # Set the provided char from the value at the current cursor position in the message.
+      # If the type tag at the current position does not correspond it will fail and
+      # return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_char(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_char(self_p, val)
+        result
+      end
+
+      # Set the provided boolean from the type tag in the message. Booleans are not represented
+      # in the data in the message, only in the type tag. If the type tag at the current
+      # position does not correspond it will fail and return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_bool(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_bool(self_p, val)
+        result
+      end
+
+      # Set the provided 4 bytes (unsigned 32bit int) from the value at the current
+      # cursor position in the message. If the type tag at the current position does
+      # not correspond it will fail and return -1. Returns 0 on success.
+      #
+      # @param val [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def pop_midi(val)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zosc_pop_midi(self_p, val)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zosc_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. #
+################################################################################