generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-12 10:33:52 +01:00
Code Issues Projects Releases Wiki Activity
b480457283
libzmq/doc/zmq_ctx_get.txt

98 lines
2.3 KiB
Plaintext
Raw Normal View History

Fixed issues #337, #341, and #340 * Implemented new ctx API (_new, _destroy, _get, _set) * Removed 'typesafe' macros from zmq.h * Added support for MAX_SOCKETS (was tied into change for #337) * Created new man pages
2012-03-20 01:41:20 +01:00
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.
Problem: test_large_msg kills my system temporarily And I'm on a reasonably sized laptop. I think allocating INT_MAX memory is dangerous in a test case. Solution: expose this as a context option. I've used ZMQ_MAX_MSGSZ and documented it and implemented the API. However I don't know how to get the parent context for a socket, so the code in zmq.cpp is still unfinished.
2016-02-09 10:51:51 +01:00
Fixed issue #500
2013-01-31 21:52:30 +01:00
ZMQ_MAX_SOCKETS: Get maximum number of sockets
Fixed issues #337, #341, and #340 * Implemented new ctx API (_new, _destroy, _get, _set) * Removed 'typesafe' macros from zmq.h * Added support for MAX_SOCKETS (was tied into change for #337) * Created new man pages
2012-03-20 01:41:20 +01:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_MAX_SOCKETS' argument returns the maximum number of sockets
allowed for this context.
Problem: test_large_msg kills my system temporarily And I'm on a reasonably sized laptop. I think allocating INT_MAX memory is dangerous in a test case. Solution: expose this as a context option. I've used ZMQ_MAX_MSGSZ and documented it and implemented the API. However I don't know how to get the parent context for a socket, so the code in zmq.cpp is still unfinished.
2016-02-09 10:51:51 +01:00
ZMQ_MAX_MSGSZ: Get maximum message size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_MAX_MSGSZ' argument returns the maximum size of a message
allowed for this context. Default value is INT_MAX.
Rename ZMQ_MAX_SOCKETS_MAX to ZMQ_SOCKET_LIMIT As per suggestion by Pieter Hintjens. Also update wording in zmq_ctx_set manual a bit.
2014-02-14 10:09:19 +01:00
ZMQ_SOCKET_LIMIT: Get largest configurable number of sockets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_SOCKET_LIMIT' argument returns the largest number of sockets that
linkzmq:zmq_ctx_set[3] will accept.
Add ZMQ_MAX_SOCKETS_MAX to zmq_ctx_get() The new options allows querying the maximum allowed number of sockets. This is system dependent and cannot be encoded in the include file as a preprocessor macro: for ZMQ_USE_SELECT, this depends on the FD_SETSIZE macro at time of library compilation, not at time of include file use.
2014-02-13 15:54:06 +01:00
Problem: test_large_msg kills my system temporarily And I'm on a reasonably sized laptop. I think allocating INT_MAX memory is dangerous in a test case. Solution: expose this as a context option. I've used ZMQ_MAX_MSGSZ and documented it and implemented the API. However I don't know how to get the parent context for a socket, so the code in zmq.cpp is still unfinished.
2016-02-09 10:51:51 +01:00
Fixed issue #500
2013-01-31 21:52:30 +01:00
ZMQ_IPV6: Set IPv6 option
~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_IPV6' argument returns the IPv6 option for the context.
Problem: test_large_msg kills my system temporarily And I'm on a reasonably sized laptop. I think allocating INT_MAX memory is dangerous in a test case. Solution: expose this as a context option. I've used ZMQ_MAX_MSGSZ and documented it and implemented the API. However I don't know how to get the parent context for a socket, so the code in zmq.cpp is still unfinished.
2016-02-09 10:51:51 +01:00
Problem: linger values other than -1 or 0 are unsafe Solution: set defaults back to infinity, and add new context option, ZMQ_BLOCKY that the user can set to false to get a less surprising behavior on context termination. Eg. zmq_ctx_set (ctx, ZMQ_BLOCKY, false);
2014-11-17 11:56:59 +01:00
ZMQ_BLOCKY: Get blocky setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_BLOCKY' argument returns 1 if the context will block on terminate,
zero if the "block forever on context termination" gambit was disabled by
setting ZMQ_BLOCKY to false on all new contexts.
Fixed issues #337, #341, and #340 * Implemented new ctx API (_new, _destroy, _get, _set) * Removed 'typesafe' macros from zmq.h * Added support for MAX_SOCKETS (was tied into change for #337) * Created new man pages
2012-03-20 01:41:20 +01:00
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 ();
fix minor typo in zmq_ctx_get doc example
2013-10-02 09:59:44 +02:00
zmq_ctx_set (context, ZMQ_MAX_SOCKETS, 256);
Fixed issues #337, #341, and #340 * Implemented new ctx API (_new, _destroy, _get, _set) * Removed 'typesafe' macros from zmq.h * Added support for MAX_SOCKETS (was tied into change for #337) * Created new man pages
2012-03-20 01:41:20 +01:00
int max_sockets = zmq_ctx_get (context, ZMQ_MAX_SOCKETS);
assert (max_sockets == 256);
----
Problem: linger values other than -1 or 0 are unsafe Solution: set defaults back to infinity, and add new context option, ZMQ_BLOCKY that the user can set to false to get a less surprising behavior on context termination. Eg. zmq_ctx_set (ctx, ZMQ_BLOCKY, false);
2014-11-17 11:56:59 +01:00
.Switching off the context deadlock gambit
----
zmq_ctx_set (ctx, ZMQ_BLOCKY, false);
----
Fixed issues #337, #341, and #340 * Implemented new ctx API (_new, _destroy, _get, _set) * Removed 'typesafe' macros from zmq.h * Added support for MAX_SOCKETS (was tied into change for #337) * Created new man pages
2012-03-20 01:41:20 +01:00
SEE ALSO
--------
linkzmq:zmq_ctx_set[3]
linkzmq:zmq[7]
AUTHORS
-------
Use of named authors on man pages is no longer a good idea since it puts off contributors and doesn't reflect the real process. I've taken out all named authors and referred to the contribution policy. Hopefully this will improve the contributions to the man pages.
2013-04-11 18:53:02 +02:00
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>.
Reference in New Issue Copy Permalink