laag-libczmq 4.1.0.0

data/vendor/github.com/zeromq/czmq/bindings/python_cffi/README.md

@@ -0,0 +1,28 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+#czmq cffi bindings
+
+This package contains low level python bindings for czmq based on cffi library.
+Module is compatible with
+ * The “in-line”, “ABI mode”, which simply **dlopen** main library and parse C declaration on runtime
+ * The “out-of-line”, “API mode”, which build C **native** Python extension
+
+#Build the native extension
+
+    python setup.py build
+
+Note you need to have setuptools and cffi packages installed. As well as a checkout of all dependencies
+at the same level as this project, because all dependant defs.py will be included in project cdefs.py.
+
+#Using more cffi modules together
+While zproject and CLASS encourages you to split your dependencies to smaller libraries, this does
+not work well for cffi. zproject generated backends have own private cffi instance, which can't
+be easily combined with others in one function call.
+
+See ML thread about topic https://groups.google.com/forum/#!topic/python-cffi/JtAKU-g9Exg
+
+This is the reason the Lib and CompiledFFi objects are referenced from utils module and dynamically
+accessed on each call. Calling `lower.utils.rebind (higher.utils.lib, higher.utils.ffi)' you can
+change instance used by lower module and enforce all Python classes will use single instance.

data/vendor/github.com/zeromq/czmq/bindings/python_cffi/czmq_cffi/Zactor.py

@@ -0,0 +1,78 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+import utils
+from . import destructors
+libczmq_destructors = destructors.lib
+
+class Zactor(object):
+    """
+    provides a simple actor framework
+    """
+
+    def __init__(self, task, args):
+        """
+        Create a new actor passing arbitrary arguments reference.
+        """
+        p = utils.lib.zactor_new(task, args._p)
+        if p == utils.ffi.NULL:
+            raise MemoryError("Could not allocate person")
+
+        # ffi.gc returns a copy of the cdata object which will have the
+        # destructor called when the Python object is GC'd:
+        # https://cffi.readthedocs.org/en/latest/using.html#ffi-interface
+        self._p = utils.ffi.gc(p, libczmq_destructors.zactor_destroy_py)
+
+    def send(self, msg_p):
+        """
+        Send a zmsg message to the actor, take ownership of the message
+        and destroy when it has been sent.
+        """
+        return utils.lib.zactor_send(self._p, msg_p._p)
+
+    def recv(self):
+        """
+        Receive a zmsg message from the actor. Returns NULL if the actor
+        was interrupted before the message could be received, or if there
+        was a timeout on the actor.
+        """
+        return utils.lib.zactor_recv(self._p)
+
+    def is_py(self):
+        """
+        Probe the supplied object, and report if it looks like a zactor_t.
+        """
+        return utils.lib.zactor_is(self._p)
+
+    def resolve(self):
+        """
+        Probe the supplied reference. If it looks like a zactor_t instance,
+        return the underlying libzmq actor handle; else if it looks like
+        a libzmq actor handle, return the supplied value.
+        """
+        return utils.lib.zactor_resolve(self._p)
+
+    def sock(self):
+        """
+        Return the actor's zsock handle. Use this when you absolutely need
+        to work with the zsock instance rather than the actor.
+        """
+        return utils.lib.zactor_sock(self._p)
+
+    def set_destructor(self, destructor):
+        """
+        Change default destructor by custom function. Actor MUST be able to handle new message instead of default $TERM.
+        """
+        utils.lib.zactor_set_destructor(self._p, destructor)
+
+    def test(verbose):
+        """
+        Self test of this class.
+        """
+        utils.lib.zactor_test(verbose)
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

data/vendor/github.com/zeromq/czmq/bindings/python_cffi/czmq_cffi/Zargs.py

@@ -0,0 +1,133 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+import utils
+from . import destructors
+libczmq_destructors = destructors.lib
+
+class Zargs(object):
+    """
+    Platform independent command line argument parsing helpers
+
+There are two kind of elements provided by this class
+foo --named-parameter --parameter with_value positional arguments -a gain-parameter
+zargs keeps poision only for arguments, parameters are to be accessed like hash.
+
+It DOES:
+* provide easy to use CLASS compatible API for accessing argv
+* is platform independent
+* provide getopt_long style -- argument, which delimits parameters from arguments
+* makes parameters positon independent
+
+It does NOT
+* change argv
+* provide a "declarative" way to define command line interface
+
+In future it SHALL
+* hide several formats of command line to one (-Idir, --include=dir,
+  --include dir are the same from API pov)
+    """
+
+    def __init__(self, argc, argv):
+        """
+        Create a new zargs from command line arguments.
+        """
+        p = utils.lib.zargs_new(argc, utils.to_bytes(argv))
+        if p == utils.ffi.NULL:
+            raise MemoryError("Could not allocate person")
+
+        # ffi.gc returns a copy of the cdata object which will have the
+        # destructor called when the Python object is GC'd:
+        # https://cffi.readthedocs.org/en/latest/using.html#ffi-interface
+        self._p = utils.ffi.gc(p, libczmq_destructors.zargs_destroy_py)
+
+    def progname(self):
+        """
+        Return program name (argv[0])
+        """
+        return utils.lib.zargs_progname(self._p)
+
+    def arguments(self):
+        """
+        Return number of positional arguments
+        """
+        return utils.lib.zargs_arguments(self._p)
+
+    def first(self):
+        """
+        Return first positional argument or NULL
+        """
+        return utils.lib.zargs_first(self._p)
+
+    def next(self):
+        """
+        Return next positional argument or NULL
+        """
+        return utils.lib.zargs_next(self._p)
+
+    def param_first(self):
+        """
+        Return first named parameter value, or NULL if there are no named
+        parameters, or value for which zargs_param_empty (arg) returns true.
+        """
+        return utils.lib.zargs_param_first(self._p)
+
+    def param_next(self):
+        """
+        Return next named parameter value, or NULL if there are no named
+        parameters, or value for which zargs_param_empty (arg) returns true.
+        """
+        return utils.lib.zargs_param_next(self._p)
+
+    def param_name(self):
+        """
+        Return current parameter name, or NULL if there are no named
+        parameters.
+        """
+        return utils.lib.zargs_param_name(self._p)
+
+    def param_lookup(self, keys):
+        """
+        Return value of named parameter, NULL if no given parameter has
+        been specified, or special value for wich zargs_param_empty ()
+        returns true.
+        """
+        return utils.lib.zargs_param_lookup(self._p, utils.to_bytes(keys))
+
+    def param_lookupx(self, keys, ):
+        """
+        Return value of named parameter(s), NULL if no given parameter has
+        been specified, or special value for wich zargs_param_empty ()
+        returns true.
+        """
+        return utils.lib.zargs_param_lookupx(self._p, utils.to_bytes(keys), )
+
+    def has_help(self):
+        """
+        Returns true if there are --help -h arguments
+        """
+        return utils.lib.zargs_has_help(self._p)
+
+    def param_empty(arg):
+        """
+        Returns true if parameter did not have a value
+        """
+        return utils.lib.zargs_param_empty(utils.to_bytes(arg))
+
+    def print_py(self):
+        """
+        Print an instance of zargs.
+        """
+        utils.lib.zargs_print(self._p)
+
+    def test(verbose):
+        """
+        Self test of this class.
+        """
+        utils.lib.zargs_test(verbose)
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

data/vendor/github.com/zeromq/czmq/bindings/python_cffi/czmq_cffi/Zarmour.py

@@ -0,0 +1,124 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+import utils
+from . import destructors
+libczmq_destructors = destructors.lib
+
+class Zarmour(object):
+    """
+    armoured text encoding and decoding
+    """
+
+    def __init__(self):
+        """
+        Create a new zarmour
+        """
+        p = utils.lib.zarmour_new()
+        if p == utils.ffi.NULL:
+            raise MemoryError("Could not allocate person")
+
+        # ffi.gc returns a copy of the cdata object which will have the
+        # destructor called when the Python object is GC'd:
+        # https://cffi.readthedocs.org/en/latest/using.html#ffi-interface
+        self._p = utils.ffi.gc(p, libczmq_destructors.zarmour_destroy_py)
+
+    def encode(self, data, size):
+        """
+        Encode a stream of bytes into an armoured string. Returns the armoured
+        string, or NULL if there was insufficient memory available to allocate
+        a new string.
+        """
+        return utils.lib.zarmour_encode(self._p, data, size)
+
+    def decode(self, data):
+        """
+        Decode an armoured string into a chunk. The decoded output is
+        null-terminated, so it may be treated as a string, if that's what
+        it was prior to encoding.
+        """
+        return utils.lib.zarmour_decode(self._p, utils.to_bytes(data))
+
+    def mode(self):
+        """
+        Get the mode property.
+        """
+        return utils.lib.zarmour_mode(self._p)
+
+    def mode_str(self):
+        """
+        Get printable string for mode.
+        """
+        return utils.lib.zarmour_mode_str(self._p)
+
+    def set_mode(self, mode):
+        """
+        Set the mode property.
+        """
+        utils.lib.zarmour_set_mode(self._p, mode)
+
+    def pad(self):
+        """
+        Return true if padding is turned on.
+        """
+        return utils.lib.zarmour_pad(self._p)
+
+    def set_pad(self, pad):
+        """
+        Turn padding on or off. Default is on.
+        """
+        utils.lib.zarmour_set_pad(self._p, pad)
+
+    def pad_char(self):
+        """
+        Get the padding character.
+        """
+        return utils.lib.zarmour_pad_char(self._p)
+
+    def set_pad_char(self, pad_char):
+        """
+        Set the padding character.
+        """
+        utils.lib.zarmour_set_pad_char(self._p, pad_char._p)
+
+    def line_breaks(self):
+        """
+        Return if splitting output into lines is turned on. Default is off.
+        """
+        return utils.lib.zarmour_line_breaks(self._p)
+
+    def set_line_breaks(self, line_breaks):
+        """
+        Turn splitting output into lines on or off.
+        """
+        utils.lib.zarmour_set_line_breaks(self._p, line_breaks)
+
+    def line_length(self):
+        """
+        Get the line length used for splitting lines.
+        """
+        return utils.lib.zarmour_line_length(self._p)
+
+    def set_line_length(self, line_length):
+        """
+        Set the line length used for splitting lines.
+        """
+        utils.lib.zarmour_set_line_length(self._p, line_length)
+
+    def print_py(self):
+        """
+        Print properties of object
+        """
+        utils.lib.zarmour_print(self._p)
+
+    def test(verbose):
+        """
+        Self test of this class.
+        """
+        utils.lib.zarmour_test(verbose)
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

data/vendor/github.com/zeromq/czmq/bindings/python_cffi/czmq_cffi/Zcert.py

@@ -0,0 +1,132 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+import utils
+from . import destructors
+libczmq_destructors = destructors.lib
+
+class Zcert(object):
+    """
+    work with CURVE security certificates
+    """
+
+    def __init__(self):
+        """
+        Create and initialize a new certificate in memory
+        """
+        p = utils.lib.zcert_new()
+        if p == utils.ffi.NULL:
+            raise MemoryError("Could not allocate person")
+
+        # ffi.gc returns a copy of the cdata object which will have the
+        # destructor called when the Python object is GC'd:
+        # https://cffi.readthedocs.org/en/latest/using.html#ffi-interface
+        self._p = utils.ffi.gc(p, libczmq_destructors.zcert_destroy_py)
+
+    def public_key(self):
+        """
+        Return public part of key pair as 32-byte binary string
+        """
+        return utils.lib.zcert_public_key(self._p)
+
+    def secret_key(self):
+        """
+        Return secret part of key pair as 32-byte binary string
+        """
+        return utils.lib.zcert_secret_key(self._p)
+
+    def public_txt(self):
+        """
+        Return public part of key pair as Z85 armored string
+        """
+        return utils.lib.zcert_public_txt(self._p)
+
+    def secret_txt(self):
+        """
+        Return secret part of key pair as Z85 armored string
+        """
+        return utils.lib.zcert_secret_txt(self._p)
+
+    def set_meta(self, name, format, ):
+        """
+        Set certificate metadata from formatted string.
+        """
+        utils.lib.zcert_set_meta(self._p, utils.to_bytes(name), format, )
+
+    def unset_meta(self, name):
+        """
+        Unset certificate metadata.
+        """
+        utils.lib.zcert_unset_meta(self._p, utils.to_bytes(name))
+
+    def meta(self, name):
+        """
+        Get metadata value from certificate; if the metadata value doesn't
+        exist, returns NULL.
+        """
+        return utils.lib.zcert_meta(self._p, utils.to_bytes(name))
+
+    def meta_keys(self):
+        """
+        Get list of metadata fields from certificate. Caller is responsible for
+        destroying list. Caller should not modify the values of list items.
+        """
+        return utils.lib.zcert_meta_keys(self._p)
+
+    def save(self, filename):
+        """
+        Save full certificate (public + secret) to file for persistent storage
+        This creates one public file and one secret file (filename + "_secret").
+        """
+        return utils.lib.zcert_save(self._p, utils.to_bytes(filename))
+
+    def save_public(self, filename):
+        """
+        Save public certificate only to file for persistent storage
+        """
+        return utils.lib.zcert_save_public(self._p, utils.to_bytes(filename))
+
+    def save_secret(self, filename):
+        """
+        Save secret certificate only to file for persistent storage
+        """
+        return utils.lib.zcert_save_secret(self._p, utils.to_bytes(filename))
+
+    def apply(self, socket):
+        """
+        Apply certificate to socket, i.e. use for CURVE security on socket.
+        If certificate was loaded from public file, the secret key will be
+        undefined, and this certificate will not work successfully.
+        """
+        utils.lib.zcert_apply(self._p, socket._p)
+
+    def dup(self):
+        """
+        Return copy of certificate; if certificate is NULL or we exhausted
+        heap memory, returns NULL.
+        """
+        return utils.lib.zcert_dup(self._p)
+
+    def eq(self, compare):
+        """
+        Return true if two certificates have the same keys
+        """
+        return utils.lib.zcert_eq(self._p, compare._p)
+
+    def print_py(self):
+        """
+        Print certificate contents to stdout
+        """
+        utils.lib.zcert_print(self._p)
+
+    def test(verbose):
+        """
+        Self test of this class
+        """
+        utils.lib.zcert_test(verbose)
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################