diff options
author | Micah Anderson <micah@riseup.net> | 2014-11-11 13:30:46 -0500 |
---|---|---|
committer | Micah Anderson <micah@riseup.net> | 2014-11-11 13:30:46 -0500 |
commit | 597cc5edd624525563e6549dc0057eca2a51c81d (patch) | |
tree | fc3b8b0ed54e304ea6d0b7da23df1fc67284b339 /doc/zmq_disconnect.txt | |
parent | 55a5e900b47474528fd6a04ee632164143b05380 (diff) |
upgrade to new versiondebian/experimental
Diffstat (limited to 'doc/zmq_disconnect.txt')
-rw-r--r-- | doc/zmq_disconnect.txt | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/zmq_disconnect.txt b/doc/zmq_disconnect.txt new file mode 100644 index 0000000..cd4e368 --- /dev/null +++ b/doc/zmq_disconnect.txt @@ -0,0 +1,67 @@ +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>. |