summaryrefslogtreecommitdiff
path: root/doc
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
parentc42343d3f027248514344aec9e3814dfe1047d59 (diff)
ZMQ_NOFLUSH and zmq_flush obsoleted
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/zmq.txt1
-rw-r--r--doc/zmq_flush.txt55
-rw-r--r--doc/zmq_send.txt8
-rw-r--r--doc/zmq_socket.txt1
5 files changed, 1 insertions, 66 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0e40813..fce124d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
MAN1 = zmq_forwarder.1 zmq_streamer.1 zmq_queue.1
-MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_flush.3 zmq_init.3 \
+MAN3 = zmq_bind.3 zmq_close.3 zmq_connect.3 zmq_init.3 \
zmq_msg_close.3 zmq_msg_copy.3 zmq_msg_data.3 zmq_msg_init.3 \
zmq_msg_init_data.3 zmq_msg_init_size.3 zmq_msg_move.3 zmq_msg_size.3 \
zmq_poll.3 zmq_recv.3 zmq_send.3 zmq_setsockopt.3 zmq_socket.3 \
diff --git a/doc/zmq.txt b/doc/zmq.txt
index 8f8d40d..003570a 100644
--- a/doc/zmq.txt
+++ b/doc/zmq.txt
@@ -115,7 +115,6 @@ Establishing a message flow::
Sending and receiving messages::
linkzmq:zmq_send[3]
- linkzmq:zmq_flush[3]
linkzmq:zmq_recv[3]
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>.
diff --git a/doc/zmq_send.txt b/doc/zmq_send.txt
index b98748f..e0b19e7 100644
--- a/doc/zmq_send.txt
+++ b/doc/zmq_send.txt
@@ -23,13 +23,6 @@ Specifies that the operation should be performed in non-blocking mode. If the
message cannot be queued on the underlying _message queue_ associated with
'socket', the _zmq_send()_ function shall fail with 'errno' set to EAGAIN.
-*ZMQ_NOFLUSH*::
-Specifies that the _zmq_send()_ function should not flush the underlying
-_message queue_ associated with 'socket' to the network automatically.
-Instead, it should batch all messages queued with the 'ZMQ_NOFLUSH' flag and
-only flush the _message queue_ once either a message without the 'ZMQ_NOFLUSH'
-flag is queued, or manually on invocation of the _zmq_flush()_ function.
-
NOTE: A successful invocation of _zmq_send()_ does not indicate that the
message has been transmitted to the network, only that it has been queued on
the _message queue_ associated with the socket and 0MQ has assumed
@@ -73,7 +66,6 @@ assert (rc == 0);
SEE ALSO
--------
-linkzmq:zmq_flush[3]
linkzmq:zmq_recv[3]
linkzmq:zmq_socket[7]
linkzmq:zmq[7]
diff --git a/doc/zmq_socket.txt b/doc/zmq_socket.txt
index 9d2907d..8f10cc7 100644
--- a/doc/zmq_socket.txt
+++ b/doc/zmq_socket.txt
@@ -125,7 +125,6 @@ linkzmq:zmq_setsockopt[3]
linkzmq:zmq_bind[3]
linkzmq:zmq_connect[3]
linkzmq:zmq_send[3]
-linkzmq:zmq_flush[3]
linkzmq:zmq_recv[3]