libzmq/doc/zmq_bind.txt

103 lines
3.1 KiB
Plaintext
Raw Normal View History

2010-02-10 16:18:46 +01:00
zmq_bind(3)
===========
NAME
----
2012-10-27 02:43:19 +02:00
zmq_bind - accept incoming connections on a socket
2010-02-10 16:18:46 +01:00
SYNOPSIS
--------
*int zmq_bind (void '*socket', const char '*endpoint');*
2010-02-10 16:18:46 +01:00
DESCRIPTION
-----------
2012-10-27 02:43:19 +02:00
The _zmq_bind()_ function binds the 'socket' to a local 'endpoint' and then
accepts incoming connections on that endpoint.
2010-02-10 16:18:46 +01:00
2012-10-27 02:43:19 +02:00
The 'endpoint' is a string consisting of a 'transport'`://` followed by an
'address'. The 'transport' specifies the underlying protocol to use. The
'address' specifies the transport-specific address to bind to.
2010-03-09 18:47:31 +01:00
2012-10-27 02:43:19 +02:00
0MQ provides the the following transports:
2010-03-09 18:47:31 +01:00
'tcp':: unicast transport using TCP, see linkzmq:zmq_tcp[7]
2012-10-27 02:43:19 +02:00
'ipc':: local inter-process communication transport, see linkzmq:zmq_ipc[7]
'inproc':: local in-process (inter-thread) communication transport, see linkzmq:zmq_inproc[7]
'pgm', 'epgm':: reliable multicast transport using PGM, see linkzmq:zmq_pgm[7]
2010-03-09 18:47:31 +01:00
2012-10-27 02:43:19 +02:00
Every 0MQ socket type except 'ZMQ_PAIR' supports one-to-many and many-to-one
semantics. The precise semantics depend on the socket type and are defined in
linkzmq:zmq_socket[3].
The 'ipc' and 'tcp' transports accept wildcard addresses: see linkzmq:zmq_ipc[7]
and linkzmq:zmq_tcp[7] for details.
NOTE: the address syntax may be different for _zmq_bind()_ and _zmq_connect()_
especially for the 'tcp', 'pgm' and 'epgm' transports.
NOTE: following a _zmq_bind()_, the socket enters a 'mute' state unless or
until at least one incoming or outgoing connection is made, at which point
the socket enters a 'ready' state. In the mute state, the socket blocks or
drops messages according to the socket type, as defined in linkzmq:zmq_socket[3].
By contrast, following a libzmq:zmq_connect[3], the socket enters the 'ready' state.
2010-02-10 16:18:46 +01:00
RETURN VALUE
------------
2012-10-27 02:43:19 +02:00
The _zmq_bind()_ function returns zero if successful. Otherwise it returns
`-1` and sets 'errno' to one of the values defined below.
2010-02-10 16:18:46 +01:00
ERRORS
------
*EINVAL*::
The endpoint supplied is invalid.
2010-02-10 16:18:46 +01:00
*EPROTONOSUPPORT*::
2010-03-09 18:47:31 +01:00
The requested 'transport' protocol is not supported.
2010-02-10 16:18:46 +01:00
*ENOCOMPATPROTO*::
2010-03-09 18:47:31 +01:00
The requested 'transport' protocol is not compatible with the socket type.
2010-02-10 16:18:46 +01:00
*EADDRINUSE*::
2010-04-06 15:23:13 +02:00
The requested 'address' is already in use.
2010-02-10 16:18:46 +01:00
*EADDRNOTAVAIL*::
2010-04-06 15:23:13 +02:00
The requested 'address' was not local.
2010-04-06 07:33:52 +02:00
*ENODEV*::
2010-04-06 15:23:13 +02:00
The requested 'address' specifies a nonexistent interface.
*ETERM*::
The 0MQ 'context' associated with the specified 'socket' was terminated.
*ENOTSOCK*::
The provided 'socket' was invalid.
*EMTHREAD*::
No I/O thread is available to accomplish the task.
2010-02-10 16:18:46 +01:00
EXAMPLE
-------
2010-03-09 18:47:31 +01:00
.Binding a publisher socket to an in-process and a TCP transport
2010-02-10 16:18:46 +01:00
----
2010-03-09 18:47:31 +01:00
/* Create a ZMQ_PUB socket */
void *socket = zmq_socket (context, ZMQ_PUB);
assert (socket);
/* Bind it to a in-process transport with the address 'my_publisher' */
2010-03-09 18:47:31 +01:00
int rc = zmq_bind (socket, "inproc://my_publisher");
2010-02-10 16:18:46 +01:00
assert (rc == 0);
/* Bind it to a TCP transport on port 5555 of the 'eth0' interface */
rc = zmq_bind (socket, "tcp://eth0:5555");
2010-02-10 16:18:46 +01:00
assert (rc == 0);
----
SEE ALSO
--------
linkzmq:zmq_connect[3]
linkzmq:zmq_socket[3]
linkzmq:zmq[7]
AUTHORS
-------
2012-10-27 02:43:19 +02:00
This 0MQ manual page was written by Pieter Hintjens <ph@imatix.com>,
Martin Sustrik <sustrik@250bpm.com> and Martin Lucina <mato@kotelna.sk>.