From 7533ebb33d1cc6f23061e0228bf7eb22713aaa17 Mon Sep 17 00:00:00 2001 From: Pieter Hintjens Date: Mon, 19 Nov 2012 10:20:56 +0900 Subject: [PATCH] Clarified that SNDHWM is per part, not message --- doc/zmq_setsockopt.txt | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index e4f51368..cea92a08 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -30,8 +30,8 @@ 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. +number of outstanding message parts 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 @@ -39,6 +39,10 @@ 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. +NOTE: The high-water mark is measured in individual message parts, including +any delimiter and identity parts. When setting 'ZMQ_SNDHWM' on a 'ZMQ_ROUTER' +socket, note that a message always has at least two parts. + [horizontal] Option value type:: int Option value unit:: messages