DragonFly On-Line Manual Pages

Search: Section:  

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


NAME

       xs_msg_init_size - initialise Crossroads message of a specified size


SYNOPSIS

       int xs_msg_init_size (xs_msg_t *msg, size_t size);


DESCRIPTION

       The xs_msg_init_size() function shall allocate any resources required
       to store a message size bytes long and initialise the message object
       referenced by msg to represent the newly allocated message.

       The implementation shall choose whether to store message content on the
       stack (small messages) or on the heap (large messages). For performance
       reasons xs_msg_init_size() shall not clear the message data.

           Caution

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

           Caution

           The functions xs_msg_init(), xs_msg_init_data() and
           xs_msg_init_size() are mutually exclusive. Never initialize the
           same xs_msg_t twice.


RETURN VALUE

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


ERRORS

       ENOMEM
           Insufficient storage space is available.


SEE ALSO

       xs_msg_init_data(3) xs_msg_init(3) xs_msg_close(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_INIT_SIZE(3)

Search: Section: