zmq_bind.txt 3.21 KB
Newer Older
1 2 3 4 5 6
zmq_bind(3)
===========


NAME
----
Pieter Hintjens's avatar
Pieter Hintjens committed
7
zmq_bind - accept incoming connections on a socket
8 9 10 11


SYNOPSIS
--------
12
*int zmq_bind (void '*socket', const char '*endpoint');*
13 14 15 16


DESCRIPTION
-----------
Pieter Hintjens's avatar
Pieter Hintjens committed
17 18
The _zmq_bind()_ function binds the 'socket' to a local 'endpoint' and then
accepts incoming connections on that endpoint.
19

Pieter Hintjens's avatar
Pieter Hintjens committed
20 21 22
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.
Martin Lucina's avatar
Martin Lucina committed
23

Pieter Hintjens's avatar
Pieter Hintjens committed
24
0MQ provides the the following transports:
Martin Lucina's avatar
Martin Lucina committed
25

26
'tcp':: unicast transport using TCP, see linkzmq:zmq_tcp[7]
Pieter Hintjens's avatar
Pieter Hintjens committed
27 28
'ipc':: local inter-process communication transport, see linkzmq:zmq_ipc[7]
'inproc':: local in-process (inter-thread) communication transport, see linkzmq:zmq_inproc[7]
29
'pgm', 'epgm':: reliable multicast transport using PGM, see linkzmq:zmq_pgm[7]
Ilya Kulakov's avatar
Ilya Kulakov committed
30
'vmci':: virtual machine communications interface (VMCI), see linkzmq:zmq_vmci[7]
Martin Lucina's avatar
Martin Lucina committed
31

Pieter Hintjens's avatar
Pieter Hintjens committed
32 33 34 35
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].

Ilya Kulakov's avatar
Ilya Kulakov committed
36 37
The 'ipc', 'tcp' and 'vmci' transports accept wildcard addresses: see linkzmq:zmq_ipc[7],
linkzmq:zmq_tcp[7] and linkzmq:zmq_vmci[7] for details.
Pieter Hintjens's avatar
Pieter Hintjens committed
38 39 40 41 42 43 44 45 46

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.
47 48 49 50


RETURN VALUE
------------
Pieter Hintjens's avatar
Pieter Hintjens committed
51 52
The _zmq_bind()_ function returns zero if successful. Otherwise it returns
`-1` and sets 'errno' to one of the values defined below.
53 54 55 56


ERRORS
------
57 58
*EINVAL*::
The endpoint supplied is invalid.
59
*EPROTONOSUPPORT*::
Martin Lucina's avatar
Martin Lucina committed
60
The requested 'transport' protocol is not supported.
61
*ENOCOMPATPROTO*::
Martin Lucina's avatar
Martin Lucina committed
62
The requested 'transport' protocol is not compatible with the socket type.
63
*EADDRINUSE*::
Martin Lucina's avatar
Martin Lucina committed
64
The requested 'address' is already in use.
65
*EADDRNOTAVAIL*::
Martin Lucina's avatar
Martin Lucina committed
66
The requested 'address' was not local.
67
*ENODEV*::
Martin Lucina's avatar
Martin Lucina committed
68
The requested 'address' specifies a nonexistent interface.
69
*ETERM*::
70
The 0MQ 'context' associated with the specified 'socket' was terminated.
71 72
*ENOTSOCK*::
The provided 'socket' was invalid.
73 74
*EMTHREAD*::
No I/O thread is available to accomplish the task.
75 76 77 78


EXAMPLE
-------
Martin Lucina's avatar
Martin Lucina committed
79
.Binding a publisher socket to an in-process and a TCP transport
80
----
Martin Lucina's avatar
Martin Lucina committed
81 82 83
/* Create a ZMQ_PUB socket */
void *socket = zmq_socket (context, ZMQ_PUB);
assert (socket);
84
/* Bind it to a in-process transport with the address 'my_publisher' */
Martin Lucina's avatar
Martin Lucina committed
85
int rc = zmq_bind (socket, "inproc://my_publisher");
86
assert (rc == 0);
87 88
/* Bind it to a TCP transport on port 5555 of the 'eth0' interface */
rc = zmq_bind (socket, "tcp://eth0:5555");
89 90 91 92 93 94 95 96 97 98
assert (rc == 0);
----


SEE ALSO
--------
linkzmq:zmq_connect[3]
linkzmq:zmq_socket[3]
linkzmq:zmq[7]

99 100 101

AUTHORS
-------
102 103
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.