aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nn_allocmsg.3compat.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-09-07 10:05:27 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 13:53:57 -0700
commit74adece2303ab7c2b05459c7ff24b362e9660068 (patch)
tree61aa056b0511c444cd6d3163bbbff7fb39e1e9e7 /docs/man/nn_allocmsg.3compat.adoc
parentcd77f58b041889f35887736c59b3eaedb60bd84c (diff)
downloadnng-74adece2303ab7c2b05459c7ff24b362e9660068.tar.gz
nng-74adece2303ab7c2b05459c7ff24b362e9660068.tar.bz2
nng-74adece2303ab7c2b05459c7ff24b362e9660068.zip
Remove the documentation for 3compat.
Diffstat (limited to 'docs/man/nn_allocmsg.3compat.adoc')
-rw-r--r--docs/man/nn_allocmsg.3compat.adoc67
1 files changed, 0 insertions, 67 deletions
diff --git a/docs/man/nn_allocmsg.3compat.adoc b/docs/man/nn_allocmsg.3compat.adoc
deleted file mode 100644
index a53da55c..00000000
--- a/docs/man/nn_allocmsg.3compat.adoc
+++ /dev/null
@@ -1,67 +0,0 @@
-= nn_allocmsg(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_allocmsg - allocate message (compatible API)
-
-== SYNOPSIS
-
-[source,c]
-----
-#include <nanomsg/nn.h>
-
-void *nn_allocmsg(size_t size, int type);
-----
-
-== DESCRIPTION
-
-The `nn_allocmsg()` allocates a message structure of size _size_, and is
-primarily used to support zero-copy send operations, making use of the
-`NNG_MSG` special size indicator.
-The value returned is a pointer to the start of the message payload buffer.
-
-The value of _size_ must be positive, and small enough to hold reasonable
-message data plus book-keeping information.
-
-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.
-
-The value of _type_ *must* be zero.
-(This argument was reserved to support different kinds of memory spaces
-for RDMA devices, but this was never developed in the legacy API.)
-
-The returned message must be disposed of by either
-xref:nn_freemsg.3compat.adoc[`nn_freemsg()`] or
-xref:nn_send.3compat.adoc[`nn_send()`] when the caller is finished with it.
-
-== RETURN VALUES
-
-This function returns a pointer to message buffer space, or `NULL`
-on failure.
-
-== ERRORS
-
-[horizontal]
-`ENOMEM`:: Insufficient memory is available.
-`EINVAL`:: An invalid _size_ or _type_ was specified.
-`ETERM`:: The library is shutting down.
-
-== SEE ALSO
-
-[.text-left]
-xref:nn_errno.3compat.adoc[nn_errno(3compat)],
-xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
-xref:nn_reallocmsg.3compat.adoc[nn_reallocmsg(3compat)],
-xref:nn_send.3compat.adoc[nn_send(3compat)],
-xref:nng_compat.3compat.adoc[nng_compat(3compat)],
-xref:nng.7.adoc[nng(7)]