diff options
Diffstat (limited to 'docs/nng_msg_realloc.adoc')
| -rw-r--r-- | docs/nng_msg_realloc.adoc | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/nng_msg_realloc.adoc b/docs/nng_msg_realloc.adoc deleted file mode 100644 index 47c9540b..00000000 --- a/docs/nng_msg_realloc.adoc +++ /dev/null @@ -1,61 +0,0 @@ -= nng_msg_alloc(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// This document 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_realloc(nng_msg *msg, size_t size); ------------ - -== DESCRIPTION - -The `nng_msg_realloc()` function re-allocates a message so that it has -a body of length _size_. This message attempts to avoid extra allocations, -and will reuse the existing memory when possible. - -TIP: One way to further reduce message allocations is to allocate a message -larger than needed, then use this function or <<nng_msg_chop#,nng_msg_chop(3)>> -to reduce the message size to that actually needed. The extra space left -over will still be present in the message, so that when the message size -needs to grow due to this function or <<nng_msg_append#,nng_msg_append(3)>> -no actual memory allocations need to take place. - -NOTE: Pointers to message body and header content obtained prior to this -function must not be in use, as the underlying memory used for the message -may have changed, particularly if the message size is increasing. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient free memory exists to reallocate a message. - -== SEE ALSO - -<<nng_msg_alloc#,nng_msg_alloc(3)>>, -<<nng_msg_append#,nng_msg_append(3)>>, -<<nng_msg_body#,nng_msg_body(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_trim#,nng_msg_trim(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |
