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

Problem: ZMQ_IN/OUT_BATCH_SIZE are dangerous

Browse Source 
Solution: clearly advise users to avoid them in all cases to
avoid unforseen problems.
Also fix markdown syntax, applicable transport types and getter description.
This commit is contained in:
Luca Boccassi 2019-06-27 18:05:22 +01:00
parent a43c842e0d
commit eba6fb2988
2 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/zmq_getsockopt.txt
View File

@ -924,9 +924,8 @@ Applicable socket types:: ZMQ_ROUTER
ZMQ_IN_BATCH_SIZE: Maximal receive batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be received in a single
'recv' system call. This can be used to improved throughtput at the expense of
latency and vice-versa.
Gets the maximal amount of messages that can be received in a single
'recv' system call.
Cannot be zero.
@ -936,14 +935,13 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int
Option value unit:: messages
Default value:: 8192
Applicable socket types:: All
Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.
ZMQ_OUT_BATCH_SIZE: Maximal send batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be sent in a single
'send' system call. This can be used to improved throughtput at the expense of
latency and vice-versa.
Gets the maximal amount of messages that can be sent in a single
'send' system call.
Cannot be zero.
@ -953,7 +951,7 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int
Option value unit:: messages
Default value:: 8192
Applicable socket types:: All
Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.

20
doc/zmq_setsockopt.txt
View File

@ -1363,10 +1363,12 @@ Applicable socket types:: ZMQ_ROUTER
ZMQ_IN_BATCH_SIZE: Maximal receive batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be received in a single
'recv' system call. This can be used to improved throughtput at the expense of
latency and vice-versa.
'recv' system call. WARNING: this option should almost never be changed.
The default has been chosen to offer the best compromise between latency and
throughtput. In the vast majority of cases, changing this option will result in
worst result if not outright breakages.
Cannot be zero.
@ -1376,14 +1378,16 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int
Option value unit:: messages
Default value:: 8192
Applicable socket types:: All
Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.
ZMQ_OUT_BATCH_SIZE: Maximal send batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be sent in a single
'send' system call. This can be used to improved throughtput at the expense of
latency and vice-versa.
'send' system call. WARNING: this option should almost never be changed.
The default has been chosen to offer the best compromise between latency and
throughtput. In the vast majority of cases, changing this option will result in
worst result if not outright breakages.
Cannot be zero.
@ -1393,7 +1397,7 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int
Option value unit:: messages
Default value:: 8192
Applicable socket types:: All
Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.
RETURN VALUE