3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-03-17 16:43:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified that SNDHWM is per part, not message

Browse Source
This commit is contained in:
Pieter Hintjens 2012-11-19 10:21:46 +09:00
parent a7438de239
commit f0383bffad
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/zmq_setsockopt.txt
View File

@ -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 '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 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 number of outstanding message parts 0MQ shall queue in memory for any single
that the specified 'socket' is communicating with. peer that the specified 'socket' is communicating with.
If this limit has been reached the socket shall enter an exceptional state and 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 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 in linkzmq:zmq_socket[3] for details on the exact action taken for each socket
type. 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] [horizontal]
Option value type:: int Option value type:: int
Option value unit:: messages Option value unit:: messages