summaryrefslogtreecommitdiff
path: root/man/man3/zmq_init.3
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-02-10 16:18:46 +0100
committerMartin Lucina <mato@kotelna.sk>2010-02-10 16:18:46 +0100
commit354efc513fdb4096f8830e6c2e3e8f1311303e61 (patch)
treec8dec6949c70e6f41832e42326594ebb889b1ee2 /man/man3/zmq_init.3
parent2d44bf3644c8e12aa86c48e9da4df19bfa9ea703 (diff)
Convert documentation to AsciiDoc
Diffstat (limited to 'man/man3/zmq_init.3')
-rw-r--r--man/man3/zmq_init.340
1 files changed, 0 insertions, 40 deletions
diff --git a/man/man3/zmq_init.3 b/man/man3/zmq_init.3
deleted file mode 100644
index 6b5e75f..0000000
--- a/man/man3/zmq_init.3
+++ /dev/null
@@ -1,40 +0,0 @@
-.TH zmq_init 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
-.SH NAME
-zmq_init \- initialises 0MQ context
-.SH SYNOPSIS
-.B void *zmq_init (int app_threads, int io_threads, int flags);
-.SH DESCRIPTION
-Initialises 0MQ context.
-.IR app_threads
-specifies maximal number of application threads that can own open sockets
-at the same time. At least one application thread should be defined.
-.IR io_threads
-specifies the size of thread pool to handle I/O operations. The value shouldn't
-be negative. Zero can be used in case only in-process messaging is going to be
-used, i.e. there will be no I/O traffic.
-
-.IR flags
-argument is a combination of the flags defined below:
-.IP "\fBZMQ_POLL\fP"
-flag specifying that the sockets within this context should be pollable (see
-.IR zmq_poll
-). Pollable sockets may add a little latency to the message transfer when
-compared to non-pollable sockets.
-
-.SH RETURN VALUE
-Function returns context handle is successful. Otherwise it returns NULL and
-sets errno to one of the values below.
-.SH ERRORS
-.IP "\fBEINVAL\fP"
-there's less than one application thread allocated, or number of I/O threads
-is negative.
-.SH EXAMPLE
-.nf
-void *ctx = zmq_init (1, 1, ZMQ_POLL);
-assert (ctx);
-.fi
-.SH SEE ALSO
-.BR zmq_term (3)
-.BR zmq_socket (3)
-.SH AUTHOR
-Martin Sustrik <sustrik at 250bpm dot com>