zmq_close.txt 1.25 KB
Newer Older
1 2 3 4 5 6
zmq_close(3)
============


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_close - close 0MQ socket
8 9 10 11


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*int zmq_close (void '*socket');*
13 14 15 16


DESCRIPTION
-----------
Martin Lucina's avatar
Martin Lucina committed
17
The _zmq_close()_ function shall destroy the socket referenced by the 'socket'
18
argument. Any outstanding messages physically received from the network but not
19 20 21 22 23 24 25 26
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'.

NOTE: 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 linkzmq:zmq_setsockopt[3] and linkzmq:zmq_term[3].
27 28 29 30


RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
31
The _zmq_close()_ function shall return zero if successful. Otherwise it shall
Martin Lucina's avatar
Martin Lucina committed
32
return `-1` and set 'errno' to one of the values defined below.
33 34 35 36


ERRORS
------
37 38
*ENOTSOCK*::
The provided 'socket' was invalid.
39 40 41 42 43 44


SEE ALSO
--------
linkzmq:zmq_socket[3]
linkzmq:zmq_term[3]
45
linkzmq:zmq_setsockopt[3]
Martin Lucina's avatar
Martin Lucina committed
46
linkzmq:zmq[7]
47 48


49 50
AUTHORS
-------
51 52
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.