laag-libczmq 4.1.0.0

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

@@ -0,0 +1,45 @@
+<class name = "zdigest" 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/.
+    -->
+    provides hashing functions (SHA-1 at present)
+    
+    <constructor>
+        Constructor - creates new digest object, which you use to build up a
+        digest by repeatedly calling zdigest_update() on chunks of data.
+    </constructor>
+
+    <destructor>
+        Destroy a digest object
+    </destructor>
+
+    <method name = "update">
+        Add buffer into digest calculation
+        <argument name = "buffer" type = "buffer" />
+        <argument name = "length" type = "size" />
+    </method>
+
+    <method name = "data">
+        Return final digest hash data. If built without crypto support,
+        returns NULL.
+        <return type = "buffer" size = ".size" />
+    </method>
+
+    <method name = "size">
+        Return final digest hash size
+        <return type = "size" />
+    </method>
+
+    <method name = "string">
+        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 type = "string" mutable = "1" />
+    </method>
+</class>

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

@@ -0,0 +1,124 @@
+<class name = "zdir" 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 file-system directories
+
+    <constructor>
+        Create a new directory item that loads in the full tree of the specified
+        path, optionally located under some parent path. If parent is "-", then
+        loads only the top-level directory, and does not use parent as a path.
+        <argument name = "path" type = "string" />
+        <argument name = "parent" type = "string" />
+    </constructor>
+
+    <destructor>
+        Destroy a directory tree and all children it contains.
+    </destructor>
+
+    <method name = "path">
+        Return directory path
+        <return type = "string" />
+    </method>
+
+    <method name = "modified">
+        Return last modification time for directory.
+        <return type = "time" />
+    </method>
+
+    <method name = "cursize">
+        Return total hierarchy size, in bytes of data contained in all files
+        in the directory tree.
+        <return type = "file_size" />
+    </method>
+
+    <method name = "count">
+        Return directory count
+        <return type = "size" />
+    </method>
+
+    <method name = "list">
+        Returns a sorted list of zfile objects; Each entry in the list is a pointer
+        to a zfile_t item already allocated in the zdir tree. Do not destroy the
+        original zdir tree until you are done with this list.
+        <return type = "zlist" fresh = "1" />
+    </method>
+
+    <method name = "remove">
+        Remove directory, optionally including all files that it contains, at
+        all levels. If force is false, will only remove the directory if empty.
+        If force is true, will remove all files and all subdirectories.
+        <argument name = "force" type = "boolean" />
+    </method>
+
+    <method name = "diff" singleton = "1">
+        Calculate differences between two versions of a directory tree.
+        Returns a list of zdir_patch_t patches. Either older or newer may
+        be null, indicating the directory is empty/absent. If alias is set,
+        generates virtual filename (minus path, plus alias).
+        <argument name = "older" type = "zdir" />
+        <argument name = "newer" type = "zdir" />
+        <argument name = "alias" type = "string" />
+        <return type = "zlist" fresh = "1" />
+    </method>
+
+    <method name = "resync">
+        Return full contents of directory as a zdir_patch list.
+        <argument name = "alias" type = "string" />
+        <return type = "zlist" fresh = "1" />
+    </method>
+
+    <method name = "cache">
+        Load directory cache; returns a hash table containing the SHA-1 digests
+        of every file in the tree. The cache is saved between runs in .cache.
+        <return type = "zhash" fresh = "1" />
+    </method>
+
+    <method name = "fprint">
+        Print contents of directory to open stream
+        <argument name = "file" type = "FILE" />
+        <argument name = "indent" type = "integer" />
+    </method>
+
+    <method name = "print">
+        Print contents of directory to stdout
+        <argument name = "indent" type = "integer" />
+    </method>
+
+    <method name = "watch" singleton = "1">
+        Create a new zdir_watch actor instance:
+
+            zactor_t *watch = zactor_new (zdir_watch, NULL);
+
+        Destroy zdir_watch instance:
+
+            zactor_destroy (&amp;watch);
+
+        Enable verbose logging of commands and activity:
+
+            zstr_send (watch, "VERBOSE");
+
+        Subscribe to changes to a directory path:
+
+            zsock_send (watch, "ss", "SUBSCRIBE", "directory_path");
+
+        Unsubscribe from changes to a directory path:
+
+            zsock_send (watch, "ss", "UNSUBSCRIBE", "directory_path");
+
+        Receive directory changes:
+            zsock_recv (watch, "sp", &amp;path, &amp;patches);
+
+            // Delete the received data.
+            free (path);
+            zlist_destroy (&amp;patches);
+        <argument name = "pipe" type = "zsock" />
+        <argument name = "unused" type = "anything" />
+    </method>
+</class>

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

