summaryrefslogtreecommitdiff
path: root/doc/zmq_disconnect.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq_disconnect.txt')
-rw-r--r--doc/zmq_disconnect.txt67
1 files changed, 0 insertions, 67 deletions
diff --git a/doc/zmq_disconnect.txt b/doc/zmq_disconnect.txt
deleted file mode 100644
index cd4e368..0000000
--- a/doc/zmq_disconnect.txt
+++ /dev/null
@@ -1,67 +0,0 @@
-zmq_disconnect(3)
-=================
-
-
-NAME
-----
-zmq_disconnect - Disconnect a socket
-
-
-SYNOPSIS
---------
-int zmq_disconnect (void '*socket', const char '*endpoint');
-
-
-DESCRIPTION
------------
-The _zmq_disconnect()_ function shall disconnect a socket specified
-by the 'socket' argument from the endpoint specified by the 'endpoint'
-argument.
-
-The 'endpoint' argument is as described in linkzmq:zmq_connect[3]
-
-
-RETURN VALUE
-------------
-The _zmq_disconnect()_ function shall return zero if successful. Otherwise it
-shall return `-1` and set 'errno' to one of the values defined below.
-
-ERRORS
-------
-*EINVAL*::
-The endpoint supplied is invalid.
-*ETERM*::
-The 0MQ 'context' associated with the specified 'socket' was terminated.
-*ENOTSOCK*::
-The provided 'socket' was invalid.
-*ENOENT*::
-The provided endpoint is not connected.
-
-
-EXAMPLE
--------
-.Connecting a subscriber socket to an in-process and a TCP transport
-----
-/* Create a ZMQ_SUB socket */
-void *socket = zmq_socket (context, ZMQ_SUB);
-assert (socket);
-/* Connect it to the host server001, port 5555 using a TCP transport */
-rc = zmq_connect (socket, "tcp://server001:5555");
-assert (rc == 0);
-/* Disconnect from the previously connected endpoint */
-rc = zmq_disconnect (socket, "tcp://server001:5555");
-assert (rc == 0);
-----
-
-
-SEE ALSO
---------
-linkzmq:zmq_connect[3]
-linkzmq:zmq_socket[3]
-linkzmq:zmq[7]
-
-
-AUTHORS
--------
-This page was written by the 0MQ community. To make a change please
-read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.