libzmq/man/man3/zmq_close.3

31 lines
867 B
Groff
Raw Normal View History

.TH zmq_close 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
2009-11-22 08:47:06 +01:00
.SH NAME
zmq_close \- destroys 0MQ socket
.SH SYNOPSIS
.B int zmq_close (void *s);
.SH DESCRIPTION
2009-11-22 16:51:21 +01:00
Destroys 0MQ socket (one created using
.IR zmq_socket
function). All sockets have to be properly closed before the application
2010-01-21 10:38:40 +01:00
terminates, otherwise memory leaks will occur. Note that any outbound messages
that haven't been psuhed to the network yet and any inbound messages that
haven't been received by the application yet will be dropped on the socket
shutdown.
2009-11-22 08:47:06 +01:00
.SH RETURN VALUE
2009-11-22 16:51:21 +01:00
In case of success the function returns zero. Otherwise it returns -1 and
sets
.IR errno
to the appropriate value.
2009-11-22 08:47:06 +01:00
.SH ERRORS
2009-11-22 16:51:21 +01:00
No errors are defined.
2009-11-22 08:47:06 +01:00
.SH EXAMPLE
2009-11-22 16:51:21 +01:00
.nf
int rc = zmq_close (s);
assert (rc == 0);
.fi
2009-11-22 08:47:06 +01:00
.SH SEE ALSO
2009-11-22 16:51:21 +01:00
.BR zmq_socket (3)
.BR zmq_term (3)
2009-11-22 08:47:06 +01:00
.SH AUTHOR
Martin Sustrik <sustrik at 250bpm dot com>