@@ -0,0 +1,62 @@
+<class name = "zdir_patch" 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 directory patches
+
+    <constant name = "create" value = "1">Creates a new file</constant>
+    <constant name = "delete" value = "2">Delete a file</constant>
+
+    <constructor>
+        Create new patch
+        <argument name = "path" type = "string" />
+        <argument name = "file" type = "zfile" />
+        <argument name = "op" type = "integer" />
+        <argument name = "alias" type = "string" />
+    </constructor>
+
+    <destructor>
+        Destroy a patch
+    </destructor>
+
+    <method name = "dup">
+        Create copy of a patch. If the patch is null, or memory was exhausted,
+        returns null.
+        <return type = "zdir_patch" fresh = "1" />
+    </method>
+
+    <method name = "path">
+        Return patch file directory path
+        <return type = "string" />
+    </method>
+
+    <method name = "file">
+        Return patch file item
+        <return type = "zfile" />
+    </method>
+
+    <method name = "op">
+        Return operation
+        <return type = "integer" />
+    </method>
+
+    <method name = "vpath">
+        Return patch virtual file path
+        <return type = "string" />
+    </method>
+
+    <method name = "digest set">
+        Calculate hash digest for file (create only)
+    </method>
+
+    <method name = "digest">
+        Return hash digest for patch file
+        <return type = "string" />
+    </method>
+</class>

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

@@ -0,0 +1,157 @@
+<class name = "zfile" 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/.
+    -->
+    helper functions for working with files.
+
+    <constructor>
+        If file exists, populates properties. CZMQ supports portable symbolic
+        links, which are files with the extension ".ln". A symbolic link is a
+        text file containing one line, the filename of a target file. Reading
+        data from the symbolic link actually reads from the target file. Path
+        may be NULL, in which case it is not used.
+        <argument name = "path" type = "string" />
+        <argument name = "name" type = "string" />
+    </constructor>
+
+    <constructor name="tmp" state="draft">
+        Create new temporary file for writing via tmpfile. File is automaticaly
+        deleted on destroy
+    </constructor>
+
+    <destructor>
+        Destroy a file item
+    </destructor>
+
+    <method name = "dup">
+        Duplicate a file item, returns a newly constructed item. If the file
+        is null, or memory was exhausted, returns null.
+        <return type = "zfile" fresh = "1" />
+    </method>
+
+    <method name = "filename">
+        Return file name, remove path if provided
+        <argument name = "path" type = "string" />
+        <return type = "string" />
+    </method>
+
+    <method name = "restat">
+        Refresh file properties from disk; this is not done automatically
+        on access methods, otherwise it is not possible to compare directory
+        snapshots.
+    </method>
+
+    <method name = "modified">
+        Return when the file was last modified. If you want this to reflect the
+        current situation, call zfile_restat before checking this property.
+        <return type = "time" />
+    </method>
+
+    <method name = "cursize">
+        Return the last-known size of the file. If you want this to reflect the
+        current situation, call zfile_restat before checking this property.
+        <return type = "file_size" />
+    </method>
+
+    <method name = "is directory">
+        Return true if the file is a directory. If you want this to reflect
+        any external changes, call zfile_restat before checking this property.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "is regular">
+        Return true if the file is a regular file. If you want this to reflect
+        any external changes, call zfile_restat before checking this property.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "is readable">
+        Return true if the file is readable by this process. If you want this to
+        reflect any external changes, call zfile_restat before checking this
+        property.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "is writeable">
+        Return true if the file is writeable by this process. If you want this
+        to reflect any external changes, call zfile_restat before checking this
+        property.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "is stable">
+        Check if file has stopped changing and can be safely processed.
+        Updates the file statistics from disk at every call.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "has changed">
+        Return true if the file was changed on disk since the zfile_t object
+        was created, or the last zfile_restat() call made on it.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "remove">
+        Remove the file from disk
+    </method>
+
+    <method name = "input">
+        Open file for reading
+        Returns 0 if OK, -1 if not found or not accessible
+        <return type = "integer" />
+    </method>
+
+    <method name = "output">
+        Open file for writing, creating directory if needed
+        File is created if necessary; chunks can be written to file at any
+        location. Returns 0 if OK, -1 if error.
+        <return type = "integer" />
+    </method>
+
+    <method name = "read">
+        Read chunk from file at specified position. If this was the last chunk,
+        sets the eof property. Returns a null chunk in case of error.
+        <argument name = "bytes" type = "size" />
+        <argument name = "offset" type = "file_size" />
+        <return type = "zchunk" fresh = "1" />
+    </method>
+
+    <method name = "eof">
+        Returns true if zfile_read() just read the last chunk in the file.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "write">
+        Write chunk to file at specified position
+        Return 0 if OK, else -1
+        <argument name = "chunk" type = "zchunk" />
+        <argument name = "offset" type = "file_size" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "readln">
+        Read next line of text from file. Returns a pointer to the text line,
+        or NULL if there was nothing more to read from the file.
+        <return type = "string" />
+    </method>
+
+    <method name = "close">
+        Close file, if open
+    </method>
+
+    <method name = "handle">
+        Return file handle, if opened
+        <return type = "FILE" />
+    </method>
+
+    <method name = "digest">
+        Calculate SHA1 digest for file, using zdigest class.
+        <return type = "string" />
+    </method>
+</class>

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

