From 4a7aad06d95701cf232198093ce396dcdbb53e5b Mon Sep 17 00:00:00 2001 From: Martin Sustrik Date: Thu, 16 Feb 2012 10:01:47 +0900 Subject: ZeroMQ renamed to Crossroads Signed-off-by: Martin Sustrik --- doc/zmq_getmsgopt.txt | 85 --------------------------------------------------- 1 file changed, 85 deletions(-) delete mode 100644 doc/zmq_getmsgopt.txt (limited to 'doc/zmq_getmsgopt.txt') diff --git a/doc/zmq_getmsgopt.txt b/doc/zmq_getmsgopt.txt deleted file mode 100644 index a82c30c..0000000 --- a/doc/zmq_getmsgopt.txt +++ /dev/null @@ -1,85 +0,0 @@ -zmq_getmsgopt(3) -================ - - -NAME ----- -zmq_getmsgopt - retrieve message option - - -SYNOPSIS --------- -*int zmq_getmsgopt (zmq_msg_t '*message', int 'option_name', void '*option_value', size_t '*option_len');* - - -DESCRIPTION ------------ -The _zmq_getmsgopt()_ function shall retrieve the value for the option -specified by the 'option_name' argument for the message pointed to by the -'message' argument, and store it in the buffer pointed to by the 'option_value' -argument. The 'option_len' argument is the size in bytes of the buffer pointed -to by 'option_value'; upon successful completion _zmq_getsockopt()_ shall -modify the 'option_len' argument to indicate the actual size of the option -value stored in the buffer. - -The following options can be retrieved with the _zmq_getmsgopt()_ function: - -*ZMQ_MORE*:: -Indicates that there are more message parts to follow after the 'message'. - -RETURN VALUE ------------- -The _zmq_getmsgopt()_ function shall return zero if successful. Otherwise it -shall return `-1` and set 'errno' to one of the values defined below. - - -ERRORS ------- -*EINVAL*:: -The requested option _option_name_ is unknown, or the requested _option_size_ or -_option_value_ is invalid, or the size of the buffer pointed to by -_option_value_, as specified by _option_len_, is insufficient for storing the -option value. - - -EXAMPLE -------- -.Receiving a multi-part message ----- -zmq_msg_t part; -int more; -size_t more_size = sizeof (more); -while (true) { - /* Create an empty 0MQ message to hold the message part */ - int rc = zmq_msg_init (&part); - assert (rc == 0); - /* Block until a message is available to be received from socket */ - rc = zmq_recvmsg (socket, &part, 0); - assert (rc != -1); - rc = getmsgopt (&part, ZMQ_MORE, &more, &more_size); - assert (rc == 0); - if (more) { - fprintf (stderr, "more\n"); - } - else { - fprintf (stderr, "end\n"); - break; - } - zmq_msg_close (part); -} ----- - - -SEE ALSO --------- -linkzmq:zmq_msg_data[3] -linkzmq:zmq_msg_init[3] -linkzmq:zmq_msg_init_size[3] -linkzmq:zmq_msg_init_data[3] -linkzmq:zmq_msg_close[3] -linkzmq:zmq[7] - - -AUTHORS -------- -The 0MQ documentation was written by Chuck Remes . -- cgit v1.2.3