nanomsg next generation NNG  
Home GitHub Documentation

NOTE: This documentation is for version 1.0.0 of nng, but the latest released version is 1.1.0. Please see the documentation for 1.1.0 for the most up-to-date information.
nng_msg_alloc(3)

SYNOPSIS

#include <nng/nng.h>

typedef struct nng_msg nng_msg;

DESCRIPTION

An nng_msg represents a single message sent between Scalability Protocols peers. Messages internally have a body, containing the application supplied payload, and a header, containing protocol specific routing and similar related information.

Using the message-oriented functions in the nng API is a good way to reduce the likelihood of data copies and improve application performance.

Messages are allocated using the nng_msg_alloc() function, and are deallocated using the nng_msg_free() function.

In addition there are other functions used to access message contents, including adding data to either the beginning or end of the message, automatic data conversion, and removing data from the beginning or end. These functions are designed to try to avoid copying message contents by making use of scratch areas at the beginning and end of the message.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM

Insufficient free memory exists to allocate a message.

NNG Reference Manual v1.0.0 © 2018 Staysail Systems, Inc, © 2018 Capitar IT Group BV
This document is supplied under the MIT License.
nanomsg™ and nng™ are trademarks of Garrett D'Amore.