Skip to content

L
libzmq
Commit 7362f3af authored by Juha Reunanen's avatar Juha Reunanen
Browse files
Options

update documentation regarding the rcvbuf parameter

parent 8096990e
Hide whitespace changes
Inline Side-by-side
Showing with 4 additions and 6 deletions
doc/zmq_getsockopt.txt
View file @ 7362f3af
...@@ -450,14 +450,12 @@ Applicable socket types:: all, when using multicast transports ...@@ -450,14 +450,12 @@ Applicable socket types:: all, when using multicast transports
ZMQ_RCVBUF: Retrieve kernel receive buffer size ZMQ_RCVBUF: Retrieve kernel receive buffer size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_RCVBUF' option shall retrieve the underlying kernel receive buffer The 'ZMQ_RCVBUF' option shall retrieve the underlying kernel receive 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_RCVBUF' socket option.
'SO_RCVBUF' 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
......
doc/zmq_setsockopt.txt
View file @ 7362f3af
...@@ -469,14 +469,14 @@ Applicable socket types:: all, when using multicast transports ...@@ -469,14 +469,14 @@ Applicable socket types:: all, when using multicast transports
ZMQ_RCVBUF: Set kernel receive buffer size ZMQ_RCVBUF: Set kernel receive buffer size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_RCVBUF' option shall set the underlying kernel receive buffer size for The 'ZMQ_RCVBUF' option shall set the underlying kernel receive buffer size for
the 'socket' to the specified size in bytes. A value of zero means leave the the 'socket' to the specified size in bytes. A value of -1 means leave the
OS default unchanged. For details refer to your operating system documentation OS default unchanged. For details refer to your operating system documentation
for the 'SO_RCVBUF' socket option. for the 'SO_RCVBUF' 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