laag-libczmq 4.1.0.0

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

@@ -0,0 +1,176 @@
+<class name = "zloop" 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/.
+    -->
+    event-driven reactor
+
+    <callback_type name = "reader_fn">
+        Callback function for reactor socket activity
+        <argument name = "loop" type = "zloop" />
+        <argument name = "reader" type = "zsock" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </callback_type>
+
+    <callback_type name = "fn">
+        Callback function for reactor events (low-level)
+        <argument name = "loop" type = "zloop" />
+        <argument name = "item" type = "zmq_pollitem" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </callback_type>
+
+    <callback_type name = "timer_fn">
+        Callback for reactor timer events
+        <argument name = "loop" type = "zloop" />
+        <argument name = "timer_id" type = "integer" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </callback_type>
+
+    <constructor>
+        Create a new zloop reactor
+    </constructor>
+
+    <destructor>
+        Destroy a reactor
+    </destructor>
+
+    <method name = "reader">
+        Register socket reader with the reactor. When the reader has messages,
+        the reactor will call the handler, passing the arg. Returns 0 if OK, -1
+        if there was an error. If you register the same socket more than once,
+        each instance will invoke its corresponding handler.
+        <argument name = "sock" type = "zsock" />
+        <argument name = "handler" type = "zloop_reader_fn" callback = "1" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "reader end">
+        Cancel a socket reader from the reactor. If multiple readers exist for
+        same socket, cancels ALL of them.
+        <argument name = "sock" type = "zsock" />
+    </method>
+
+    <method name = "reader set tolerant">
+        Configure a registered reader to ignore errors. If you do not set this,
+        then readers that have errors are removed from the reactor silently.
+        <argument name = "sock" type = "zsock" />
+    </method>
+
+    <method name = "poller">
+        Register low-level libzmq pollitem with the reactor. When the pollitem
+        is ready, will call the handler, passing the arg. Returns 0 if OK, -1
+        if there was an error. If you register the pollitem more than once, each
+        instance will invoke its corresponding handler. A pollitem with
+        socket=NULL and fd=0 means 'poll on FD zero'.
+        <argument name = "item" type = "zmq_pollitem" />
+        <argument name = "handler" type = "zloop_fn" callback = "1" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "poller end">
+        Cancel a pollitem from the reactor, specified by socket or FD. If both
+        are specified, uses only socket. If multiple poll items exist for same
+        socket/FD, cancels ALL of them.
+        <argument name = "item" type = "zmq_pollitem" />
+    </method>
+
+    <method name = "poller set tolerant">
+        Configure a registered poller to ignore errors. If you do not set this,
+        then poller that have errors are removed from the reactor silently.
+        <argument name = "item" type = "zmq_pollitem" />
+    </method>
+
+    <method name = "timer">
+        Register a timer that expires after some delay and repeats some number of
+        times. At each expiry, will call the handler, passing the arg. To run a
+        timer forever, use 0 times. Returns a timer_id that is used to cancel the
+        timer in the future. Returns -1 if there was an error.
+        <argument name = "delay" type = "size" />
+        <argument name = "times" type = "size" />
+        <argument name = "handler" type = "zloop_timer_fn" callback = "1" />
+        <argument name = "arg" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "timer end">
+        Cancel a specific timer identified by a specific timer_id (as returned by
+        zloop_timer).
+        <argument name = "timer id" type = "integer" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "ticket">
+        Register a ticket timer. Ticket timers are very fast in the case where
+        you use a lot of timers (thousands), and frequently remove and add them.
+        The main use case is expiry timers for servers that handle many clients,
+        and which reset the expiry timer for each message received from a client.
+        Whereas normal timers perform poorly as the number of clients grows, the
+        cost of ticket timers is constant, no matter the number of clients. You
+        must set the ticket delay using zloop_set_ticket_delay before creating a
+        ticket. Returns a handle to the timer that you should use in
+        zloop_ticket_reset and zloop_ticket_delete.
+        <argument name = "handler" type = "zloop_timer_fn" callback = "1" />
+        <argument name = "arg" type = "anything" />
+        <return type = "anything" />
+    </method>
+
+    <method name = "ticket reset">
+        Reset a ticket timer, which moves it to the end of the ticket list and
+        resets its execution time. This is a very fast operation.
+        <argument name = "handle" type = "anything" />
+    </method>
+
+    <method name = "ticket delete">
+        Delete a ticket timer. We do not actually delete the ticket here, as
+        other code may still refer to the ticket. We mark as deleted, and remove
+        later and safely.
+        <argument name = "handle" type = "anything" />
+    </method>
+
+    <method name = "set ticket delay">
+        Set the ticket delay, which applies to all tickets. If you lower the
+        delay and there are already tickets created, the results are undefined.
+        <argument name = "ticket delay" type = "size" />
+    </method>
+
+    <method name = "set max timers">
+        Set hard limit on number of timers allowed. Setting more than a small
+        number of timers (10-100) can have a dramatic impact on the performance
+        of the reactor. For high-volume cases, use ticket timers. If the hard
+        limit is reached, the reactor stops creating new timers and logs an
+        error.
+        <argument name = "max timers" type = "size" />
+    </method>
+
+    <method name = "set verbose">
+        Set verbose tracing of reactor on/off. The default verbose setting is
+        off (false).
+        <argument name = "verbose" type = "boolean" />
+    </method>
+
+    <method name = "set nonstop" >
+        By default the reactor stops if the process receives a SIGINT or SIGTERM
+        signal. This makes it impossible to shut-down message based architectures
+        like zactors. This method lets you switch off break handling. The default
+        nonstop setting is off (false).
+        <argument name = "nonstop" type = "boolean" />
+    </method>
+
+    <method name = "start">
+        Start the reactor. Takes control of the thread and returns when the 0MQ
+        context is terminated or the process is interrupted, or any event handler
+        returns -1. Event handlers may register new sockets and timers, and
+        cancel sockets. Returns 0 if interrupted, -1 if canceled by a handler.
+        <return type = "integer" />
+    </method>
+</class>

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

