summaryrefslogtreecommitdiff
path: root/doc/xs_msg_size.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/xs_msg_size.txt')
-rw-r--r--doc/xs_msg_size.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/xs_msg_size.txt b/doc/xs_msg_size.txt
new file mode 100644
index 0000000..433d36e
--- /dev/null
+++ b/doc/xs_msg_size.txt
@@ -0,0 +1,48 @@
+xs_msg_size(3)
+==============
+
+
+NAME
+----
+xs_msg_size - retrieve message content size in bytes
+
+
+SYNOPSIS
+--------
+*size_t xs_msg_size (xs_msg_t '*msg');*
+
+
+DESCRIPTION
+-----------
+The _xs_msg_size()_ function shall return the size in bytes of the 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_size()_ shall return the size of the
+message content in bytes.
+
+
+ERRORS
+------
+No errors are defined.
+
+
+SEE ALSO
+--------
+linkxs:xs_msg_data[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>.