diff options
| author | Martin Sustrik <sustrik@250bpm.com> | 2012-03-13 11:10:33 +0100 |
|---|---|---|
| committer | Martin Sustrik <sustrik@250bpm.com> | 2012-03-13 11:10:33 +0100 |
| commit | 921da22147e201455837bcd38df1af33aceff26f (patch) | |
| tree | e76e001ac65d4fa96ab89468e109db05978b7f70 /doc | |
| parent | 224b7c7a816010fc0f781372051ec7c578af42a0 (diff) | |
io_threads argument removed from xs_init()
The argument was changed to a context option (XS_IO_THREADS).
0MQ compatibility mode sets the option and ensures that
there's at least one I/O thread present.
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/xs_init.txt | 9 | ||||
| -rw-r--r-- | doc/xs_setctxopt.txt | 10 |
2 files changed, 12 insertions, 7 deletions
diff --git a/doc/xs_init.txt b/doc/xs_init.txt index e642824..373822a 100644 --- a/doc/xs_init.txt +++ b/doc/xs_init.txt @@ -9,17 +9,13 @@ xs_init - initialise Crossroads context SYNOPSIS -------- -*void *xs_init (int 'io_threads');* +*void *xs_init ();* DESCRIPTION ----------- The _xs_init()_ function initialises a Crossroads 'context'. -The 'io_threads' argument specifies the size of the 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. - .Thread safety A 'context' is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of @@ -35,8 +31,7 @@ of the values defined below. ERRORS ------ -*EINVAL*:: -An invalid number of 'io_threads' was requested. +No error values are defined. SEE ALSO diff --git a/doc/xs_setctxopt.txt b/doc/xs_setctxopt.txt index dded922..d26d319 100644 --- a/doc/xs_setctxopt.txt +++ b/doc/xs_setctxopt.txt @@ -34,6 +34,16 @@ Option value type:: int Option value unit:: sockets Default value:: 512 +XS_IO_THREADS: Set number of worker threads +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'XS_IO_THREADS' option shall set specify the size of the thread pool to +handle I/O operations. The value should be at least 1. + +[horizontal] +Option value type:: int +Option value unit:: threads +Default value:: 1 + RETURN VALUE ------------ The _xs_setctxopt()_ function shall return zero if successful. Otherwise it |