mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-26 23:01:04 +08:00
b6ca9b2983
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
80 lines
2.5 KiB
Plaintext
80 lines
2.5 KiB
Plaintext
= zmq_ctx_set_ext(3)
|
|
|
|
|
|
== NAME
|
|
|
|
zmq_ctx_set_ext - set extended context options
|
|
|
|
|
|
== SYNOPSIS
|
|
*int zmq_ctx_set_ext (void '*context', int 'option_name', const void '*option_value', size_t 'option_len');*
|
|
|
|
|
|
== DESCRIPTION
|
|
|
|
The _zmq_ctx_set_ext()_ function shall set the option specified by the
|
|
'option_name' argument to the value pointed to by the 'option_value' argument
|
|
for the 0MQ context pointed to by the 'context' argument. The 'option_len'
|
|
argument is the size of the option value in bytes. For options taking a value of
|
|
type "character string", the provided byte data should either contain no zero
|
|
bytes, or end in a single zero byte (terminating ASCII NUL character).
|
|
|
|
The _zmq_ctx_set_ext()_ function accepts all the option names accepted by
|
|
_zmq_ctx_set()_.
|
|
Options that make most sense to set using _zmq_ctx_set_ext()_ instead of
|
|
_zmq_ctx_set()_ are the following options:
|
|
|
|
ZMQ_THREAD_NAME_PREFIX: Set name prefix for I/O threads
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
The 'ZMQ_THREAD_NAME_PREFIX' argument sets a string prefix to each thread
|
|
created for the internal context's thread pool. This option is only supported on Linux.
|
|
This option is useful to help debugging done via "top -H" or "gdb"; in case
|
|
multiple processes on the system are using ZeroMQ it is useful to provide through
|
|
this context option an application-specific prefix to distinguish ZeroMQ background
|
|
threads that belong to different processes.
|
|
This option only applies before creating any sockets on the context.
|
|
|
|
[horizontal]
|
|
Option value type:: character string
|
|
Option value unit:: N/A
|
|
Default value:: empty string
|
|
|
|
|
|
== RETURN VALUE
|
|
The _zmq_ctx_set_ext()_ function returns zero 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.
|
|
*EFAULT*::
|
|
The provided 'context' is invalid.
|
|
|
|
|
|
== EXAMPLE
|
|
.Setting a prefix on internal ZMQ thread names:
|
|
----
|
|
void *context = zmq_ctx_new ();
|
|
const char prefix[] = "MyApp";
|
|
size_t prefixLen = sizeof(prefix);
|
|
zmq_ctx_set (context, ZMQ_THREAD_NAME_PREFIX, &prefix, &prefixLen);
|
|
|
|
char buff[256];
|
|
size_t buffLen = sizeof(buff);
|
|
int rc = zmq_ctx_get (context, ZMQ_THREAD_NAME_PREFIX, &buff, &buffLen);
|
|
assert (rc == 0);
|
|
assert (buffLen == prefixLen);
|
|
|
|
----
|
|
|
|
|
|
== SEE ALSO
|
|
xref:zmq_ctx_set.adoc[zmq_ctx_set]
|
|
xref:zmq.adoc[zmq]
|
|
|
|
|
|
== 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>.
|