zmq_close(3)

zmq_close(3)

ØMQ Manual - ØMQ/3.1.0

Name

zmq_close - close ØMQ socket

Synopsis

int zmq_close (void *socket);

Description

The zmq_close() function shall destroy the socket referenced by the socket 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 default setting of ZMQ_LINGER does not discard unsent messages; this behaviour may cause the application to block when calling zmq_term(). For details refer to zmq_setsockopt(3) and zmq_term(3).

Return value

The zmq_close() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

Errors

ENOTSOCK
The provided socket was invalid.

See also

zmq_socket(3) zmq_term(3) zmq_setsockopt(3) zmq(7)

Authors

The ØMQ documentation was written by Martin Sustrik <moc.mpb052|kirtsus#moc.mpb052|kirtsus> and Martin Lucina <ten.anicul|nitram#ten.anicul|nitram>.