diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-01-23 15:48:46 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-01-23 15:48:46 -0800 |
| commit | b2800c58d63dc1b53557ea9294b323c3b1f90dab (patch) | |
| tree | 86404a3611af3730f8e431e7a97c0c03fc5d3afe /docs/nng_msg_body.adoc | |
| parent | 35e05eb93404be5bd2c6ae8000336486a2e26d05 (diff) | |
| download | nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.gz nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.bz2 nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.zip | |
Add message handling man pages.
Note that we're also no longer overriding the source formatter or
the icons for new pages, since we can supply that on the command
line in the script that generates output.
Diffstat (limited to 'docs/nng_msg_body.adoc')
| -rw-r--r-- | docs/nng_msg_body.adoc | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/nng_msg_body.adoc b/docs/nng_msg_body.adoc new file mode 100644 index 00000000..a5b1e536 --- /dev/null +++ b/docs/nng_msg_body.adoc @@ -0,0 +1,66 @@ += nng_msg_body(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +== NAME + +nng_msg_body - return message body + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> + +void *nng_msg_body(nng_msg *msg); +----------- + +== DESCRIPTION + +The `nng_msg_body()` function returns a pointer to the start of the body +content of the message _msg_. + +NOTE: The value returned by this is invalidated by a call to any of the +functions that modify the message itself. Such functions are +<<nng_msg_free#,nng_msg_free(3)>>, <<nng_msg_realloc#,nng_msg_realloc(3)>>, +any of the <<nng_msg_trim#,nng_msg_trim(3)>>, +<<nng_msg_chop#,nng_msg_chop(3)>>, <<nng_msg_append#,nng_msg_append(3)>>, +or <<nng_msg_insert#,nng_msg_insert(3)>> variants. + + +== RETURN VALUES + +Pointer to start of message body. + +== ERRORS + +None. + +== SEE ALSO + +<<nng_msg_alloc#,nng_msg_alloc(3)>>, +<<nng_msg_append#,nng_msg_append(3)>>, +<<nng_msg_chop#,nng_msg_chop(3)>>, +<<nng_msg_free#,nng_msg_free(3)>>, +<<nng_msg_insert#,nng_msg_insert(3)>>, +<<nng_msg_len#,nng_msg_len(3)>>, +<<nng_msg_realloc#,nng_msg_realloc(3)>>, +<<nng_msg_trim#,nng_msg_trim(3)>>, +<<nng#,nng(7)>> + + +== COPYRIGHT + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. |
