DragonFly On-Line Manual Pages

Search: Section:  

XS_MSG_CLOSE(3)              Crossroads I/O Manual             XS_MSG_CLOSE(3)


NAME

       xs_msg_close - release Crossroads message


SYNOPSIS

       int xs_msg_close (xs_msg_t *msg);


DESCRIPTION

       The xs_msg_close() function shall inform the Crossroads infrastructure
       that any resources associated with the message object referenced by msg
       are no longer required and may be released. Actual release of resources
       associated with the message object shall be postponed by the library
       until all users of the message or underlying data buffer have indicated
       it is no longer required.

       Applications should ensure that xs_msg_close() is called once a message
       is no longer required, otherwise memory leaks may occur.

           Caution

           Never access xs_msg_t members directly, instead always use the
           xs_msg family of functions.


RETURN VALUE

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


ERRORS

       EFAULT
           Invalid message.


SEE ALSO

       xs_msg_init(3) xs_msg_init_size(3) xs_msg_init_data(3) xs_msg_data(3)
       xs_msg_size(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
           mailto:sustrik@250bpm.com

        2. martin@lucina.net
           mailto:martin@lucina.net

Crossroads I/O 1.2.0              02/17/2016                   XS_MSG_CLOSE(3)

Search: Section: