From eb9ff1e77977c6199c0a0439f4dd35fa39f3bd3c Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Mon, 31 May 2010 14:12:27 +0200 Subject: Documentation updates Multi-part messages --- doc/zmq_getsockopt.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'doc/zmq_getsockopt.txt') diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 13243ec..4aef71c 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -24,6 +24,23 @@ to by 'option_value'. The following options can be retrieved with the _zmq_getsockopt()_ function: +ZMQ_RCVMORE: More message parts to follow +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The 'ZMQ_RCVMORE' option shall return a boolean value indicating if the +multi-part message currently being read from the specified 'socket' has more +message parts to follow. If there are no message parts to follow or if the +message currently being read is not a multi-part message a value of zero shall +be returned. Otherwise, a value of 1 shall be returned. + +Refer to linkzmq:zmq_send[3] and linkzmq:zmq_recv[3] for a detailed description +of sending/receiving multi-part messages. + +Option value type:: int64_t +Option value unit:: boolean +Default value:: N/A +Applicable socket types:: all + + ZMQ_HWM: Retrieve high water mark ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The 'ZMQ_HWM' option shall retrieve the high water mark for the _message queue_ -- cgit v1.2.3