xs_close(3)

xs_close3

Close crossroads socket

Usage

int xs_close (void *socket);

Overview

The xs_close() function shall destroy the socket referenced by the socket argument. Any outstanding messages physically received from the network but not yet received by the application with xs_recv() shall be discarded. The behaviour for discarding messages sent by the application with xs_send() but not yet physically transferred to the network depends on the value of the XS_LINGER socket option for the specified socket.

Note

The default setting of XS_LINGER does not discard unsent messages; this behaviour may cause the application to block when calling xs_term(). For details refer to xs_setsockopt(3) and xs_term(3).

Return value

The xs_close() function shall return zero if successful. Otherwise it shall return -1 and set errno to one of the values defined below.

Errors

ENOTSOCK

The provided socket was invalid.

Notes

Releases

Unchanged in 3 releases since Debian 8 (Jessie).

  1. 8–10

Authors

The Crossroads documentation was written by Martin Sustrik <[email protected][1]> and Martin Lucina <[email protected][2]>.

From libxs-dev 1.2.0-2 in Debian 10 (Buster). Parsed by carta from the page's man source.