From e65d228f4f829d23134a97c57121a066d92a1538 Mon Sep 17 00:00:00 2001 From: Ian Barber Date: Fri, 11 May 2012 14:17:45 +0100 Subject: [PATCH] gitignore endpoint test and add docs for unbind and disconnect --- .gitignore | 1 + doc/zmq_disconnect.txt | 65 ++++++++++++++++++++++++++++++++++++++++++ doc/zmq_unbind.txt | 65 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 131 insertions(+) create mode 100644 doc/zmq_disconnect.txt create mode 100644 doc/zmq_unbind.txt diff --git a/.gitignore b/.gitignore index 71ebc06e..d6d458df 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ tests/test_invalid_rep tests/test_msg_flags tests/test_ts_context tests/test_connect_resolve +tests/test_term_endpoint src/platform.hpp* src/stamp-h1 perf/local_lat diff --git a/doc/zmq_disconnect.txt b/doc/zmq_disconnect.txt new file mode 100644 index 00000000..195c74aa --- /dev/null +++ b/doc/zmq_disconnect.txt @@ -0,0 +1,65 @@ +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. + + +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 0MQ manual page was written by Martin Sustrik , +Martin Lucina and Ian Barber diff --git a/doc/zmq_unbind.txt b/doc/zmq_unbind.txt new file mode 100644 index 00000000..4633ee0f --- /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 0MQ manual page was written by Martin Sustrik , +Martin Lucina and Ian Barber