table of contents
XS_CONNECT(3) | Crossroads I/O Manual | XS_CONNECT(3) |
NAME¶
xs_connect - connect a socket
SYNOPSIS¶
int xs_connect (void *socket, const char *endpoint);
DESCRIPTION¶
The xs_connect() function shall connect the socket referenced by the socket argument to the endpoint specified by the endpoint argument.
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 the underlying transport protocol selected.
The following transports are defined:
inproc
ipc
tcp
pgm, epgm
With the exception of XS_PAIR sockets, a single socket may be connected to multiple endpoints using xs_connect(), while simultaneously accepting incoming connections from multiple endpoints bound to the socket using xs_bind(). Refer to xs_socket(3) for a description of the exact semantics involved when connecting or binding a socket to multiple endpoints.
Note
The connection will not be performed immediately but as needed by the library. Thus a successful invocation of xs_connect() does not indicate that a physical connection was or can actually be established.
RETURN VALUE¶
The xs_connect() function shall return endpoint ID if successful. Otherwise it shall return -1 and set errno to one of the values defined below.
ERRORS¶
EINVAL
ENAMETOOLONG
EPROTONOSUPPORT
ENOCOMPATPROTO
ETERM
ENOTSOCK
EXAMPLE¶
Connecting a subscriber socket to an in-process and a TCP transport.
/* Create a XS_SUB socket */ void *socket = xs_socket (context, XS_SUB); assert (socket); /* Connect it to an in-process transport with the address 'my_publisher' */ int rc = xs_connect (socket, "inproc://my_publisher"); assert (rc != -1); /* Connect it to the host server001, port 5555 using a TCP transport */ rc = xs_connect (socket, "tcp://server001:5555"); assert (rc != -1);
SEE ALSO¶
xs_bind(3) xs_socket(3) xs(7)
AUTHORS¶
The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com[1]> and Martin Lucina <martin@lucina.net[2]>.
NOTES¶
- 1.
- sustrik@250bpm.com
- 2.
- martin@lucina.net
06/13/2012 | Crossroads I/O 1.2.0 |