summaryrefslogtreecommitdiff
path: root/doc/zmq_msg_init_size.txt
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2012-02-16 10:01:47 +0900
committerMartin Sustrik <sustrik@250bpm.com>2012-02-16 10:01:47 +0900
commit4a7aad06d95701cf232198093ce396dcdbb53e5b (patch)
tree8ced8929e603a179d9434099244dfd782e705d5e /doc/zmq_msg_init_size.txt
parent1fc63e4dbcf1438eb571d720f57be68852f820f7 (diff)
ZeroMQ renamed to Crossroads
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc/zmq_msg_init_size.txt')
-rw-r--r--doc/zmq_msg_init_size.txt58
1 files changed, 0 insertions, 58 deletions
diff --git a/doc/zmq_msg_init_size.txt b/doc/zmq_msg_init_size.txt
deleted file mode 100644
index e8412ae..0000000
--- a/doc/zmq_msg_init_size.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-zmq_msg_init_size(3)
-====================
-
-
-NAME
-----
-zmq_msg_init_size - initialise 0MQ message of a specified size
-
-
-SYNOPSIS
---------
-*int zmq_msg_init_size (zmq_msg_t '*msg', size_t 'size');*
-
-
-DESCRIPTION
------------
-The _zmq_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
-_zmq_msg_init_size()_ shall not clear the message data.
-
-CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
-_zmq_msg_ family of functions.
-
-CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_ and
-_zmq_msg_init_size()_ are mutually exclusive. Never initialize the same
-'zmq_msg_t' twice.
-
-
-RETURN VALUE
-------------
-The _zmq_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
---------
-linkzmq:zmq_msg_init_data[3]
-linkzmq:zmq_msg_init[3]
-linkzmq:zmq_msg_close[3]
-linkzmq:zmq_msg_data[3]
-linkzmq:zmq_msg_size[3]
-linkzmq:zmq[7]
-
-
-AUTHORS
--------
-The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
-Martin Lucina <martin@lucina.net>.