doc: document socket send API, including an example

5 files changed, 135 insertions, 288 deletions

diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc
deleted file mode 100644
index 7037f547..00000000
--- a/docs/man/nng_send.3.adoc
+++ /dev/null
@@ -1,100 +0,0 @@
-= nng_send(3)
-//
-// 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
-
-nng_send - send data
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_send(nng_socket s, void *data, size_t size, int flags);
-----
-
-== DESCRIPTION
-
-The `nng_send()` function sends a message containing the _data_ of
-length _size_ using the xref:nng_socket.5.adoc[socket] _s_.
-
-NOTE: The semantics of what sending a message means vary from protocol to
-protocol, so examination of the protocol documentation is encouraged.
-(For example, with an xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that
-any peers who have a suitable subscription will be able to receive it using
-xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.)
-Furthermore, some protocols may not support sending data (such as
-xref:nng_sub.7.adoc[_sub_]) or may require other conditions.
-(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data,
-which are responses to requests, until they have first received a request.)
-
-The _flags_ may contain either of (or neither of) the following values:
-
-`NNG_FLAG_NONBLOCK`::
-    The function returns immediately, regardless of whether
-    the socket is able to accept the data or not.  If the socket 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.
-
-`NNG_FLAG_ALLOC`::
-    The _data_ was allocated using xref:nng_alloc.3.adoc[`nng_alloc()`], or was
-    obtained from a call to xref:nng_recv.3.adoc[`nng_recv()`] with
-    the `NNG_FLAG_ALLOC` flag.
-    If this function returns success, then the _data_ is "owned" by the
-    function, and it will assume responsibility for calling
-    xref:nng_free.3.adoc[`nng_free()`] when it is no longer needed.
-    In the absence of this flag, the _data_ is copied by the implementation
-    before the function returns to the caller.
-
-TIP: The `NNG_FLAG_ALLOC` flag can be used to reduce data copies, thereby
-increasing performance.
-
-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`,
-such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only.
-
-IMPORTANT: When using `NNG_FLAG_ALLOC`, it is important that the value of _size_
-match the actual allocated size of the data.
-Using an incorrect size results
-in unspecified behavior, which may include heap corruption, program crashes,
-or trans-dimensional mutation of the program's author.
-
-== 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 socket _s_ 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 for socket _s_ does not support sending.
-`NNG_ESTATE`:: The socket _s_ cannot send data in this state.
-`NNG_ETIMEDOUT`:: The operation timed out.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_alloc.3.adoc[nng_alloc(3)],
-xref:nng_free.3.adoc[nng_free(3)],
-xref:nng_recv.3.adoc[nng_recv(3)],
-xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_send_aio.3.adoc b/docs/man/nng_send_aio.3.adoc
deleted file mode 100644
index e8fc2005..00000000
--- a/docs/man/nng_send_aio.3.adoc
+++ /dev/null
@@ -1,91 +0,0 @@
-= nng_send_aio(3)
-//
-// 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
-
-nng_send_aio - send message asynchronously
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_send_aio(nng_socket s, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_send_aio()` sends a xref:nng_msg.5.adoc[message] using the
-xref:nng_socket.5.adoc[socket] _s_ asynchronously.
-
-The message to send must have previously been set on the _aio_
-using the xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`] function.
-The function assumes ownership of the message.
-
-If the message was successfully queued for delivery to the socket,
-then the _aio_ will be completed, and xref:nng_aio_result.3.adoc[`nng_aio_result()`]
-will return zero.  In this case the socket will dispose of the
-message when it is finished with it.
-
-NOTE: The operation will be completed, and the callback associated
-with the _aio_ executed, as soon as the socket accepts the message
-for sending.
-This does _not_ indicate that the message was actually delivered, as it
-may still be buffered in the sending socket, buffered in the receiving
-socket, or in flight over physical media.
-
-If the operation fails for any reason (including cancellation or timeout),
-then the _aio_ callback will be executed and
-xref:nng_aio_result.3.adoc[`nng_aio_result()`]
-will return a non-zero error status.
-In this case, the callback has a responsibility to retrieve the message from
-the _aio_ with
-xref:nng_aio_get_msg.3.adoc[`nng_aio_get_msg()`] and dispose of it appropriately.
-(This may include retrying the send operation on the same or a different
-socket, or deallocating the message with xref:nng_msg_free.3.adoc[`nng_msg_free()`].)
-
-NOTE: The semantics of what sending a message means varies from protocol to
-protocol, so examination of the protocol documentation is encouraged.
-(For example, with a xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that
-any peers who have a suitable subscription will be able to receive it using
-xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.)
-Furthermore, some protocols may not support sending (such as
-xref:nng_sub.7.adoc[_sub_]) or may require other conditions.
-(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which
-are responses to requests, until they have first received a request.)
-
-== RETURN VALUES
-
-None.  (The operation completes asynchronously.)
-
-== ERRORS
-
-[horizontal]
-`NNG_ECANCELED`:: The operation was aborted.
-`NNG_ECLOSED`:: The socket _s_ is not open.
-`NNG_EMSGSIZE`:: The message is too large.
-`NNG_ENOMEM`:: Insufficient memory is available.
-`NNG_ENOTSUP`:: The protocol for socket _s_ does not support sending.
-`NNG_ESTATE`:: The socket _s_ cannot send data in this state.
-`NNG_ETIMEDOUT`:: The send timeout expired.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)],
-xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)],
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_sendmsg.3.adoc b/docs/man/nng_sendmsg.3.adoc
deleted file mode 100644
index 5b7a73ee..00000000
--- a/docs/man/nng_sendmsg.3.adoc
+++ /dev/null
@@ -1,94 +0,0 @@
-= nng_sendmsg(3)
-//
-// 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
-
-nng_sendmsg - send message
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_sendmsg(nng_socket s, nng_msg *msg, int flags);
-----
-
-== DESCRIPTION
-
-The `nng_sendmsg()` sends message _msg_ using the socket _s_.
-
-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.
-
-TIP: Using this function gives access to the message structure, and may
-offer more functionality than the simpler xref:nng_send.3.adoc[`nng_send()`] function.
-
-NOTE: The semantics of what sending a message means vary from protocol to
-protocol, so examination of the protocol documentation is encouraged.
-(For example, with a xref:nng_pub.7.adoc[_pub_] socket the data is broadcast, so that
-any peers who have a suitable subscription will be able to receive it using
-xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.)
-Furthermore, some protocols may not support sending (such as
-xref:nng_sub.7.adoc[_sub_]) or may require other conditions.
-(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which
-are responses to requests, until they have first received a request.)
-
-The _flags_ may contain the following value:
-
-`NNG_FLAG_NONBLOCK`::
-    The function returns immediately, regardless of whether
-    the socket is able to accept the data or not.
-    If the socket 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`,
-such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only.
-
-== 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 socket _s_ 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 for socket _s_ does not support sending.
-`NNG_ESTATE`:: The socket _s_ 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_recvmsg.3.adoc[nng_recvmsg(3)],
-xref:nng_send.3.adoc[nng_send(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/ref/api/sock.md b/docs/ref/api/sock.md
index 40190d33..ede67c3f 100644
--- a/docs/ref/api/sock.md
+++ b/docs/ref/api/sock.md
@@ -149,6 +149,84 @@ a result of [`NNG_ECLOSED`].
 > [!NOTE]
 > Closing the socket may be disruptive to transfers that are still in progress.
 
+## Sending Messages
+
+```c
+int nng_send(nng_socket s, void *data, size_t size, int flags);
+int nng_sendmsg(nng_socket s, nng_msg *msg, int flags);
+void nng_send_aio(nng_socket s, nng_aio *aio);
+```
+
+These functions ({{i:`nng_send`}}, {{i:`nng_sendmsg`}}, and {{i:`nng_send_aio`}}) send
+messages over the socket _s_. The differences in their behaviors are as follows.
+
+> [!NOTE]
+> The semantics of what sending a message means varies from protocol to
+> protocol, so examination of the protocol documentation is encouraged.
+> Additionally, some protocols may not support sending at all or may require other pre-conditions first.
+> (For example, [REP][rep] sockets cannot normally send data until they have first received a request,
+> while [SUB][sub] sockets can only receive data and never send it.)
+
+### nng_send
+
+The `nng_send` function is the simplest to use, but is the least efficient.
+It sends the content in _data_, as a message of _size_ bytes. The _flags_ is a bit mask
+made up of zero or more of the following values:
+
+- {{i:`NNG_FLAG_NONBLOCK`}}: <a name="NNG_FLAG_NONBLOCK"></a>
+  If the socket cannot accept more data at this time, it does not block, but returns immediately
+  with a status of [`NNG_EAGAIN`]. If this flag is absent, the function will wait until data can be sent.
+
+- {{i:`NNG_FLAG_ALLOC`}}: <a name="NNG_FLAG_ALLOC"></a>
+  The _data_ was allocated using [`nng_alloc`] or was obtained from a call to [`nng_recv`] also with
+  the `NNG_FLAG_ALLOC` flag. If this function succeeds, then it will dispose of the _data_, deallocating it
+  once the transmission is complete. If this function returns a non-zero status, the caller retains the responsibility
+  of disposing the data. The benefit of this flag is that it can eliminate a data copy and allocation. Without the flag
+  the socket will make a duplicate copy of _data_ for use by the operation, before returning to the caller.
+
+> [!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`,
+> such as with [PUB][pub] sockets, which are best-effort delivery only.
+
+> [!IMPORTANT]
+> When using `NNG_FLAG_ALLOC`, it is important that the value of _size_ match the actual allocated size of the data.
+> Using an incorrect size results in unspecified behavior, which may include heap corruption, program crashes,
+> or other undesirable effects.
+
+### nng_sendmsg
+
+The `nng_sendmsg` function sends the _msg_ over the socket _s_.
+
+If this function returns zero, then the socket will dispose of _msg_ when the transmission is complete.
+If the function returns a non-zero status, then the call retains the responsibility for disposing of _msg_.
+
+The _flags_ can contain the value [`NNG_FLAG_NONBLOCK`], indicating that the function should not wait if the socket
+cannot accept more data for sending. In such a case, it will return [`NNG_EAGAIN`].
+
+> [!TIP]
+> This function is preferred over [`nng_send`], as it gives access to the message structure and eliminates both
+> a data copy and allocation.
+
+### nng_send_aio
+
+The `nng_send_aio` function sends a message asynchronously, using the [`nng_aio`] _aio_, over the socket _s_.
+The message to send must have been set on _aio_ using the [`nng_aio_set_msg`] function.
+
+If the operation completes successfully, then the socket will have disposed of the message.
+However, if it fails, then callback of _aio_ should arrange for a final disposition of the message.
+(The message can be retrieved from _aio_ with [`nng_aio_get_msg`].)
+
+Note that callback associated with _aio_ may be called _before_ the message is finally delivered to the recipient.
+For example, the message may be sitting in queue, or located in TCP buffers, or even in flight.
+
+> [!TIP]
+> This is the preferred function to use for sending data on a socket. While it does require a few extra
+> steps on the part of the application, the lowest latencies and highest performance will be achieved by using
+> this function instead of [`nng_send`] or [`nng_sendmsg`].
+
 ## Polling Socket Events
 
 ```c
@@ -198,4 +276,58 @@ were available in previous versions of NNG.
 nng_socket s = NNG_SOCKET_INITIALIZER;
 ```
 
+### Example 2: Publishing a Timestamp
+
+This example demonstrates the use of [`nng_aio`], [`nng_send_aio`], and [`nng_sleep_aio`] to
+build a service that publishes a timestamp at one second intervals. Error handling is elided for the
+sake of clarity.
+
+```c
+#include <stdlib.h>
+#include <nng/nng.h>
+#include <nng/protocol/pubsub0/pub.h>
+
+struct state {
+    nng_socket s;
+    bool sleeping;
+    nng_aio *aio;
+};
+
+static struct state state;
+
+void callback(void *arg) {
+    nng_msg *msg;
+    nng_time now;
+    struct state *state = arg;
+    if (nng_aio_result(state->aio) != 0) {
+        nng_log_err("Error %s occurred", nng_strerror(nng_aio_result(state->aio)));
+        return; // terminate the callback loop
+    }
+    if (state->sleeping) {
+        state->sleeping = false;
+        nng_msg_alloc(&msg, sizeof (nng_time));
+        now = nng_clock();
+        nng_msg_append(msg, &now, sizeof (now)); // note: native endian
+        nng_aio_set_msg(state->aio, msg);
+        nng_send_aio(state->s, state->aio);
+    } else {
+        state->sleeping = true;
+        nng_sleep_aio(1000, state->aio); // 1000 ms == 1 second
+    }
+}
+
+int main(int argc, char **argv) {
+    const char *url = argv[1]; // should check this
+
+    nng_aio_alloc(&state.aio, NULL, NULL);
+    nng_pub0_open(&state.s);
+    nng_listen(state.s, url, NULL, 0);
+    state.sleeping = 0;
+    nng_sleep_aio(1, state.aio); // kick it off right away
+    for(;;) {
+        nng_msleep(0x7FFFFFFF); // infinite, could use pause or sigsuspend
+    }
+}
+```
+
 {{#include ../xref.md}}
diff --git a/docs/ref/xref.md b/docs/ref/xref.md
index 355ebe37..e31f4847 100644
--- a/docs/ref/xref.md
+++ b/docs/ref/xref.md
@@ -158,7 +158,6 @@
 [`nng_aio_reset`]: /TODO.md
 [`nng_aio_start`]: /TODO.md
 [`nng_aio_set_output`]: /TODO.md
-[`nng_send`]: /TODO.md
 [`nng_recv`]: /TODO.md
 [`nng_listener_get_url`]: /TODO.md
 [`nng_dialer_get_url`]: /TODO.md
@@ -174,9 +173,10 @@
 [`nng_listener_close`]: /TODO.md
 [`nng_socket_set`]: /TODO.md
 [`nng_socket_get`]: /TODO.md
-[`nng_send`]: /TODO.md
+[`nng_send`]: /api/sock.md#nng_send
+[`nng_sendmsg`]: /api/sock.md#nng_sendmsg
+[`nng_send_aio`]: /api/sock.md#nng_send_aio
 [`nng_recv`]: /TODO.md
-[`nng_sendmsg`]: /TODO.md
 [`nng_recvmsg`]: /TODO.md
 
 <!-- Macros -->