Commit 8096990e authored by Juha Reunanen's avatar Juha Reunanen

update documentation regarding the sndbuf and rcvbuf parameters

parent f7b933f5
...@@ -566,14 +566,12 @@ Applicable socket types:: all, when using multicast transports ...@@ -566,14 +566,12 @@ Applicable socket types:: all, when using multicast transports
ZMQ_SNDBUF: Retrieve kernel transmit buffer size ZMQ_SNDBUF: Retrieve kernel transmit buffer size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_SNDBUF' option shall retrieve the underlying kernel transmit buffer The 'ZMQ_SNDBUF' option shall retrieve the underlying kernel transmit buffer
size for the specified 'socket'. A value of zero means that the OS default is size for the specified 'socket'. For details refer to your operating system
in effect. For details refer to your operating system documentation for the documentation for the 'SO_SNDBUF' socket option.
'SO_SNDBUF' socket option.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: bytes Option value unit:: bytes
Default value:: 0
Applicable socket types:: all Applicable socket types:: all
......
...@@ -660,14 +660,14 @@ Applicable socket types:: ZMQ_ROUTER ...@@ -660,14 +660,14 @@ Applicable socket types:: ZMQ_ROUTER
ZMQ_SNDBUF: Set kernel transmit buffer size ZMQ_SNDBUF: Set kernel transmit buffer size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_SNDBUF' option shall set the underlying kernel transmit buffer size The 'ZMQ_SNDBUF' option shall set the underlying kernel transmit buffer size
for the 'socket' to the specified size in bytes. A value of zero means leave for the 'socket' to the specified size in bytes. A value of -1 means leave
the OS default unchanged. For details please refer to your operating system the OS default unchanged. For details please refer to your operating system
documentation for the 'SO_SNDBUF' socket option. documentation for the 'SO_SNDBUF' socket option.
[horizontal] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: bytes Option value unit:: bytes
Default value:: 0 Default value:: -1
Applicable socket types:: all Applicable socket types:: all
......
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