laag-libczmq 4.1.0.0

data/vendor/github.com/zeromq/czmq/api/zcertstore.api

@@ -0,0 +1,80 @@
+<class name = "zcertstore" state = "stable">
+    <!--
+    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/.
+    -->
+    work with CURVE security certificate stores
+
+    <constructor>
+        Create a new certificate store from a disk directory, loading and
+        indexing all certificates in that location. The directory itself may be
+        absent, and created later, or modified at any time. The certificate store
+        is automatically refreshed on any zcertstore_lookup() call. If the
+        location is specified as NULL, creates a pure-memory store, which you
+        can work with by inserting certificates at runtime.
+        <argument name = "location" type = "string" />
+    </constructor>
+
+    <destructor>
+        Destroy a certificate store object in memory. Does not affect anything
+        stored on disk.
+    </destructor>
+
+    <callback_type name = "loader" state = "draft">
+        Loaders retrieve certificates from an arbitrary source.
+        <argument name = "self" type = "zcertstore" />
+    </callback_type>
+
+    <callback_type name = "destructor" state = "draft">
+        Destructor for loader state.
+        <argument name = "self_p" type = "buffer" c_type = "void **" />
+    </callback_type>
+
+    <method name = "set_loader" state = "draft">
+      Override the default disk loader with a custom loader fn.
+      <argument name = "loader" type = "zcertstore_loader" callback = "1" />
+      <argument name = "destructor" type = "zcertstore_destructor" callback = "1" />
+      <argument name = "state" type = "buffer" c_type = "void *" />
+    </method>
+
+    <method name = "lookup">
+        Look up certificate by public key, returns zcert_t object if found,
+        else returns NULL. The public key is provided in Z85 text format.
+        <argument name = "public key" type = "string" />
+        <return type = "zcert" mutable = "1" />
+    </method>
+
+    <method name = "insert">
+        Insert certificate into certificate store in memory. Note that this
+        does not save the certificate to disk. To do that, use zcert_save()
+        directly on the certificate. Takes ownership of zcert_t object.
+        <argument name = "cert p" type = "zcert" by_reference = "1" />
+    </method>
+
+    <method name = "empty" state = "draft">
+        Empty certificate hashtable. This wrapper exists to be friendly to bindings,
+        which don't usually have access to struct internals.
+    </method>
+
+    <method name = "print">
+        Print list of certificates in store to logging facility
+    </method>
+
+    <method name = "certs" state = "draft">
+        Return a list of all the certificates in the store.
+        The caller takes ownership of the zlistx_t object and is responsible
+        for destroying it.  The caller does not take ownership of the zcert_t
+        objects.
+        <return type = "zlistx" fresh = "1" />
+    </method>
+
+    <method name = "test" singleton = "1">
+        Self test of this class
+        <argument name = "verbose" type = "boolean" />
+    </method>
+</class>

data/vendor/github.com/zeromq/czmq/api/zchunk.api

@@ -0,0 +1,171 @@
+<class name = "zchunk" state = "stable">
+    <!--
+    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/.
+    -->
+    work with memory chunks
+    
+    <constructor>
+        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.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+    </constructor>
+
+    <destructor>
+        Destroy a chunk
+    </destructor>
+
+    <method name = "resize">
+        Resizes chunk max_size as requested; chunk_cur size is set to zero
+        <argument name = "size" type = "size" />
+    </method>
+
+    <method name = "size">
+        Return chunk cur size
+        <return type = "size" />
+    </method>
+
+    <method name = "max_size">
+        Return chunk max size
+        <return type = "size" />
+    </method>
+
+    <method name = "data">
+        Return chunk data
+        <return type = "buffer" mutable = "1" size = ".size" />
+    </method>
+
+    <method name = "set">
+        Set chunk data from user-supplied data; truncate if too large. Data may
+        be null. Returns actual size of chunk
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+        <return type = "size" />
+    </method>
+
+    <method name = "fill">
+        Fill chunk data from user-supplied octet
+        <argument name = "filler" type = "byte" />
+        <argument name = "size" type = "size" />
+        <return type = "size" />
+    </method>
+
+    <method name = "append">
+        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.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+        <return type = "size" />
+    </method>
+
+    <method name = "extend">
+        Append user-supplied data to chunk, return resulting chunk size. If the
+        data would exceeded the available space, the chunk grows in size.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+        <return type = "size" />
+    </method>
+
+    <method name = "consume">
+        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.
+        <argument name = "source" type = "zchunk" mutable = "1" />
+        <return type = "size" />
+    </method>
+
+    <method name = "exhausted">
+        Returns true if the chunk was exhausted by consume methods, or if the
+        chunk has a size of zero.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "read" singleton = "1">
+        Read chunk from an open file descriptor
+        <argument name = "handle" type = "FILE" mutable = "1" />
+        <argument name = "bytes" type = "size" />
+        <return type = "zchunk" fresh = "1" />
+    </method>
+
+    <method name = "write">
+        Write chunk to an open file descriptor
+        <argument name = "handle" type = "FILE" mutable = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "slurp" singleton = "1">
+        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.
+        <argument name = "filename" type = "string" />
+        <argument name = "maxsize" type = "size" />
+        <return type = "zchunk" fresh = "1" />
+    </method>
+
+    <method name = "dup">
+        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 type = "zchunk" fresh = "1" />
+    </method>
+
+    <method name = "strhex">
+        Return chunk data encoded as printable hex string. Caller must free
+        string when finished with it.
+        <return type = "string" fresh = "1" />
+    </method>
+
+    <method name = "strdup">
+        Return chunk data copied into freshly allocated string
+        Caller must free string when finished with it.
+        <return type = "string" fresh = "1" />
+    </method>
+
+    <method name = "streq">
+        Return TRUE if chunk body is equal to string, excluding terminator
+        <argument name = "string" type = "string" />
+        <return type = "boolean" />
+    </method>
+
+    <method name = "pack">
+        Transform zchunk into a zframe that can be sent in a message.
+        <return type = "zframe" fresh = "1" />
+    </method>
+
+    <method name = "unpack" singleton = "1">
+        Transform a zframe into a zchunk.
+        <argument name = "frame" type = "zframe" mutable = "1" />
+        <return type = "zchunk" fresh = "1" />
+    </method>
+
+    <method name = "digest">
+        Calculate SHA1 digest for chunk, using zdigest class.
+        <return type = "string" />
+    </method>
+
+    <method name = "fprint">
+        Dump chunk to FILE stream, for debugging and tracing.
+        <argument name = "file" type = "FILE" mutable = "1" />
+    </method>
+
+    <method name = "print">
+        Dump message to stderr, for debugging and tracing.
+        See zchunk_fprint for details
+    </method>
+
+    <method name = "is" singleton = "1">
+        Probe the supplied object, and report if it looks like a zchunk_t.
+        <argument name = "self" type = "anything" mutable = "1" />
+        <return type = "boolean" />
+    </method>
+</class>

data/vendor/github.com/zeromq/czmq/api/zclock.api

@@ -0,0 +1,43 @@
+<class name = "zclock" state = "stable">
+    <!--
+    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/.
+    -->
+    millisecond clocks and delays
+
+    <method name = "sleep" singleton = "1">
+        Sleep for a number of milliseconds
+        <argument name = "msecs" type = "integer" />
+    </method>
+
+    <method name = "time" singleton = "1">
+        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 type = "msecs" />
+    </method>
+
+    <method name = "mono" singleton = "1">
+        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 type = "msecs" />
+    </method>
+
+    <method name = "usecs" singleton = "1">
+        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 type = "msecs" />
+    </method>
+
+    <method name = "timestr" singleton = "1">
+        Return formatted date/time as fresh string. Free using zstr_free().
+        <return type = "string" fresh = "1" />
+    </method>
+</class>

data/vendor/github.com/zeromq/czmq/api/zconfig.api

