zmq_disconnect(3)

Back to Contents

ØMQ Manual - ØMQ/4.2.2

+ Table of Contents

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. Any outstanding messages physically received from the network but not yet received by the application with zmq_recv() shall be discarded. The behaviour for discarding messages sent by the application with zmq_send() but not yet physically transferred to the network depends on the value of the ZMQ_LINGER socket option for the specified socket.

The endpoint argument is as described in zmq_connect(3)

The default setting of ZMQ_LINGER does not discard unsent messages; this behaviour may cause the application to block when calling zmq_ctx_term(). For details refer to zmq_setsockopt(3) and zmq_ctx_term(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 ØMQ 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);

Authors

This page was written by the ØMQ community. To make a change please read the ØMQ Contribution Policy at http://www.zeromq.org/docs:contributing.

0MQ Api