Commit eba6fb29 authored by Luca Boccassi's avatar Luca Boccassi

Problem: ZMQ_IN/OUT_BATCH_SIZE are dangerous

Solution: clearly advise users to avoid them in all cases to
avoid unforseen problems.
Also fix markdown syntax, applicable transport types and getter description.
parent a43c842e
...@@ -924,9 +924,8 @@ Applicable socket types:: ZMQ_ROUTER ...@@ -924,9 +924,8 @@ Applicable socket types:: ZMQ_ROUTER
ZMQ_IN_BATCH_SIZE: Maximal receive batch size ZMQ_IN_BATCH_SIZE: Maximal receive batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be received in a single Gets 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 'recv' system call.
latency and vice-versa.
Cannot be zero. Cannot be zero.
...@@ -936,14 +935,13 @@ NOTE: in DRAFT state, not yet available in stable releases. ...@@ -936,14 +935,13 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int Option value type:: int
Option value unit:: messages Option value unit:: messages
Default value:: 8192 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 ZMQ_OUT_BATCH_SIZE: Maximal send batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be sent in a single Gets 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 'send' system call.
latency and vice-versa.
Cannot be zero. Cannot be zero.
...@@ -953,7 +951,7 @@ NOTE: in DRAFT state, not yet available in stable releases. ...@@ -953,7 +951,7 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int Option value type:: int
Option value unit:: messages Option value unit:: messages
Default value:: 8192 Default value:: 8192
Applicable socket types:: All Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.
......
...@@ -1363,10 +1363,12 @@ Applicable socket types:: ZMQ_ROUTER ...@@ -1363,10 +1363,12 @@ Applicable socket types:: ZMQ_ROUTER
ZMQ_IN_BATCH_SIZE: Maximal receive batch size ZMQ_IN_BATCH_SIZE: Maximal receive batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be received in a single 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 'recv' system call. WARNING: this option should almost never be changed.
latency and vice-versa. 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. Cannot be zero.
...@@ -1376,14 +1378,16 @@ NOTE: in DRAFT state, not yet available in stable releases. ...@@ -1376,14 +1378,16 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int Option value type:: int
Option value unit:: messages Option value unit:: messages
Default value:: 8192 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 ZMQ_OUT_BATCH_SIZE: Maximal send batch size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the maximal amount of messages that can be sent in a single 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 'send' system call. WARNING: this option should almost never be changed.
latency and vice-versa. 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. Cannot be zero.
...@@ -1393,7 +1397,7 @@ NOTE: in DRAFT state, not yet available in stable releases. ...@@ -1393,7 +1397,7 @@ NOTE: in DRAFT state, not yet available in stable releases.
Option value type:: int Option value type:: int
Option value unit:: messages Option value unit:: messages
Default value:: 8192 Default value:: 8192
Applicable socket types:: All Applicable socket types:: All, when using TCP, IPC, PGM or NORM transport.
RETURN VALUE RETURN VALUE
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment