diff options
| author | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
|---|---|---|
| committer | Martin Lucina <mato@kotelna.sk> | 2010-03-09 18:47:31 +0100 |
| commit | 1aee86408d575d6572b071d7564da7f006d1757e (patch) | |
| tree | 98d54989b5961db8c458017034bfb8f981e98c8f /doc/zmq_msg_close.txt | |
| parent | d790940fd06060c8a2c624b0e41e470ad31ae0d8 (diff) | |
Documentation rewrite
Diffstat (limited to 'doc/zmq_msg_close.txt')
| -rw-r--r-- | doc/zmq_msg_close.txt | 43 |
1 files changed, 22 insertions, 21 deletions
diff --git a/doc/zmq_msg_close.txt b/doc/zmq_msg_close.txt index 1b043a2..dcc42ff 100644 --- a/doc/zmq_msg_close.txt +++ b/doc/zmq_msg_close.txt @@ -4,25 +4,33 @@ zmq_msg_close(3) NAME ---- -zmq_msg_close - destroys 0MQ message +zmq_msg_close - release 0MQ message SYNOPSIS -------- -'int zmq_msg_close (zmq_msg_t *msg);' +*int zmq_msg_close (zmq_msg_t '*msg');* DESCRIPTION ----------- -Deallocates message 'msg' including any associated buffers (unless the buffer -is shared with another message). Not calling this function can result in -memory leaks. +The _zmq_msg_close()_ function shall inform the 0MQ 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 0MQ until all users of the message or +underlying data buffer have indicated it is no longer required. + +Applications should ensure that _zmq_msg_close()_ is called once a message is +no longer required, otherwise memory leaks may occur. + +CAUTION: Never access 'zmq_msg_t' members directly, instead always use the +_zmq_msg_ family of functions. RETURN VALUE ------------ -In case of success the function returns zero. Otherwise it returns -1 and sets -'errno' to the appropriate value. +The _zmq_msg_close()_ function shall return zero if successful. Otherwise +it shall return -1 and set 'errno' to one of the values defined below. ERRORS @@ -30,24 +38,17 @@ ERRORS No errors are defined. -EXAMPLE -------- ----- -zmq_msg_t msg; -rc = zmq_msg_init_size (&msg, 1000000); -assert (rc = 0); -rc = zmq_msg_close (&msg); -assert (rc = 0); ----- - - SEE ALSO -------- linkzmq:zmq_msg_init[3] linkzmq:zmq_msg_init_size[3] linkzmq:zmq_msg_init_data[3] +linkzmq:zmq_msg_data[3] +linkzmq:zmq_msg_size[3] +linkzmq:zmq[7] -AUTHOR ------- -Martin Sustrik <sustrik at 250bpm dot com> +AUTHORS +------- +The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and +Martin Lucina <mato@kotelna.sk>. |