@@ -0,0 +1,205 @@
+<class name = "zconfig" state = "stable">
+    <!--
+    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/.
+    -->
+    work with config files written in rfc.zeromq.org/spec:4/ZPL.
+
+    <callback_type name = "fct">
+        <argument name = "self" type = "zconfig" />
+        <argument name = "arg" type = "anything" />
+        <argument name = "level" type = "integer" />
+        <return type = "integer" />
+    </callback_type>
+
+    <constructor>
+        Create new config item
+        <argument name = "name" type = "string" />
+        <argument name = "parent" type = "zconfig" />
+    </constructor>
+
+    <destructor>
+        Destroy a config item and all its children
+    </destructor>
+
+    <method name = "name">
+        Return name of config item
+        <return type = "string" mutable = "1" />
+    </method>
+
+    <method name = "value">
+        Return value of config item
+        <return type = "string" mutable = "1" />
+    </method>
+
+    <method name = "put">
+        Insert or update configuration key with value
+        <argument name = "path" type = "string" />
+        <argument name = "value" type = "string" />
+    </method>
+
+    <method name = "putf">
+        Equivalent to zconfig_put, accepting a format specifier and variable
+        argument list, instead of a single string value.
+        <argument name = "path" type = "string" />
+        <argument name = "format" type = "format" />
+    </method>
+
+    <method name = "get">
+        Get value for config item into a string value; leading slash is optional
+        and ignored.
+        <argument name = "path" type = "string" />
+        <argument name = "default value" type = "string" />
+        <return type = "string" mutable = "1" />
+    </method>
+    <method name = "set name">
+        Set config item name, name may be NULL
+        <argument name = "name" type = "string" />
+    </method>
+
+    <method name = "set value">
+        Set new value for config item. The new value may be a string, a printf
+        format, or NULL. Note that if string may possibly contain '%', or if it
+        comes from an insecure source, you must use '%s' as the format, followed
+        by the string.
+        <argument name = "format" type = "format" />
+    </method>
+
+    <method name = "child">
+        Find our first child, if any
+        <return type = "zconfig" />
+    </method>
+
+    <method name = "next">
+        Find our first sibling, if any
+        <return type = "zconfig" />
+    </method>
+
+    <method name = "locate">
+        Find a config item along a path; leading slash is optional and ignored.
+        <argument name = "path" type = "string" />
+        <return type = "zconfig" />
+    </method>
+
+    <method name = "at depth">
+        Locate the last config item at a specified depth
+        <argument name = "level" type = "integer" />
+        <return type = "zconfig" />
+    </method>
+
+    <method name = "execute">
+        Execute a callback for each config item in the tree; returns zero if
+        successful, else -1.
+        <argument name = "handler" type = "zconfig_fct" callback = "1" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "set comment">
+        Add comment to config item before saving to disk. You can add as many
+        comment lines as you like. If you use a null format, all comments are
+        deleted.
+        <argument name = "format" type = "format" />
+    </method>
+
+    <method name = "comments">
+        Return comments of config item, as zlist.
+        <return type = "zlist" />
+    </method>
+
+    <constructor name = "load">
+        Load a config tree from a specified ZPL text file; returns a zconfig_t
+        reference for the root, if the file exists and is readable. Returns NULL
+        if the file does not exist.
+        <argument name = "filename" type = "string" />
+    </constructor>
+
+    <method name = "save">
+        Save a config tree to a specified ZPL text file, where a filename
+        "-" means dump to standard output.
+        <argument name = "filename" type = "string" />
+        <return type = "integer" />
+    </method>
+
+    <constructor name = "loadf">
+        Equivalent to zconfig_load, taking a format string instead of a fixed
+        filename.
+        <argument name = "format" type = "format" />
+    </constructor>
+
+    <method name = "savef">
+        Equivalent to zconfig_save, taking a format string instead of a fixed
+        filename.
+        <argument name = "format" type = "format" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "filename">
+        Report filename used during zconfig_load, or NULL if none
+        <return type = "string" />
+    </method>
+
+    <method name = "reload" singleton = "1" >
+        Reload config tree from same file that it was previously loaded from.
+        Returns 0 if OK, -1 if there was an error (and then does not change
+        existing data).
+        <argument name = "self_p" type = "zconfig" by_reference = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "chunk load" singleton = "1" >
+        Load a config tree from a memory chunk
+        <argument name = "chunk" type = "zchunk" />
+        <return type = "zconfig" />
+    </method>
+
+    <method name = "chunk save">
+        Save a config tree to a new memory chunk
+        <return type = "zchunk" />
+    </method>
+
+    <method name = "str load" singleton = "1" >
+        Load a config tree from a null-terminated string
+        <argument name = "string" type = "string" />
+        <return type = "zconfig" fresh = "1" />
+    </method>
+
+    <method name = "str save">
+        Save a config tree to a new null terminated string
+        <return type = "string" fresh = "1" />
+    </method>
+
+    <method name = "has changed">
+        Return true if a configuration tree was loaded from a file and that
+        file has changed in since the tree was loaded.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "remove_subtree" state = "draft">
+        Destroy subtree (all children)
+    </method>
+
+    <method name = "remove" singleton = "1" state = "draft">
+        Destroy node and subtree (all children)
+        <argument name = "self_p" type = "zconfig" by_reference = "1" />
+    </method>
+
+    <method name = "fprint">
+        Print the config file to open stream
+        <argument name = "file" type = "FILE" />
+    </method>
+
+    <method name = "print">
+        Print properties of object
+    </method>
+
+    <method name = "test" singleton = "1">
+        Self test of this class
+        <argument name = "verbose" type = "boolean" />
+    </method>
+</class>