Skip to content

Commit

Permalink
Clarified that SNDHWM is per part, not message
Browse files Browse the repository at this point in the history
  • Loading branch information
hintjens committed Nov 19, 2012
1 parent 01b9bc3 commit 7533ebb
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions doc/zmq_setsockopt.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,19 @@ 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
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
Expand Down

0 comments on commit 7533ebb

Please sign in to comment.