@@ -0,0 +1,157 @@
+<class name = "zframe" 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/.
+    -->
+    working with single message frames
+
+    <constant name = "more" value = "1" />
+    <constant name = "reuse" value = "2" />
+    <constant name = "dontwait" value = "4" />
+
+    <constructor>
+        Create a new frame. If size is not null, allocates the frame data
+        to the specified size. If additionally, data is not null, copies
+        size octets from the specified data into the frame body.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+    </constructor>
+
+    <destructor>
+        Destroy a frame
+    </destructor>
+
+    <constructor name = "new empty">
+        Create an empty (zero-sized) frame
+    </constructor>
+
+    <constructor name = "from">
+        Create a frame with a specified string content.
+        <argument name = "string" type = "string" />
+    </constructor>
+
+    <constructor name = "recv">
+        Receive frame from socket, returns zframe_t object or NULL if the recv
+        was interrupted. Does a blocking recv, if you want to not block then use
+        zpoller or zloop.
+        <argument name = "source" type = "sockish" />
+    </constructor>
+
+    <method name = "send" singleton = "1">
+        Send a frame to a socket, destroy frame after sending.
+        Return -1 on error, 0 on success.
+        <argument name = "self_p" type = "zframe" by_reference = "1" />
+        <argument name = "dest" type = "sockish" />
+        <argument name = "flags" type = "integer" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "size">
+        Return number of bytes in frame data
+        <return type = "size" />
+    </method>
+
+    <method name = "data">
+        Return address of frame data
+        <return type = "buffer" mutable = "1" size = ".size" />
+    </method>
+
+    <method name = "meta">
+        Return meta data property for frame
+        The caller shall not modify or free the returned value, which shall be
+        owned by the message.
+        <argument name = "property" type = "string" />
+        <return type = "string" fresh = "0" />
+    </method>
+
+    <method name = "dup">
+        Create a new frame that duplicates an existing frame. If frame is null,
+        or memory was exhausted, returns null.
+        <return type = "zframe" fresh = "1" />
+    </method>
+
+    <method name = "strhex">
+        Return frame data encoded as printable hex string, useful for 0MQ UUIDs.
+        Caller must free string when finished with it.
+        <return type = "string" fresh = "1" />
+    </method>
+
+    <method name = "strdup">
+        Return frame 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 frame body is equal to string, excluding terminator
+        <argument name = "string" type = "string" />
+        <return type = "boolean" />
+    </method>
+
+    <method name = "more">
+        Return frame MORE indicator (1 or 0), set when reading frame from socket
+        or by the zframe_set_more() method
+        <return type = "integer" />
+    </method>
+
+    <method name = "set more">
+        Set frame MORE indicator (1 or 0). Note this is NOT used when sending
+        frame to socket, you have to specify flag explicitly.
+        <argument name = "more" type = "integer" />
+    </method>
+
+    <method name = "routing id" state = "draft" >
+        Return frame routing ID, if the frame came from a ZMQ_SERVER socket.
+        Else returns zero.
+        <return type = "number" size = "4" />
+    </method>
+
+    <method name = "set routing id" state = "draft" >
+        Set routing ID on frame. This is used if/when the frame is sent to a
+        ZMQ_SERVER socket.
+        <argument name = "routing id" type = "number" size = "4" />
+    </method>
+
+    <method name = "group" state = "draft" >
+        Return frame group of radio-dish pattern.
+        <return type = "string" />
+    </method>
+
+    <method name = "set group" state = "draft" >
+        Set group on frame. This is used if/when the frame is sent to a
+        ZMQ_RADIO socket.
+        Return -1 on error, 0 on success.
+        <argument name = "group" type = "string" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "eq">
+        Return TRUE if two frames have identical size and data
+        If either frame is NULL, equality is always false.
+        <argument name = "other" type = "zframe" />
+        <return type = "boolean" />
+    </method>
+
+    <method name = "reset">
+        Set new contents for frame
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+    </method>
+
+    <method name = "print">
+        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.
+        <argument name = "prefix" type = "string" />
+    </method>
+
+    <method name = "is" singleton = "1">
+        Probe the supplied object, and report if it looks like a zframe_t.
+        <argument name = "self" type = "anything" />
+        <return type = "boolean" />
+    </method>
+</class>