diff options
Diffstat (limited to 'doc/zmq_ctx_get.txt')
| -rw-r--r-- | doc/zmq_ctx_get.txt | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/zmq_ctx_get.txt b/doc/zmq_ctx_get.txt new file mode 100644 index 0000000..980a2a9 --- /dev/null +++ b/doc/zmq_ctx_get.txt @@ -0,0 +1,72 @@ +zmq_ctx_get(3) +============== + + +NAME +---- + +zmq_ctx_get - get context options + + +SYNOPSIS +-------- +*int zmq_ctx_get (void '*context', int 'option_name');* + + +DESCRIPTION +----------- +The _zmq_ctx_get()_ function shall return the option specified by the +'option_name' argument. + +The _zmq_ctx_get()_ function accepts the following option names: + + +ZMQ_IO_THREADS: Get number of I/O threads +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_IO_THREADS' argument returns the size of the 0MQ thread pool +for this context. + +ZMQ_MAX_SOCKETS: Get maximum number of sockets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_MAX_SOCKETS' argument returns the maximum number of sockets +allowed for this context. + +ZMQ_IPV6: Set IPv6 option +~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_IPV6' argument returns the IPv6 option for the context. + + +RETURN VALUE +------------ +The _zmq_ctx_get()_ function returns a value of 0 or greater if successful. +Otherwise it returns `-1` and sets 'errno' to one of the values defined +below. + + +ERRORS +------ +*EINVAL*:: +The requested option _option_name_ is unknown. + + +EXAMPLE +------- +.Setting a limit on the number of sockets +---- +void *context = zmq_ctx_new (); +zmq_ctx_set (context, ZMQ_MAX_SOCKETS, 256); +int max_sockets = zmq_ctx_get (context, ZMQ_MAX_SOCKETS); +assert (max_sockets == 256); +---- + + +SEE ALSO +-------- +linkzmq:zmq_ctx_set[3] +linkzmq:zmq[7] + + +AUTHORS +------- +This page was written by the 0MQ community. To make a change please +read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>. |