xs_term(3)

xs_term3

Terminate the context

Usage

int xs_term (void *context);

Overview

The xs_term() function shall terminate the Crossroads context context.

Context termination is performed in the following steps:

1. Any blocking operations currently in progress on sockets open within context shall return immediately with an error code of ETERM. With the exception of xs_close(), any further operations on sockets open within context shall fail with an error code of ETERM.

2. After interrupting all blocking calls, xs_term() shall block until the following conditions are satisfied:

• All sockets open within context have been closed with xs_close().

• For each socket within context, all messages sent by the application with xs_send() have either been physically transferred to a network peer, or the socket’s linger period set with the XS_LINGER socket option has expired.

For further details regarding socket linger behaviour refer to the XS_LINGER option in xs_setsockopt(3).

Return value

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

Errors

EFAULT

The provided context was invalid.

EINTR

Termination was interrupted by a signal. It can be restarted if needed.

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.