@@ -0,0 +1,250 @@
+<class name = "zmsg" 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 multipart messages
+
+    <constructor>
+        Create a new empty message object
+    </constructor>
+
+    <destructor>
+        Destroy a message object and all frames it contains
+    </destructor>
+
+    <constructor name = "recv">
+        Receive message from socket, returns zmsg_t object or NULL if the recv
+        was interrupted. Does a blocking recv. If you want to not block then use
+        the zloop class or zmsg_recv_nowait or zmq_poll to check for socket input
+        before receiving.
+        <argument name = "source" type = "sockish" />
+    </constructor>
+
+    <method name = "send" singleton = "1">
+        Send message to destination socket, and destroy the message after sending
+        it successfully. If the message has no frames, sends nothing but destroys
+        the message anyhow. Nullifies the caller's reference to the message (as
+        it is a destructor).
+        <argument name = "self_p" type = "zmsg" by_reference = "1" />
+        <argument name = "dest" type = "sockish" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "sendm" singleton = "1">
+        Send message to destination socket as part of a multipart sequence, and
+        destroy the message after sending it successfully. Note that after a
+        zmsg_sendm, you must call zmsg_send or another method that sends a final
+        message part. If the message has no frames, sends nothing but destroys
+        the message anyhow. Nullifies the caller's reference to the message (as
+        it is a destructor).
+        <argument name = "self_p" type = "zmsg" by_reference = "1" />
+        <argument name = "dest" type = "sockish" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "size">
+        Return size of message, i.e. number of frames (0 or more).
+        <return type = "size" />
+    </method>
+
+    <method name = "content size">
+        Return total size of all frames in message.
+        <return type = "size" />
+    </method>
+
+    <method name = "routing id" state = "draft" >
+        Return message routing ID, if the message 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 message. This is used if/when the message is sent to a
+        ZMQ_SERVER socket.
+        <argument name = "routing id" type = "number" size = "4" />
+    </method>
+
+    <method name = "prepend">
+        Push frame to the front of the message, i.e. before all other frames.
+        Message takes ownership of frame, will destroy it when message is sent.
+        Returns 0 on success, -1 on error. Deprecates zmsg_push, which did not
+        nullify the caller's frame reference.
+        <argument name = "frame_p" type = "zframe" by_reference = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "append">
+        Add frame to the end of the message, i.e. after all other frames.
+        Message takes ownership of frame, will destroy it when message is sent.
+        Returns 0 on success. Deprecates zmsg_add, which did not nullify the
+        caller's frame reference.
+        <argument name = "frame_p" type = "zframe" by_reference = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "pop">
+        Remove first frame from message, if any. Returns frame, or NULL.
+        <return type = "zframe" fresh = "1" />
+    </method>
+
+    <method name = "pushmem">
+        Push block of memory to front of message, as a new frame.
+        Returns 0 on success, -1 on error.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "addmem">
+        Add block of memory to the end of the message, as a new frame.
+        Returns 0 on success, -1 on error.
+        <argument name = "data" type = "buffer" c_type = "const void *" />
+        <argument name = "size" type = "size" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "pushstr">
+        Push string as new frame to front of message.
+        Returns 0 on success, -1 on error.
+        <argument name = "string" type = "string" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "addstr">
+        Push string as new frame to end of message.
+        Returns 0 on success, -1 on error.
+        <argument name = "string" type = "string" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "pushstrf">
+        Push formatted string as new frame to front of message.
+        Returns 0 on success, -1 on error.
+        <argument name = "format" type = "format" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "addstrf">
+        Push formatted string as new frame to end of message.
+        Returns 0 on success, -1 on error.
+        <argument name = "format" type = "format" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "popstr">
+        Pop frame off front of message, return as fresh string. If there were
+        no more frames in the message, returns NULL.
+        <return type = "string" fresh = "1" />
+    </method>
+
+    <method name = "addmsg">
+        Push encoded message as a new frame. Message takes ownership of
+        submessage, so the original is destroyed in this call. Returns 0 on
+        success, -1 on error.
+        <argument name = "msg_p" type = "zmsg" by_reference = "1" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "popmsg">
+        Remove first submessage from message, if any. Returns zmsg_t, or NULL if
+        decoding was not successful.
+        <return type = "zmsg" fresh = "1" />
+    </method>
+
+    <method name = "remove">
+        Remove specified frame from list, if present. Does not destroy frame.
+        <argument name = "frame" type = "zframe" />
+    </method>
+
+    <method name = "first">
+        Set cursor to first frame in message. Returns frame, or NULL, if the
+        message is empty. Use this to navigate the frames as a list.
+        <return type = "zframe" />
+    </method>
+
+    <method name = "next">
+        Return the next frame. If there are no more frames, returns NULL. To move
+        to the first frame call zmsg_first(). Advances the cursor.
+        <return type = "zframe" />
+    </method>
+
+    <method name = "last">
+        Return the last frame. If there are no frames, returns NULL.
+        <return type = "zframe" />
+    </method>
+
+    <method name = "save">
+        Save message to an open file, return 0 if OK, else -1. The message is
+        saved as a series of frames, each with length and data. Note that the
+        file is NOT guaranteed to be portable between operating systems, not
+        versions of CZMQ. The file format is at present undocumented and liable
+        to arbitrary change.
+        <argument name = "file" type = "FILE" />
+        <return type = "integer" />
+    </method>
+
+    <constructor name = "load">
+        Load/append an open file into new message, return the message.
+        Returns NULL if the message could not be loaded.
+        <argument name = "file" type = "FILE" />
+    </constructor>
+
+    <method name = "encode">
+        Serialize multipart message to a single message frame. Use this method
+        to send structured messages across transports that do not support
+        multipart data. Allocates and returns a new frame containing the
+        serialized message. To decode a serialized message frame, use
+        zmsg_decode ().
+        <return type = "zframe" fresh = "1" />
+    </method>
+
+    <constructor name = "decode">
+        Decodes a serialized message frame created by zmsg_encode () and returns
+        a new zmsg_t object. Returns NULL if the frame was badly formatted or
+        there was insufficient memory to work.
+        <argument name = "frame" type = "zframe" />
+    </constructor>
+
+    <method name = "dup">
+        Create copy of message, as new message object. Returns a fresh zmsg_t
+        object. If message is null, or memory was exhausted, returns null.
+        <return type = "zmsg" fresh = "1" />
+    </method>
+
+    <method name = "print">
+        Send message to zsys log sink (may be stdout, or system facility as
+        configured by zsys_set_logstream).
+    </method>
+
+    <method name = "eq">
+        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.
+        <argument name = "other" type = "zmsg" />
+        <return type = "boolean" />
+    </method>
+
+    <constructor name = "new signal">
+        Generate a signal message encoding the given status. A signal is a short
+        message carrying a 1-byte success/failure code (by convention, 0 means
+        OK). Signals are encoded to be distinguishable from "normal" messages.
+        <argument name = "status" type = "byte" />
+    </constructor>
+
+    <method name = "signal">
+        Return signal value, 0 or greater, if message is a signal, -1 if not.
+        <return type = "integer" />
+    </method>
+
+    <method name = "is" singleton = "1">
+        Probe the supplied object, and report if it looks like a zmsg_t.
+        <argument name = "self" type = "anything" />
+        <return type = "boolean" />
+    </method>
+</class>

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

