libzmq/man/man3/zmq_flush.3

38 lines
1.1 KiB
Groff
Raw Normal View History

2009-11-22 08:47:06 +01:00
.TH zmq_flush 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
.SH NAME
zmq_flush \- flushes pre-sent messages to the socket
.SH SYNOPSIS
.B int zmq_flush (void *s);
.SH DESCRIPTION
2009-11-22 16:51:21 +01:00
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.
2009-11-22 08:47:06 +01:00
.SH RETURN VALUE
2009-11-22 16:51:21 +01:00
In case of success the function returns zero. Otherwise it returns -1 and
sets
.IR errno
to the appropriate value.
2009-11-22 08:47:06 +01:00
.SH ERRORS
2009-11-22 16:51:21 +01:00
.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.
2009-11-22 08:47:06 +01:00
.SH EXAMPLE
2009-11-22 16:51:21 +01:00
.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
2009-11-22 08:47:06 +01:00
.SH SEE ALSO
2009-11-22 16:51:21 +01:00
.BR zmq_send (3)
2009-11-22 08:47:06 +01:00
.SH AUTHOR
Martin Sustrik <sustrik at 250bpm dot com>