This documentation is for the TIP (development tree) of NNG and may represent unreleased changes or functionality that is experimental, and is subject to change before release. The latest released version is v1.8.0. See the documentation for v1.8.0 for the most up-to-date information.

nng_msg_realloc(3)

NAME

nng_msg_realloc - reallocate a message

SYNOPSIS

#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.

nng_msg_realloc is suitable for creating space for direct writing of data. When appending many small pieces of data to a message using nng_msg_append(), allocations may be reduced by first using nng_msg_reserve() to create sufficient space. In any case, reallocating or appending to a message is guaranteed to succeed if the resulting body length is less than nng_msg_capacity().
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