From 74a12ffc8b37f2dae4b3002e86f33b8ca52df22d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 29 Dec 2019 23:21:33 -0800 Subject: man page updates for 1.2 --- man/v1.2/nn_allocmsg.3compat.html | 631 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 631 insertions(+) create mode 100644 man/v1.2/nn_allocmsg.3compat.html (limited to 'man/v1.2/nn_allocmsg.3compat.html') diff --git a/man/v1.2/nn_allocmsg.3compat.html b/man/v1.2/nn_allocmsg.3compat.html new file mode 100644 index 00000000..972b97f3 --- /dev/null +++ b/man/v1.2/nn_allocmsg.3compat.html @@ -0,0 +1,631 @@ +--- +version: 1.2 +layout: refman +--- + + + + + + + +nn_allocmsg(3compat) + + + + + + + +
+
+

SYNOPSIS

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

+
+
+ + + + + +
+ + +This function is provided for API +compatibility with legacy libnanomsg. +Consider using the relevant 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 +nn_freemsg() or +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

+
+
+ + + + + + + + + + + + + +
+ENOMEM + +

Insufficient memory is available.

+
+EINVAL + +

An invalid size or type was specified.

+
+ETERM + +

The library is shutting down.

+
+
+
+
+
+

SEE ALSO

+
+
+

nn_errno(3compat), +nn_freemsg(3compat), +nn_reallocmsg(3compat), +nn_send(3compat), +nng_compat(3compat), +nng(7)

+
+
+
+
+ + -- cgit v1.2.3-70-g09d2