← Back to branch summary

~ubuntu-branches/ubuntu/maverick/zeromq/maverick

« back to all changes in this revision

Viewing changes to doc/zmq_msg_close.txt

  • Committer: Bazaar Package Importer
  • Author(s): Adrian von Bidder
  • Date: 2010-03-17 10:43:40 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100317104340-un1ne0oqe16w8eaq
Tags: 2.0.6beta.dfsg-1
http://bugs.debian.org/567513
http://bugs.debian.org/567848
* New upstream version.
  - Source doesn't include non-C/C++ language bindings anymore.
  - New versioning: 2.0.6 is official upstream version which is a beta.
* Repacked orig tar: removed non-free RFC documents (closes: #567513)
* Improved/corrected description and copyright file, added bzip2 build
  dependency.  Thanks to feedback from zeromq mailing list.
* Disable OpenPGM on non-x86 architectures (closes: #567848)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/zmq_msg_close.txt
 
1
zmq_msg_close(3)
 
2
================
 
3
 
 
4
 
 
5
NAME
 
6
----
 
7
zmq_msg_close - release 0MQ message
 
8
 
 
9
 
 
10
SYNOPSIS
 
11
--------
 
12
*int zmq_msg_close (zmq_msg_t '*msg');*
 
13
 
 
14
 
 
15
DESCRIPTION
 
16
-----------
 
17
The _zmq_msg_close()_ function shall inform the 0MQ infrastructure that any
 
18
resources associated with the message object referenced by 'msg' are no longer
 
19
required and may be released. Actual release of resources associated with the
 
20
message object shall be postponed by 0MQ until all users of the message or
 
21
underlying data buffer have indicated it is no longer required.
 
22
 
 
23
Applications should ensure that _zmq_msg_close()_ is called once a message is
 
24
no longer required, otherwise memory leaks may occur.
 
25
 
 
26
CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
 
27
_zmq_msg_ family of functions.
 
28
 
 
29
 
 
30
RETURN VALUE
 
31
------------
 
32
The _zmq_msg_close()_ function shall return zero if successful. Otherwise
 
33
it shall return `-1` and set 'errno' to one of the values defined below.
 
34
 
 
35
 
 
36
ERRORS
 
37
------
 
38
No errors are defined.
 
39
 
 
40
 
 
41
SEE ALSO
 
42
--------
 
43
linkzmq:zmq_msg_init[3]
 
44
linkzmq:zmq_msg_init_size[3]
 
45
linkzmq:zmq_msg_init_data[3]
 
46
linkzmq:zmq_msg_data[3]
 
47
linkzmq:zmq_msg_size[3]
 
48
linkzmq:zmq[7]
 
49
 
 
50
 
 
51
AUTHORS
 
52
-------
 
53
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
 
54
Martin Lucina <mato@kotelna.sk>.