libzmq/doc/zmq_bind.txt

90 lines
2.5 KiB
Plaintext
Raw Normal View History

2010-02-10 16:18:46 +01:00
zmq_bind(3)
===========
NAME
----
zmq_bind - accept 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
-----------
The _zmq_bind()_ function shall create an endpoint for accepting connections
and bind it to the socket referenced by the 'socket' argument.
2010-02-10 16:18:46 +01:00
The 'endpoint' argument is a string consisting of two parts as follows:
'transport'`://`'address'. The 'transport' part specifies the underlying
transport protocol to use. The meaning of the 'address' part is specific to
2010-03-09 18:47:31 +01:00
the underlying transport protocol selected.
The following transports are defined:
'inproc'::
local in-process (inter-thread) communication transport, see
linkzmq:zmq_inproc[7]
'ipc'::
local inter-process communication transport, see linkzmq:zmq_ipc[7]
'tcp'::
unicast transport using TCP, see linkzmq:zmq_tcp[7]
'pgm', 'epgm'::
reliable multicast transport using PGM, see linkzmq:zmq_pgm[7]
2010-03-09 18:47:31 +01:00
With the exception of 'ZMQ_PAIR' sockets, a single socket may be connected to
multiple endpoints using _zmq_connect()_, while simultaneously accepting
incoming connections from multiple endpoints bound to the socket using
_zmq_bind()_. Refer to linkzmq:zmq_socket[3] for a description of the exact
semantics involved when connecting or binding a socket to multiple endpoints.
2010-02-10 16:18:46 +01:00
RETURN VALUE
------------
2010-03-09 18:47:31 +01:00
The _zmq_bind()_ function shall return zero if successful. Otherwise it shall
2010-03-10 12:19:39 +01:00
return `-1` and set 'errno' to one of the values defined below.
2010-02-10 16:18:46 +01:00
ERRORS
------
*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.
*EFAULT*::
The provided 'socket' was not valid (NULL).
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 all local interfaces */
rc = zmq_bind (socket, "tcp://*: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]