summaryrefslogtreecommitdiff
path: root/doc/xs_msg_data.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/xs_msg_data.txt
parent1fc63e4dbcf1438eb571d720f57be68852f820f7 (diff)
ZeroMQ renamed to Crossroads
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
Diffstat (limited to 'doc/xs_msg_data.txt')
-rw-r--r--doc/xs_msg_data.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/xs_msg_data.txt b/doc/xs_msg_data.txt
new file mode 100644
index 0000000..64b5295
--- /dev/null
+++ b/doc/xs_msg_data.txt
@@ -0,0 +1,48 @@
+xs_msg_data(3)
+==============
+
+
+NAME
+----
+xs_msg_data - retrieve pointer to message content
+
+
+SYNOPSIS
+--------
+*void *xs_msg_data (xs_msg_t '*msg');*
+
+
+DESCRIPTION
+-----------
+The _xs_msg_data()_ function shall return a pointer to the message content of
+the message object referenced by 'msg'.
+
+CAUTION: Never access 'xs_msg_t' members directly, instead always use the
+_xs_msg_ family of functions.
+
+
+RETURN VALUE
+------------
+Upon successful completion, _xs_msg_data()_ shall return a pointer to the
+message content.
+
+
+ERRORS
+------
+No errors are defined.
+
+
+SEE ALSO
+--------
+linkxs:xs_msg_size[3]
+linkxs:xs_msg_init[3]
+linkxs:xs_msg_init_size[3]
+linkxs:xs_msg_init_data[3]
+linkxs:xs_msg_close[3]
+linkxs:xs[7]
+
+
+AUTHORS
+-------
+The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com>
+and Martin Lucina <martin@lucina.net>.