diff options
Diffstat (limited to 'doc/zmq_init.txt')
| -rw-r--r-- | doc/zmq_init.txt | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/zmq_init.txt b/doc/zmq_init.txt new file mode 100644 index 0000000..04bbbc8 --- /dev/null +++ b/doc/zmq_init.txt @@ -0,0 +1,46 @@ +zmq_init(3) +=========== + + +NAME +---- +zmq_init - initialise 0MQ context + + +SYNOPSIS +-------- +*void *zmq_init (int 'io_threads');* + + +DESCRIPTION +----------- +The _zmq_init()_ function initialises a 0MQ 'context'. + +The 'io_threads' argument specifies the size of the 0MQ thread pool to handle +I/O operations. If your application is using only the 'inproc' transport for +messaging you may set this to zero, otherwise set it to at least one. + + +RETURN VALUE +------------ +The _zmq_init()_ function shall return an opaque handle to the initialised +'context' if successful. Otherwise it shall return NULL and set 'errno' to one +of the values defined below. + + +ERRORS +------ +*EINVAL*:: +An invalid number of 'io_threads' was requested. + + +SEE ALSO +-------- +linkzmq:zmq[7] +linkzmq:zmq_term[3] + + +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and +Martin Lucina <mato@kotelna.sk>. |