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_alloc.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_alloc.adoc')
| -rw-r--r-- | docs/nng_msg_alloc.adoc | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/nng_msg_alloc.adoc b/docs/nng_msg_alloc.adoc new file mode 100644 index 00000000..8446c358 --- /dev/null +++ b/docs/nng_msg_alloc.adoc @@ -0,0 +1,64 @@ += nng_msg_alloc(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_alloc - allocate a message + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> + +int nng_msg_alloc(nng_msg **msgp, size_t size); +----------- + + +== DESCRIPTION + +The `nng_msg_alloc()` function allocates a new message with body length _size_ +and stores the result in __msgp__. +Messages allocated with this function contain a body and optionally a header. +They are used with receive and transmit functions. + + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + + +== ERRORS + +`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. + + +== SEE ALSO + +<<nng_msg_free#,nng_msg_free(3)>>, +<<nng_msg_body#,nng_msg_body(3)>>, +<<nng_msg_dup#,nng_msg_dup(3)>>, +<<nng_msg_header#,nng_msg_header(3)>>, +<<nng_msg_header_len#,nng_msg_header_len(3)>>, +<<nng_msg_len#,nng_msg_len(3)>>, +<<nng_msg_realloc#,nng_msg_realloc(3)>>, +<<nng_strerror#,nng_strerror(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]. |
