summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/aio
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/src/api/aio')
-rw-r--r--docs/reference/src/api/aio/index.md32
-rw-r--r--docs/reference/src/api/aio/nng_aio_abort.md8
-rw-r--r--docs/reference/src/api/aio/nng_aio_alloc.md30
-rw-r--r--docs/reference/src/api/aio/nng_aio_busy.md8
-rw-r--r--docs/reference/src/api/aio/nng_aio_cancel.md8
-rw-r--r--docs/reference/src/api/aio/nng_aio_count.md10
-rw-r--r--docs/reference/src/api/aio/nng_aio_free.md6
-rw-r--r--docs/reference/src/api/aio/nng_aio_get_msg.md8
-rw-r--r--docs/reference/src/api/aio/nng_aio_get_output.md10
-rw-r--r--docs/reference/src/api/aio/nng_aio_result.md10
-rw-r--r--docs/reference/src/api/aio/nng_aio_set_input.md6
-rw-r--r--docs/reference/src/api/aio/nng_aio_set_msg.md6
-rw-r--r--docs/reference/src/api/aio/nng_aio_set_timeout.md8
-rw-r--r--docs/reference/src/api/aio/nng_aio_stop.md10
-rw-r--r--docs/reference/src/api/aio/nng_aio_wait.md6
15 files changed, 83 insertions, 83 deletions
diff --git a/docs/reference/src/api/aio/index.md b/docs/reference/src/api/aio/index.md
index 4c49ff78..84c6d6e1 100644
--- a/docs/reference/src/api/aio/index.md
+++ b/docs/reference/src/api/aio/index.md
@@ -1,4 +1,4 @@
-# Interfaces for Aysnchronous I/O
+# Aysnchronous I/O
_NNG_ provides rich support for {{i:asynchronous I/O}}.
This allows applications to achieve high levels of concurrency with a
@@ -57,18 +57,18 @@ complete [`nng_aio_wait()`](nng_aio_wait.md).
## See Also
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_count()](nng_aio_count.md),
-[nng_aio_free()](nng_aio_free.md),
-[nng_aio_get_input()](nng_aio_get_input.md),
-[nng_aio_get_msg()](nng_aio_get_msg.md),
-[nng_aio_get_output()](nng_aio_get_output.md),
-[nng_aio_result()](nng_aio_result.md),
-[nng_aio_set_input()](nng_aio_set_input.md),
-[nng_aio_set_iov()](nng_aio_set_iov.md),
-[nng_aio_set_msg()](nng_aio_set_msg.md),
-[nng_aio_set_timeout()](nng_aio_set_timeout.md),
-[nng_aio_stop()](nng_aio_stop.md),
-[nng_aio_wait()](nng_aio_wait.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_cancel](nng_aio_cancel.md),
+[nng_aio_count](nng_aio_count.md),
+[nng_aio_free](nng_aio_free.md),
+[nng_aio_get_input](nng_aio_get_input.md),
+[nng_aio_get_msg](nng_aio_get_msg.md),
+[nng_aio_get_output](nng_aio_get_output.md),
+[nng_aio_result](nng_aio_result.md),
+[nng_aio_set_input](nng_aio_set_input.md),
+[nng_aio_set_iov](nng_aio_set_iov.md),
+[nng_aio_set_msg](nng_aio_set_msg.md),
+[nng_aio_set_timeout](nng_aio_set_timeout.md),
+[nng_aio_stop](nng_aio_stop.md),
+[nng_aio_wait](nng_aio_wait.md)
diff --git a/docs/reference/src/api/aio/nng_aio_abort.md b/docs/reference/src/api/aio/nng_aio_abort.md
index 09e0fd2e..a94ffd30 100644
--- a/docs/reference/src/api/aio/nng_aio_abort.md
+++ b/docs/reference/src/api/aio/nng_aio_abort.md
@@ -1,4 +1,4 @@
-# nng_aio_abort()
+# nng_aio_abort
## NAME
@@ -30,6 +30,6 @@ has no effect.
## SEE ALSO
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_result()](nng_aio_result.md)
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_cancel](nng_aio_cancel.md),
+[nng_aio_result](nng_aio_result.md)
diff --git a/docs/reference/src/api/aio/nng_aio_alloc.md b/docs/reference/src/api/aio/nng_aio_alloc.md
index 1f3f6be8..5636f398 100644
--- a/docs/reference/src/api/aio/nng_aio_alloc.md
+++ b/docs/reference/src/api/aio/nng_aio_alloc.md
@@ -1,4 +1,4 @@
-# nng_aio_alloc()
+# nng_aio_alloc
## NAME
@@ -58,17 +58,17 @@ This function returns 0 on success, and non-zero otherwise.
## SEE ALSO
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_count()](nng_aio_count.md),
-[nng_aio_free()](nng_aio_free.md),
-[nng_aio_get_input()](nng_aio_get_input.md),
-[nng_aio_get_msg()](nng_aio_get_msg.md),
-[nng_aio_get_output()](nng_aio_get_output.md),
-[nng_aio_result()](nng_aio_result.md),
-[nng_aio_set_input()](nng_aio_set_input.md),
-[nng_aio_set_iov()](nng_aio_set_iov.md),
-[nng_aio_set_msg()](nng_aio_set_msg.md),
-[nng_aio_set_timeout()](nng_aio_set_timeout.md),
-[nng_aio_stop()](nng_aio_stop.md),
-[nng_aio_wait()](nng_aio_wait.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_cancel](nng_aio_cancel.md),
+[nng_aio_count](nng_aio_count.md),
+[nng_aio_free](nng_aio_free.md),
+[nng_aio_get_input](nng_aio_get_input.md),
+[nng_aio_get_msg](nng_aio_get_msg.md),
+[nng_aio_get_output](nng_aio_get_output.md),
+[nng_aio_result](nng_aio_result.md),
+[nng_aio_set_input](nng_aio_set_input.md),
+[nng_aio_set_iov](nng_aio_set_iov.md),
+[nng_aio_set_msg](nng_aio_set_msg.md),
+[nng_aio_set_timeout](nng_aio_set_timeout.md),
+[nng_aio_stop](nng_aio_stop.md),
+[nng_aio_wait](nng_aio_wait.md)
diff --git a/docs/reference/src/api/aio/nng_aio_busy.md b/docs/reference/src/api/aio/nng_aio_busy.md
index 2a794a83..826247fa 100644
--- a/docs/reference/src/api/aio/nng_aio_busy.md
+++ b/docs/reference/src/api/aio/nng_aio_busy.md
@@ -1,4 +1,4 @@
-# nng_aio_busy()
+# nng_aio_busy
## NAME
@@ -36,6 +36,6 @@ True if the _aio_ is busy, false otherwise.
## SEE ALSO
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_wait(3)](nng_aio_wait.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_wait](nng_aio_wait.md)
diff --git a/docs/reference/src/api/aio/nng_aio_cancel.md b/docs/reference/src/api/aio/nng_aio_cancel.md
index 63cad987..c523bf52 100644
--- a/docs/reference/src/api/aio/nng_aio_cancel.md
+++ b/docs/reference/src/api/aio/nng_aio_cancel.md
@@ -1,4 +1,4 @@
-# nng_aio_cancel()
+# nng_aio_cancel
## NAME
@@ -32,6 +32,6 @@ This function is the same as calling
## SEE ALSO
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_result()](nng_aio_result.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_result](nng_aio_result.md)
diff --git a/docs/reference/src/api/aio/nng_aio_count.md b/docs/reference/src/api/aio/nng_aio_count.md
index a4da3c64..ae844da0 100644
--- a/docs/reference/src/api/aio/nng_aio_count.md
+++ b/docs/reference/src/api/aio/nng_aio_count.md
@@ -1,4 +1,4 @@
-# nng_aio_count()
+# nng_aio_count
## NAME
@@ -38,7 +38,7 @@ The number of bytes transferred by the operation.
## SEE ALSO
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_result()](nng_aio_result.md),
-[nng_aio_set_iov()](nng_aio_set_iov.md),
-[nng_aio_wait()](nng_aio_wait.md)
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_result](nng_aio_result.md),
+[nng_aio_set_iov](nng_aio_set_iov.md),
+[nng_aio_wait](nng_aio_wait.md)
diff --git a/docs/reference/src/api/aio/nng_aio_free.md b/docs/reference/src/api/aio/nng_aio_free.md
index 3d73dd7c..ba400bba 100644
--- a/docs/reference/src/api/aio/nng_aio_free.md
+++ b/docs/reference/src/api/aio/nng_aio_free.md
@@ -1,4 +1,4 @@
-# nng_aio_free()
+# nng_aio_free
## NAME
@@ -30,5 +30,5 @@ This can be useful to discard the _aio_ object from within the callback for the
## SEE ALSO
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_stop()](nng_aio_stop.md)
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_stop](nng_aio_stop.md)
diff --git a/docs/reference/src/api/aio/nng_aio_get_msg.md b/docs/reference/src/api/aio/nng_aio_get_msg.md
index 55f712db..e77b7810 100644
--- a/docs/reference/src/api/aio/nng_aio_get_msg.md
+++ b/docs/reference/src/api/aio/nng_aio_get_msg.md
@@ -1,4 +1,4 @@
-# nng_aio_get_msg()
+# nng_aio_get_msg
## NAME
@@ -25,6 +25,6 @@ or that was previously stored with
## SEE ALSO
-[nng_aio_set_msg()](nng_aio_set_msg.md),
-[nng_recv_aio()](nng_recv_aio.md),
-[nng_msg](nng_msg.md)
+[nng_aio_set_msg](nng_aio_set_msg.md),
+[nng_recv_aio](nng_recv_aio.md),
+[Messages](../msg/index.md)
diff --git a/docs/reference/src/api/aio/nng_aio_get_output.md b/docs/reference/src/api/aio/nng_aio_get_output.md
index d25c1c20..9983696f 100644
--- a/docs/reference/src/api/aio/nng_aio_get_output.md
+++ b/docs/reference/src/api/aio/nng_aio_get_output.md
@@ -1,4 +1,4 @@
-# nng_aio_get_output()
+# nng_aio_get_output
## NAME
@@ -31,10 +31,10 @@ operations.
## RETURN VALUES
-The _index_‍th output from the operation, or `NULL`.
+The *index*th output from the operation, or `NULL`.
## SEE ALSO
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_set_output()](../aio_provider/nng_aio_set_output.md),
-[nng_aio_result()](nng_aio_result.md)
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_set_output](../aio_provider/nng_aio_set_output.md),
+[nng_aio_result](nng_aio_result.md)
diff --git a/docs/reference/src/api/aio/nng_aio_result.md b/docs/reference/src/api/aio/nng_aio_result.md
index 607f34d4..21038719 100644
--- a/docs/reference/src/api/aio/nng_aio_result.md
+++ b/docs/reference/src/api/aio/nng_aio_result.md
@@ -1,4 +1,4 @@
-# nng_aio_result()
+# nng_aio_result
## NAME
@@ -40,7 +40,7 @@ Various other return values are possible depending on the operation.
## SEE ALSO
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_wait()](nng_aio_wait.md),
-[nng_strerror()](../util/nng_strerror.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_wait](nng_aio_wait.md),
+[nng_strerror](../util/nng_strerror.md)
diff --git a/docs/reference/src/api/aio/nng_aio_set_input.md b/docs/reference/src/api/aio/nng_aio_set_input.md
index 1b3e0883..baf9587a 100644
--- a/docs/reference/src/api/aio/nng_aio_set_input.md
+++ b/docs/reference/src/api/aio/nng_aio_set_input.md
@@ -1,4 +1,4 @@
-# nng_aio_set_input()
+# nng_aio_set_input
## NAME
@@ -38,5 +38,5 @@ the [`nng_aio_get_input()`](nng_aio_get_input.md) function.
## SEE ALSO
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_get_input()](../aio_provider/nng_aio_get_input.md)
+[nng_aio_alloc](nng_aio_alloc.md),
+[nng_aio_get_input](../aio_provider/nng_aio_get_input.md)
diff --git a/docs/reference/src/api/aio/nng_aio_set_msg.md b/docs/reference/src/api/aio/nng_aio_set_msg.md
index 24ba9f60..c9b5c03a 100644
--- a/docs/reference/src/api/aio/nng_aio_set_msg.md
+++ b/docs/reference/src/api/aio/nng_aio_set_msg.md
@@ -23,6 +23,6 @@ for an asynchronous send operation (see
## SEE ALSO
-[nng_aio_get_msg()](nng_aio_get_msg.md),
-[nng_send_aio()](nng_send_aio.md),
-[nng_msg](nng_msg.md)
+[nng_aio_get_msg](nng_aio_get_msg.md),
+[nng_send_aio](nng_send_aio.md),
+[Messages](../msg/index.md)
diff --git a/docs/reference/src/api/aio/nng_aio_set_timeout.md b/docs/reference/src/api/aio/nng_aio_set_timeout.md
index e5ac3e8e..34daa6f4 100644
--- a/docs/reference/src/api/aio/nng_aio_set_timeout.md
+++ b/docs/reference/src/api/aio/nng_aio_set_timeout.md
@@ -1,4 +1,4 @@
-# nng_aio_set_timeout()
+# nng_aio_set_timeout
## NAME
@@ -48,6 +48,6 @@ or absolute timeout.
## SEE ALSO
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_result()](nng_aio_result.md),
-[nng_clock()](../util/nng_clock.md)
+[nng_aio_cancel](nng_aio_cancel.md),
+[nng_aio_result](nng_aio_result.md),
+[nng_clock](../util/nng_clock.md)
diff --git a/docs/reference/src/api/aio/nng_aio_stop.md b/docs/reference/src/api/aio/nng_aio_stop.md
index 8ac32a76..7838eda2 100644
--- a/docs/reference/src/api/aio/nng_aio_stop.md
+++ b/docs/reference/src/api/aio/nng_aio_stop.md
@@ -1,4 +1,4 @@
-# nng_aio_stop()
+# nng_aio_stop
## NAME
@@ -33,7 +33,7 @@ pending for it.
## SEE ALSO
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_free()](nng_aio_free.md),
-[nng_aio_begin()](nng_aio_begin.md),
-[nng_aio_wait()](nng_aio-wait.md)
+[nng_aio_cancel](nng_aio_cancel.md),
+[nng_aio_free](nng_aio_free.md),
+[nng_aio_begin](nng_aio_begin.md),
+[nng_aio_wait](nng_aio-wait.md)
diff --git a/docs/reference/src/api/aio/nng_aio_wait.md b/docs/reference/src/api/aio/nng_aio_wait.md
index be81378c..76198ca1 100644
--- a/docs/reference/src/api/aio/nng_aio_wait.md
+++ b/docs/reference/src/api/aio/nng_aio_wait.md
@@ -1,4 +1,4 @@
-# nng_aio_wait()
+# nng_aio_wait
## NAME
@@ -29,5 +29,5 @@ function will not be called until the callback has completed.
## SEE ALSO
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_busy()](nng_aio_busy.md)
+[nng_aio_abort](nng_aio_abort.md),
+[nng_aio_busy](nng_aio_busy.md)