diff options
Diffstat (limited to 'doc/zmq_unbind.txt')
| -rw-r--r-- | doc/zmq_unbind.txt | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/zmq_unbind.txt b/doc/zmq_unbind.txt new file mode 100644 index 0000000..8b3f7a5 --- /dev/null +++ b/doc/zmq_unbind.txt @@ -0,0 +1,65 @@ +zmq_unbind(3) +============== + + +NAME +---- +zmq_unbind - Stop accepting connections on a socket + + +SYNOPSIS +-------- +int zmq_unbind (void '*socket', const char '*endpoint'); + + +DESCRIPTION +----------- +The _zmq_unbind()_ function shall unbind a socket specified +by the 'socket' argument from the endpoint specified by the 'endpoint' +argument. + +The 'endpoint' argument is as described in linkzmq:zmq_bind[3] + + +RETURN VALUE +------------ +The _zmq_unbind()_ 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. + + +EXAMPLE +------- +.Unbind a subscriber socket from 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_bind (socket, "tcp://127.0.0.1:5555"); +assert (rc == 0); +/* Disconnect from the previously connected endpoint */ +rc = zmq_unbind (socket, "tcp://127.0.0.1:5555"); +assert (rc == 0); +---- + + +SEE ALSO +-------- +linkzmq:zmq_bind[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>. |