@@ -0,0 +1,71 @@
+<class name = "zpoller" 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/.
+    -->
+    event-driven reactor
+
+    <constructor>
+        Create new poller, specifying zero or more readers. The list of
+        readers ends in a NULL. Each reader can be a zsock_t instance, a
+        zactor_t instance, a libzmq socket (void *), or a file handle.
+        <argument name = "reader" type = "sockish" variadic = "1" />
+    </constructor>
+
+    <destructor>
+        Destroy a poller
+    </destructor>
+
+    <method name = "add">
+        Add a reader to be polled. Returns 0 if OK, -1 on failure. The reader may
+        be a libzmq void * socket, a zsock_t instance, or a zactor_t instance.
+        <argument name = "reader" type = "sockish" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "remove">
+        Remove a reader from the poller; returns 0 if OK, -1 on failure. The reader
+        must have been passed during construction, or in an zpoller_add () call.
+        <argument name = "reader" type = "anything" />
+        <return type = "integer" />
+    </method>
+
+    <method name = "set nonstop" >
+        By default the poller stops if the process receives a SIGINT or SIGTERM
+        signal. This makes it impossible to shut-down message based architectures
+        like zactors. This method lets you switch off break handling. The default
+        nonstop setting is off (false).
+        <argument name = "nonstop" type = "boolean" />
+    </method>
+
+    <method name = "wait">
+        Poll the registered readers for I/O, return first reader that has input.
+        The reader will be a libzmq void * socket, or a zsock_t or zactor_t
+        instance as specified in zpoller_new/zpoller_add. The timeout should be
+        zero or greater, or -1 to wait indefinitely. Socket priority is defined
+        by their order in the poll list. If you need a balanced poll, use the low
+        level zmq_poll method directly. If the poll call was interrupted (SIGINT),
+        or the ZMQ context was destroyed, or the timeout expired, returns NULL.
+        You can test the actual exit condition by calling zpoller_expired () and
+        zpoller_terminated (). The timeout is in msec.
+        <argument name = "timeout" type = "integer" />
+        <return type = "sockish" />
+    </method>
+
+    <method name = "expired">
+        Return true if the last zpoller_wait () call ended because the timeout
+        expired, without any error.
+        <return type = "boolean" />
+    </method>
+
+    <method name = "terminated">
+        Return true if the last zpoller_wait () call ended because the process
+        was interrupted, or the parent context was destroyed.
+        <return type = "boolean" />
+    </method>
+</class>