zmq_init.txt 1.06 KB
Newer Older
1 2 3 4 5 6
zmq_init(3)
===========


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_init - initialise 0MQ context
8 9 10 11


SYNOPSIS
--------
12
*void *zmq_init (int 'io_threads');*
13 14 15 16


DESCRIPTION
-----------
17
The _zmq_init()_ function initialises a 0MQ 'context'.
Martin Lucina's avatar
Martin Lucina committed
18 19

The 'io_threads' argument specifies the size of the 0MQ thread pool to handle
20 21
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.
22

23 24 25 26 27
.Thread safety
A 0MQ 'context' is thread safe and may be shared among as many application
threads as necessary, without any additional locking required on the part of
the caller.

28 29 30

RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
31 32 33
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.
34 35 36 37 38


ERRORS
------
*EINVAL*::
39
An invalid number of 'io_threads' was requested.
40 41 42 43


SEE ALSO
--------
Martin Lucina's avatar
Martin Lucina committed
44
linkzmq:zmq[7]
45 46 47
linkzmq:zmq_term[3]


48 49 50 51
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.