summaryrefslogtreecommitdiff
path: root/doc/zmq_flush.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2010-03-13 14:40:10 +0100
committerMartin Sustrik <sustrik@250bpm.com>2010-03-13 14:40:10 +0100
commit61ad236e9543a569fe066872a5fda4fa40ea7591 (patch)
tree7b31a4611a29979692a59fc7e0464451bddc4df3 /doc/zmq_flush.txt
parentc42343d3f027248514344aec9e3814dfe1047d59 (diff)
ZMQ_NOFLUSH and zmq_flush obsoleted
Diffstat (limited to 'doc/zmq_flush.txt')
-rw-r--r--doc/zmq_flush.txt55
1 files changed, 0 insertions, 55 deletions
diff --git a/doc/zmq_flush.txt b/doc/zmq_flush.txt
deleted file mode 100644
index 83ba32c..0000000
--- a/doc/zmq_flush.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-zmq_flush(3)
-============
-
-
-NAME
-----
-zmq_flush - flush messages queued on a socket
-
-
-SYNOPSIS
---------
-*int zmq_flush (void '*socket');*
-
-
-DESCRIPTION
------------
-The _zmq_flush()_ function shall flush messages previously queued on the socket
-referenced by the 'socket' argument. The _zmq_flush()_ function only affects
-messages that have been queued on the _message queue_ associated with 'socket'
-using the 'ZMQ_NOFLUSH' flag to the _zmq_send()_ function. If no such messages
-exist, the function has no effect.
-
-CAUTION: A successful invocation of _zmq_flush()_ does not indicate that the
-flushed messages have been transmitted to the network, or even that such a
-transmission has been initiated by 0MQ. This function exists merely as a way
-for the application programmer to supply a hint to the 0MQ infrastructure that
-the queued messages *may* be flushed as a single batch.
-
-
-RETURN VALUE
-------------
-The _zmq_flush()_ function shall return zero if successful. Otherwise it shall
-return `-1` and set 'errno' to one of the values defined below.
-
-
-ERRORS
-------
-*ENOTSUP*::
-The _zmq_flush()_ operation is not supported by this socket type.
-*EFSM*::
-The _zmq_flush()_ operation cannot be performed on this socket at the moment
-due to the socket not being in the appropriate state.
-
-
-SEE ALSO
---------
-linkzmq:zmq_send[3]
-linkzmq:zmq_socket[3]
-linkzmq:zmq[7]
-
-
-AUTHOR
-------
-The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
-Martin Lucina <mato@kotelna.sk>.