mirror of
https://github.com/zeromq/libzmq.git
synced 2025-01-10 07:09:12 +08:00
38 lines
1.2 KiB
Groff
38 lines
1.2 KiB
Groff
.TH zmq_flush 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
|
|
.SH NAME
|
|
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>
|