libzmq/doc/zmq_init.txt

53 lines
1.1 KiB
Plaintext
Raw Normal View History

2010-02-10 16:18:46 +01:00
zmq_init(3)
===========
NAME
----
2010-03-09 18:47:31 +01:00
zmq_init - initialise 0MQ context
2010-02-10 16:18:46 +01:00
SYNOPSIS
--------
*void *zmq_init (int 'io_threads');*
2010-02-10 16:18:46 +01:00
DESCRIPTION
-----------
The _zmq_init()_ function initialises a 0MQ 'context'.
2010-03-09 18:47:31 +01:00
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.
2010-02-10 16:18:46 +01:00
.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.
This function is deprecated by linkzmq:zmq_ctx_new[3].
2010-02-10 16:18:46 +01:00
RETURN VALUE
------------
2010-03-09 18:47:31 +01:00
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.
2010-02-10 16:18:46 +01:00
ERRORS
------
*EINVAL*::
An invalid number of 'io_threads' was requested.
2010-02-10 16:18:46 +01:00
SEE ALSO
--------
2010-03-09 18:47:31 +01:00
linkzmq:zmq[7]
2010-02-10 16:18:46 +01:00
linkzmq:zmq_term[3]
AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.