libzmq/man/man3/zmq_bind.3

49 lines
1.4 KiB
Groff
Raw Normal View History

2009-11-22 08:47:06 +01:00
.TH zmq_bind 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
.SH NAME
zmq_bind \- binds the socket to the specified address
.SH SYNOPSIS
.B int zmq_bind (void *s, const char *addr);
.SH DESCRIPTION
2009-11-22 16:51:21 +01:00
The function binds socket
.IR s to a particular transport. Actual semantics of the
command depend on the underlying transport mechanism, however, in cases where
peers connect in an asymetric manner,
.IR zmq_bind
should be called first,
.IR zmq_connect
afterwards. For actual formats of
.IR addr
parameter for different types of transport have a look at
.IR zmq(7) .
Note that single socket can be bound (and connected) to
arbitrary number of peers using different transport mechanisms.
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
.IP "\fBEPROTONOSUPPORT\fP"
unsupported protocol.
.IP "\fBENOCOMPATPROTO\fP"
protocol is not compatible with the socket type.
.IP "\fBEADDRINUSE\fP"
the given address is already in use.
.IP "\fBEADDRNOTAVAIL\fP"
a nonexistent interface was requested or the requested address was not local.
2009-11-22 08:47:06 +01:00
.SH EXAMPLE
2009-11-22 16:51:21 +01:00
.nf
void *s = zmq_socket (context, ZMQ_PUB);
assert (s);
int rc = zmq_bind (s, "inproc://my_publisher");
assert (rc == 0);
rc = zmq_bind (s, "tcp://eth0:5555");
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_connect (3)
.BR zmq_socket (3)
.BR zmq (7)
2009-11-22 08:47:06 +01:00
.SH AUTHOR
Martin Sustrik <sustrik at 250bpm dot com>