xs_term(3)
Name
xs_term - terminate the context
Synopsis
int xs_term (void *context);
Description
The xs_term() function shall terminate the Crossroads context context.
Context termination is performed in the following steps:
- 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.
- After interrupting all blocking calls, xs_term() shall block until the following conditions are satisfied: <itemizedlist> <listitem> 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.
See also
xs(7) xs_init(3) xs_close(3) xs_setsockopt(3)
Authors
The Crossroads documentation was written by Martin Sustrik <moc.mpb052|kirtsus#moc.mpb052|kirtsus> and Martin Lucina <ten.anicul|nitram#ten.anicul|nitram>.
page revision: 5, last edited: 13 Jun 2012 10:10