mesytec-mnode/external/nng/docs/man/nn_freemsg.3compat.adoc

49 lines
1.2 KiB
Text

= nn_freemsg(3compat)
//
// 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
nn_freemsg - free message (compatible API)
== SYNOPSIS
[source,c]
----
#include <nanomsg/nn.h>
int nn_freemsg(void *msg);
----
== DESCRIPTION
The `nn_freemsg()` deallocates a message previously allocated with
xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`] or similar functions.
NOTE: This function is provided for API
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
== RETURN VALUES
This function always returns 0.
== ERRORS
None.
== SEE ALSO
[.text-left]
xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)],
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]