From 354efc513fdb4096f8830e6c2e3e8f1311303e61 Mon Sep 17 00:00:00 2001 From: Martin Lucina Date: Wed, 10 Feb 2010 16:18:46 +0100 Subject: Convert documentation to AsciiDoc --- doc/zmq_flush.txt | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 doc/zmq_flush.txt (limited to 'doc/zmq_flush.txt') diff --git a/doc/zmq_flush.txt b/doc/zmq_flush.txt new file mode 100644 index 0000000..3a2cd37 --- /dev/null +++ b/doc/zmq_flush.txt @@ -0,0 +1,59 @@ +zmq_flush(3) +============ + + +NAME +---- +zmq_flush - flushes pre-sent messages to the socket + + +SYNOPSIS +-------- +'int zmq_flush (void *s);' + + +DESCRIPTION +----------- +Flushes all the pre-sent messages - i.e. those that have been sent with +ZMQ_NOFLUSH flag - to the socket. This functionality improves performance in +cases where several messages are sent during a single business operation. +It should not be used as a transaction - ACID properties are not guaranteed. +Note that calling 'zmq_send' without ZMQ_NOFLUSH flag automatically flushes all +previously pre-sent messages. + + +RETURN VALUE +------------ +In case of success the function returns zero. Otherwise it returns -1 and +sets 'errno' to the appropriate value. + + +ERRORS +------ +*ENOTSUP*:: +function isn't supported by particular socket type. +*EFSM*:: +function cannot be called at the moment, because socket is not in the +approprite state. + + +EXAMPLE +------- +---- +rc = zmq_send (s, &msg1, ZMQ_NOFLUSH); +assert (rc == 0); +rc = zmq_send (s, &msg2, ZMQ_NOFLUSH); +assert (rc == 0); +rc = zmq_flush (s); +assert (rc == 0); +---- + + +SEE ALSO +-------- +linkzmq:zmq_send[3] + + +AUTHOR +------ +Martin Sustrik -- cgit v1.2.3