diff options
Diffstat (limited to 'docs/man/nn_freemsg.3compat.adoc')
| -rw-r--r-- | docs/man/nn_freemsg.3compat.adoc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/man/nn_freemsg.3compat.adoc b/docs/man/nn_freemsg.3compat.adoc new file mode 100644 index 00000000..d23d9f0a --- /dev/null +++ b/docs/man/nn_freemsg.3compat.adoc @@ -0,0 +1,48 @@ += 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 +`<<nn_allocmsg.3compat#,nn_allocmsg()>>`` or similar functions. + +NOTE: This function is provided for API +<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_. +Consider using the relevant <<libnng.3#,modern API>> instead. + +== RETURN VALUES + +This function always returns 0. + +== ERRORS + +None. + +== SEE ALSO + +<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>, +<<nn_freemsg.3compat#,nn_freemsg(3compat)>>, +<<nn_errno.3compat#,nn_errno(3compat)>>, +<<nng_compat.3compat#,nng_compat(3compat)>>, +<<nng.7#,nng(7)>> |