From da6cf6385763c6f01fbf3d7104b560d154df6521 Mon Sep 17 00:00:00 2001 From: Goswin von Brederlow Date: Thu, 7 Aug 2014 13:16:12 +0200 Subject: [PATCH] Document altered HWM behaviour when ZMQ_ROUTER_MANDATORY is set. --- doc/zmq_setsockopt.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index d3214c96..ce8db3b3 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -644,8 +644,11 @@ ZMQ_ROUTER_MANDATORY: accept only routable messages on ROUTER sockets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Sets the ROUTER socket behavior when an unroutable message is encountered. A value of `0` is the default and discards the message silently when it cannot be -routed. A value of `1` returns an 'EHOSTUNREACH' error code if the message -cannot be routed. +routed or the peers SNDHWM is reached. A value of `1` returns an +'EHOSTUNREACH' error code if the message cannot be routed or 'EAGAIN' error +code if the SNDHWM is reached and ZMQ_DONTWAIT was used. Without ZMQ_DONTWAIT +it will block until the SNDTIMEO is reached or a spot in the send queue opens +up. [horizontal] Option value type:: int