aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nn_recv.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_recv.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_recv.3compat.adoc')
-rw-r--r--docs/man/nn_recv.3compat.adoc75
1 files changed, 0 insertions, 75 deletions
diff --git a/docs/man/nn_recv.3compat.adoc b/docs/man/nn_recv.3compat.adoc
deleted file mode 100644
index 2a71714d..00000000
--- a/docs/man/nn_recv.3compat.adoc
+++ /dev/null
@@ -1,75 +0,0 @@
-= nn_recv(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_recv - receive data (compatible API)
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nanomsg/nn.h>
-
-int nn_recv(int sock, void *data, size_t size, int flags)
-----
-
-== DESCRIPTION
-
-The `nn_recv()` function receives a message from the socket _sock_.
-The message body must fit within _size_ bytes, and will be stored
-at the location specified by _data_, unless _size_ is the
-special value `NN_MSG`, indicating a zero-copy operation.
-
-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.
-
-If _size_ has the special value `NN_MSG`, then a zero-copy operation
-is performed.
-In this case, instead of copying the message data into the address
-specified by _data_, a new message large enough to hold the message data
-will be allocated (as if by the
-function xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]), and the message
-payload will be stored accordingly.
-In this case, the value stored at _data_ will not be message data,
-but a pointer to the message itself.
-In this case, on success, the caller shall take responsibility for
-the final disposition of the message (such as by sending it to
-another peer using xref:nn_send.3compat.adoc[`nn_send()`]) or
-xref:nn_freemsg.3compat.adoc[`nn_freemsg()`].
-
-The _flags_ field may contain the special flag `NN_DONTWAIT`.
-In this case, if the no message is available for immediate receipt,
-the operation shall not block, but instead will fail with the error `EAGAIN`.
-
-== RETURN VALUES
-
-This function returns the number of bytes sent on success, and -1 on error.
-
-== ERRORS
-
-[horizontal]
-`EAGAIN`:: The operation would block.
-`EBADF`:: The socket _sock_ is not open.
-`EFSM`:: The socket cannot receive in this state.
-`ENOTSUP`:: This protocol cannot receive.
-`ETIMEDOUT`:: Operation timed out.
-
-== SEE ALSO
-
-[.text-left]
-xref:nn_errno.3compat.adoc[nn_errno(3compat)],
-xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)],
-xref:nn_send.3compat.adoc[nn_send(3compat)],
-xref:nn_socket.3compat.adoc[nn_socket(3compat)],
-xref:nng_compat.3compat.adoc[nn_compat(3compat)],
-xref:nng.7.adoc[nng(7)]