aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ctx_sendmsg.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-01 19:11:54 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-01 19:11:54 -0800
commitf293e96b03b22c6a91140b118c4e15059e285543 (patch)
tree1a7c333e6e5a4209831ab2e7aa8c2a43d98aa2e8 /docs/man/nng_ctx_sendmsg.3.adoc
parentf7bf24f429cbc488b861ab1b1e4cf1983af56295 (diff)
downloadnng-f293e96b03b22c6a91140b118c4e15059e285543.tar.gz
nng-f293e96b03b22c6a91140b118c4e15059e285543.tar.bz2
nng-f293e96b03b22c6a91140b118c4e15059e285543.zip
docs: convert the context docs to mdbook
Diffstat (limited to 'docs/man/nng_ctx_sendmsg.3.adoc')
-rw-r--r--docs/man/nng_ctx_sendmsg.3.adoc84
1 files changed, 0 insertions, 84 deletions
diff --git a/docs/man/nng_ctx_sendmsg.3.adoc b/docs/man/nng_ctx_sendmsg.3.adoc
deleted file mode 100644
index 8e2c97f4..00000000
--- a/docs/man/nng_ctx_sendmsg.3.adoc
+++ /dev/null
@@ -1,84 +0,0 @@
-= nng_ctx_sendmsg(3)
-//
-// Copyright 2021 Staysail Systems, Inc. <info@staysail.tech>
-//
-// 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
-
-nng_ctx_sendmsg - send message using context
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_ctx_sendmsg(nng_ctx c, nng_msg *msg, int flags);
-----
-
-== DESCRIPTION
-
-The `nng_ctx_sendmsg()` sends message _msg_ using the context _ctx_.
-
-If the function returns zero, indicating it has accepted the message for
-delivery, then the _msg_ is owned by the socket _s_, and the caller
-must not make any further use of it.
-The socket will free the message when it is finished.
-
-If the function returns non-zero, then it is the caller's responsibility
-to dispose of the _msg_, which may include freeing it, sending it to
-another socket, or simply trying again later.
-
-NOTE: The semantics of what sending a message means vary from protocol to
-protocol, so examination of the protocol documentation is encouraged.
-
-The _flags_ may contain the following value:
-
-`NNG_FLAG_NONBLOCK`::
- The function returns immediately, regardless of whether
- the context is able to accept the data or not.
- If the context is unable to accept the data (such as if backpressure exists
- because the peers are consuming messages too slowly, or no peer is present),
- then the function will return with `NNG_EAGAIN`.
- If this flag is not specified, then the function will block if such a
- condition exists.
-
-
-NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may
-be queues between the sender and the receiver.
-Furthermore, there is no guarantee that the message has actually been delivered.
-Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
-`NNG_ECLOSED`:: The context or socket is not open.
-`NNG_EINVAL`:: An invalid set of _flags_ was specified.
-`NNG_EMSGSIZE`:: The value of _size_ is too large.
-`NNG_ENOMEM`:: Insufficient memory is available.
-`NNG_ENOTSUP`:: The protocol does not support sending.
-`NNG_ESTATE`:: The context cannot send data in this state.
-`NNG_ETIMEDOUT`:: The operation timed out.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_ctx_open.3.adoc[nng_ctx_open(3)],
-xref:nng_ctx_recvmsg.3.adoc[nng_ctx_recvmsg(3)],
-xref:nng_ctx_send.3.adoc[nng_ctx_send(3)],
-xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng_ctx.5.adoc[nng_ctx(5)],
-xref:nng.7.adoc[nng(7)]