From bc4a1ce3345f4e5904e4b13c618f90def21256a5 Mon Sep 17 00:00:00 2001 From: Martin Sustrik Date: Thu, 24 Mar 2011 16:47:33 +0100 Subject: ZMQ_HWM split into ZMQ_SNDHWM and ZMQ_RCVHWM These new options allow to control the maximum size of the inbound and outbound message pipe separately. Signed-off-by: Martin Sustrik --- doc/zmq_setsockopt.txt | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) (limited to 'doc/zmq_setsockopt.txt') diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index b16bab4..48afbfc 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -25,12 +25,12 @@ argument is the size of the option value in bytes. The following socket options can be set with the _zmq_setsockopt()_ function: -ZMQ_HWM: Set high water mark -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The 'ZMQ_HWM' option shall set 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. +ZMQ_SNDHWM: Set high water mark for outbound messages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_SNDHWM' option shall set the high water mark for outbound messages on +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 @@ -38,7 +38,29 @@ 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". +The default 'ZMQ_SNDHWM' value of zero means "no limit". + +[horizontal] +Option value type:: int +Option value unit:: messages +Default value:: 0 +Applicable socket types:: all + + +ZMQ_RCVHWM: Set high water mark for inbound messages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_RCVHWM' option shall set the high water mark for inbound messages on +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_RCVHWM' value of zero means "no limit". [horizontal] Option value type:: int -- cgit v1.2.3