summaryrefslogtreecommitdiff
path: root/doc/zmq.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq.txt')
-rw-r--r--doc/zmq.txt121
1 files changed, 0 insertions, 121 deletions
diff --git a/doc/zmq.txt b/doc/zmq.txt
deleted file mode 100644
index f1e1abf..0000000
--- a/doc/zmq.txt
+++ /dev/null
@@ -1,121 +0,0 @@
-zmq(7)
-======
-
-
-NAME
-----
-zmq - Crossroads I/O ZeroMQ compatibility library
-
-
-SYNOPSIS
---------
-*#include <zmq.h>*
-
-*cc* ['flags'] 'files' *-lzmq* ['libraries']
-
-
-DESCRIPTION
------------
-This 'libzmq' compatibility library is provided by the Crossroads I/O project
-as a transitional drop-in replacement for existing applications and language
-bindings written for the ZeroMQ library.
-
-The interfaces provided emulate those provided by ZeroMQ release 2.1.11, and
-binary compatibility is provided for ABI version 1.0.0.
-
-Existing applications can use these interfaces as a drop-in replacement for the
-ZeroMQ-provided 'libzmq' by installing the Crossroads version of this library
-in its place.
-
-Applications can also be recompiled against this library with no code or build
-system changes.
-
-IMPORTANT: The 'libzmq' compatibility library is an optional component of
-the Crossroads project, intended as a way to ease transition of existing
-applications and language bindings to the native 'libxs' interfaces, this
-feature will not be maintained indefinitely, hence developers are strongly
-encouraged to migrate their applications to 'libxs'.
-
-CONSTANTS
----------
-
-All constants defined by the ZeroMQ 2.1.11 version of *<zmq.h>* are also
-defined in the Crossroads version.
-
-INTERFACES
-----------
-
-Context
-~~~~~~~
-[verse]
-*void *zmq_init (int 'io_threads');*
-*int zmq_term (void '*context');*
-
-
-Sockets
-~~~~~~~
-[verse]
-*void *zmq_socket (void '*context', int 'type');*
-*int zmq_close (void '*socket');*
-*int zmq_connect (void '*socket', const char '*endpoint');*
-*int zmq_bind (void '*socket', const char '*endpoint');*
-*int zmq_setsockopt (void '*socket', int 'option_name', const void '*option_value', size_t 'option_len');*
-*int zmq_getsockopt (void '*socket', int 'option_name', void '*option_value', size_t '*option_len');*
-*int zmq_poll (zmq_pollitem_t '*items', int 'nitems', long 'timeout');*
-
-
-Messages
-~~~~~~~~
-[verse]
-*int zmq_msg_init (zmq_msg_t '*msg');*
-*int zmq_msg_init_size (zmq_msg_t '*msg', size_t 'size');*
-*int zmq_msg_init_data (zmq_msg_t '*msg', void '*data', size_t 'size', zmq_free_fn '*ffn', void '*hint');*
-*int zmq_msg_close (zmq_msg_t '*msg');*
-*int zmq_msg_copy (zmq_msg_t '*dest', zmq_msg_t '*src');*
-*int zmq_msg_move (zmq_msg_t '*dest', zmq_msg_t '*src');*
-
-
-Sending and receiving
-~~~~~~~~~~~~~~~~~~~~~
-[verse]
-*int zmq_send (void '*socket', zmq_msg_t '*msg', int 'flags');*
-*int zmq_recv (void '*socket', zmq_msg_t '*msg', int 'flags');*
-
-
-Devices
-~~~~~~~
-[verse]
-*int zmq_device (int 'device', const void '*frontend', const void '*backend');*
-
-
-Error handling
-~~~~~~~~~~~~~~
-[verse]
-*int zmq_errno (void);*
-*const char *zmq_strerror (int 'errnum');*
-
-
-Version detection
-~~~~~~~~~~~~~~~~~
-[verse]
-*void zmq_version (int '*major', int '*minor', int '*patch');*
-
-NOTE: The version numbers returned by this function are the emulated ZeroMQ API
-version, i.e. 2.1.11.
-
-
-COPYING
--------
-Free use of Crossroads library is granted under the terms of the GNU Lesser
-General Public License (LGPL). For details see the files `COPYING` and
-`COPYING.LESSER` included with the Crossroads distribution.
-
-SEE ALSO
---------
-linkxs:xs[7]
-
-
-AUTHORS
--------
-The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com>
-and Martin Lucina <martin@lucina.net>.