diff options
Diffstat (limited to 'doc/zmq_getsockopt.txt')
| -rw-r--r-- | doc/zmq_getsockopt.txt | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 318d12e..f08748b 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -45,12 +45,16 @@ Applicable socket types:: all ZMQ_HWM: Retrieve high water mark ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The 'ZMQ_HWM' option shall retrieve the high water mark for the _message queue_ -associated with the specified 'socket'. The high water mark is a hard limit on -the number of outstanding messages in the queue; if this limit has been reached -the socket shall enter an "emergency" state and depending on the socket type, -0MQ shall take appropriate action such as blocking or dropping new messages -entering the queue. +The 'ZMQ_HWM' option shall retrieve the high water mark for the specified +'socket'. The high water mark is a hard limit on the maximum number of +outstanding messages 0MQ shall queue in memory for any single peer that the +specified 'socket' is communicating with. + +If this limit has been reached the socket shall enter an exceptional state and +depending on the socket type, 0MQ shall take appropriate action such as +blocking or dropping sent messages. Refer to the individual socket descriptions +in linkzmq:zmq_socket[3] for details on the exact action taken for each socket +type. The default 'ZMQ_HWM' value of zero means "no limit". @@ -63,10 +67,9 @@ Applicable socket types:: all ZMQ_SWAP: Retrieve disk offload size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_SWAP' option shall retrieve the disk offload (swap) size for the -_message queue_ associated with the specified 'socket'. A socket which has -'ZMQ_SWAP' set to a non-zero value may exceed it's high water mark; in this -case outstanding messages shall be offloaded to storage on disk rather than -held in memory. +specified 'socket'. A socket which has 'ZMQ_SWAP' set to a non-zero value may +exceed it's high water mark; in this case outstanding messages shall be +offloaded to storage on disk rather than held in memory. The value of 'ZMQ_SWAP' defines the maximum size of the swap space in bytes. |