0
0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-26 23:01:04 +08:00
libzmq/doc/zmq_msg_size.adoc
Francesco Montorsi b6ca9b2983 Feature: modernize API documentation
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator
* migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles)
* remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that
* add HTML output support to the doc/Makefile by using asciidoctor
* change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc)
* remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages
* add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors
* removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
2023-10-25 23:59:38 +02:00

42 lines
985 B
Plaintext

= zmq_msg_size(3)
== NAME
zmq_msg_size - retrieve message content size in bytes
== SYNOPSIS
*size_t zmq_msg_size (zmq_msg_t '*msg');*
== DESCRIPTION
The _zmq_msg_size()_ function shall return the size in bytes of the content of
the message object referenced by 'msg'.
CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
_zmq_msg_ family of functions.
== RETURN VALUE
Upon successful completion, _zmq_msg_size()_ shall return the size of the
message content in bytes.
== ERRORS
No errors are defined.
== SEE ALSO
xref:zmq_msg_data.adoc[zmq_msg_data]
xref:zmq_msg_init.adoc[zmq_msg_init]
xref:zmq_msg_init_size.adoc[zmq_msg_init_size]
xref:zmq_msg_init_buffer.adoc[zmq_msg_init_buffer]
xref:zmq_msg_init_data.adoc[zmq_msg_init_data]
xref:zmq_msg_close.adoc[zmq_msg_close]
xref:zmq.adoc[zmq]
== AUTHORS
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.