Merge branch 'master' of github.com:sustrik/zeromq2

1 files changed, 53 insertions, 0 deletions

diff --git a/doc/zmq_msg_size.txt b/doc/zmq_msg_size.txt
new file mode 100644
index 0000000..6d24243
--- /dev/null
+++ b/doc/zmq_msg_size.txt
@@ -0,0 +1,53 @@
+zmq_msg_size(3)
+===============
+
+
+NAME
+----
+zmq_msg_size - retrieves size of the message content
+
+
+SYNOPSIS
+--------
+'size_t zmq_msg_size (zmq_msg_t *msg);'
+
+
+DESCRIPTION
+-----------
+Returns size of the message data. Always use this function to get the size,
+never use 'zmq_msg_t' members directly.
+
+
+RETURN VALUE
+------------
+Size of the message data (bytes).
+
+
+ERRORS
+------
+No errors are defined.
+
+
+EXAMPLE
+-------
+----
+zmq_msg_t msg;
+rc = zmq_msg_init (&msg);
+assert (rc == 0);
+rc = zmq_recv (s, &msg, 0);
+assert (rc == 0);
+size_t msg_size = zmq_msg_size (&msg);
+----
+
+
+SEE ALSO
+--------
+linkzmq:zmq_msg_init[3]
+linkzmq:zmq_msg_init_size[3]
+linkzmq:zmq_msg_init_data[3]
+linkzmq:zmq_msg_close[3]
+
+
+AUTHOR
+------
+Martin Sustrik <sustrik at 250bpm dot com>