diff options
| author | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-22 16:51:21 +0100 |
|---|---|---|
| committer | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-22 16:51:21 +0100 |
| commit | e90ada0d044636201c57786307a49a52f9cf7643 (patch) | |
| tree | fa71e4c876ee4b6c02d8e5a34ac63274c3a00af2 /man/man3/zmq_flush.3 | |
| parent | 6602cce9af93539df8f1c43235e7e7130a3df60d (diff) | |
more man pages filled in
Diffstat (limited to 'man/man3/zmq_flush.3')
| -rw-r--r-- | man/man3/zmq_flush.3 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/man/man3/zmq_flush.3 b/man/man3/zmq_flush.3 index f84c561..194cf6c 100644 --- a/man/man3/zmq_flush.3 +++ b/man/man3/zmq_flush.3 @@ -4,9 +4,34 @@ zmq_flush \- flushes pre-sent messages to the socket .SH SYNOPSIS .B int zmq_flush (void *s); .SH 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 +.IR zmq_send +without ZMQ_NOFLUSH flag automatically flushes all previously pre-sent messages. .SH RETURN VALUE +In case of success the function returns zero. Otherwise it returns -1 and +sets +.IR errno +to the appropriate value. .SH ERRORS +.IP "\fBENOTSUP\fP" +function isn't supported by particular socket type. +.IP "\fBEFSM\fP" +function cannot be called at the moment, because socket is not in the +approprite state. .SH EXAMPLE +.nf +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); +.fi .SH SEE ALSO +.BR zmq_send (3) .SH AUTHOR Martin Sustrik <sustrik at 250bpm dot com> |