diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/src/SUMMARY.md | 12 | ||||
| -rw-r--r-- | docs/reference/src/iop/index.md (renamed from docs/reference/src/api/aio_provider/index.md) | 14 | ||||
| -rw-r--r-- | docs/reference/src/iop/nng_aio_begin.md (renamed from docs/reference/src/api/aio_provider/nng_aio_begin.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/iop/nng_aio_defer.md (renamed from docs/reference/src/api/aio_provider/nng_aio_defer.md) | 12 | ||||
| -rw-r--r-- | docs/reference/src/iop/nng_aio_finish.md (renamed from docs/reference/src/api/aio_provider/nng_aio_finish.md) | 12 | ||||
| -rw-r--r-- | docs/reference/src/iop/nng_aio_get_input.md (renamed from docs/reference/src/api/aio_provider/nng_aio_get_input.md) | 10 | ||||
| -rw-r--r-- | docs/reference/src/iop/nng_aio_set_output.md (renamed from docs/reference/src/api/aio_provider/nng_aio_set_output.md) | 6 | ||||
| -rw-r--r-- | docs/reference/src/refs.md | 15 | ||||
| -rw-r--r-- | docs/reference/src/tran/index.md | 4 | ||||
| -rw-r--r-- | docs/reference/src/util/index.md | 10 |
10 files changed, 67 insertions, 38 deletions
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md index 48fdc8df..fe9913f2 100644 --- a/docs/reference/src/SUMMARY.md +++ b/docs/reference/src/SUMMARY.md @@ -87,13 +87,13 @@ - [nng_aio_stop](aio/nng_aio_stop.md) - [nng_aio_wait](aio/nng_aio_wait.md) - - [Asynchronous I/O for Providers](api/aio_provider/index.md) + - [I/O Provider API](iop/index.md) - - [nng_aio_begin](api/aio_provider/nng_aio_begin.md) - - [nng_aio_defer](api/aio_provider/nng_aio_defer.md) - - [nng_aio_finish](api/aio_provider/nng_aio_finish.md) - - [nng_aio_get_input](api/aio_provider/nng_aio_get_input.md) - - [nng_aio_set_output](api/aio_provider/nng_aio_set_output.md) + - [nng_aio_begin](iop/nng_aio_begin.md) + - [nng_aio_defer](iop/nng_aio_defer.md) + - [nng_aio_finish](iop/nng_aio_finish.md) + - [nng_aio_get_input](iop/nng_aio_get_input.md) + - [nng_aio_set_output](iop/nng_aio_set_output.md) - [Utility Functions](util/index.md) diff --git a/docs/reference/src/api/aio_provider/index.md b/docs/reference/src/iop/index.md index 8fcaeeb0..677ac347 100644 --- a/docs/reference/src/api/aio_provider/index.md +++ b/docs/reference/src/iop/index.md @@ -13,9 +13,11 @@ other consumer functions for [Aysnchronous I/O](../aio/index.md). ## See Also -[nng_aio_begin](nng_aio_begin.md), -[nng_aio_defer](nng_aio_defer.md), -[nng_aio_finish](nng_aio_finish.md), -[nng_aio_get_input](nng_aio_get_input.md), -[nng_aio_set_output](nng_aio_set_output.md), -[Asynchronous I/O](../aio/index.md) +[nng_aio_begin][nng_aio_begin], +[nng_aio_defer][nng_aio_defer], +[nng_aio_finish][nng_aio_finish], +[nng_aio_get_input][nng_aio_get_input], +[nng_aio_set_output][nng_aio_set_output], +[Asynchronous I/O][aio] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio_provider/nng_aio_begin.md b/docs/reference/src/iop/nng_aio_begin.md index 59f21112..39f8cc4b 100644 --- a/docs/reference/src/api/aio_provider/nng_aio_begin.md +++ b/docs/reference/src/iop/nng_aio_begin.md @@ -24,7 +24,7 @@ This operation should be called at the start of any I/O operation, and must be called not more than once for a given I/O operation on a given _aio_. Once this function is called, if `true` is returned, then the provider MUST -guarantee that [`nng_aio_finish()`](nng_aio_finish.md) is called for the _aio_ +guarantee that [`nng_aio_finish()`][nng_aio_finish] is called for the _aio_ exactly once, when the operation is complete or canceled. > [!TIP] @@ -39,6 +39,8 @@ exactly once, when the operation is complete or canceled. ## SEE ALSO -[nng_aio_cancel](../aio/nng_aio_cancel.md), -[nng_aio_defer](nng_aio_defer.md), -[nng_aio_finish](nng_aio_finish.md) +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_defer][nng_aio_defer], +[nng_aio_finish][nng_aio_finish] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio_provider/nng_aio_defer.md b/docs/reference/src/iop/nng_aio_defer.md index e7782761..df43d7ca 100644 --- a/docs/reference/src/api/aio_provider/nng_aio_defer.md +++ b/docs/reference/src/iop/nng_aio_defer.md @@ -31,11 +31,11 @@ completed, or be in a state where it is no longer possible to unschedule it. In this case, the _cancelfn_ should just return without making any changes. If the cancellation routine successfully canceled the operation, it should -ensure that [`nng_aio_finish()`](nng_aio_finish.md) is called, with the +ensure that [`nng_aio_finish()`][nng_aio_finish] is called, with the error code specified by _err_. > [!IMPORTANT] -> It is mandatory that I/O providers call [`nng_aio_finish()`](nng_aio_finish.md) _*exactly once*_ when they are finished with the operation. +> It is mandatory that I/O providers call [`nng_aio_finish()`][nng_aio_finish] _*exactly once*_ when they are finished with the operation. > [!IMPORTANT] > Care must be taken to ensure that cancellation and completion of @@ -53,6 +53,8 @@ error code specified by _err_. ## SEE ALSO -[nng_aio_alloc](../aio/nng_aio_alloc.md), -[nng_aio_cancel](../aio/nng_aio_cancel.md), -[nng_aio_finish](nng_aio_finish.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_finish][nng_aio_finish] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio_provider/nng_aio_finish.md b/docs/reference/src/iop/nng_aio_finish.md index 215f6716..da922f76 100644 --- a/docs/reference/src/api/aio_provider/nng_aio_finish.md +++ b/docs/reference/src/iop/nng_aio_finish.md @@ -16,7 +16,7 @@ void nng_aio_finish(nng_aio *aio, int err); The `nng_aio_finish()` function marks operation associated with _aio_ as complete, with the status _err_. -This will be the result returned by [`nng_aio_result()`](../aio/nng_aio_result.md). +This will be the result returned by [`nng_aio_result()`][nng_aio_result]. This function causes the callback associated with the _aio_ to called. @@ -33,7 +33,9 @@ This function causes the callback associated with the _aio_ to called. ## SEE ALSO -[nng_aio_begin](nng_aio_begin.md), -[nng_aio_cancel](../aio/nng_aio_cancel.md), -[nng_aio_defer](nng_aio_defer.md), -[nng_aio_result](../aio/nng_aio_result.md) +[nng_aio_begin][nng_aio_begin], +[nng_aio_cancel][nng_aio_cancel], +[nng_aio_defer][nng_aio_defer], +[nng_aio_result][nng_aio_result] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio_provider/nng_aio_get_input.md b/docs/reference/src/iop/nng_aio_get_input.md index 598a5a47..28f798bd 100644 --- a/docs/reference/src/api/aio_provider/nng_aio_get_input.md +++ b/docs/reference/src/iop/nng_aio_get_input.md @@ -16,7 +16,7 @@ void *nng_aio_get_input(nng_aio *aio, unsigned int index); The `nng_aio_get_input()` function returns the value of the input parameter previously set at _index_ on _aio_ with the -[`nng_aio_set_input()`](../aio/nng_aio_set_input.md) function. +[`nng_aio_set_input()`][nng_aio_set_input]function. The valid values of _index_ range from zero (0) to three (3), as no operation currently defined can accept more than four parameters. @@ -29,6 +29,8 @@ Value previously set, or `NULL`. ## SEE ALSO -[nng_aio_alloc](../aio/nng_aio_alloc.md), -[nng_aio_get_output](../aio/nng_aio_get_output.md), -[nng_aio_set_input](../aio/nng_aio_set_input.md) +[nng_aio_alloc][nng_aio_alloc], +[nng_aio_get_output][nng_aio_get_output], +[nng_aio_set_input][nng_aio_set_input] + +{{#include ../refs.md}} diff --git a/docs/reference/src/api/aio_provider/nng_aio_set_output.md b/docs/reference/src/iop/nng_aio_set_output.md index 11761352..568d765d 100644 --- a/docs/reference/src/api/aio_provider/nng_aio_set_output.md +++ b/docs/reference/src/iop/nng_aio_set_output.md @@ -29,8 +29,10 @@ currently defined can return more than four results. > three (3) will be ignored. An output result set with this function may be retrieved later with -the [`nng_aio_get_output()`](../aio/nng_aio_get_output.md) function. +the [`nng_aio_get_output()`][nng_aio_get_output] function. ## SEE ALSO -[nng_aio_get_output](../aio/nng_aio_get_output.md) +[nng_aio_get_output][nng_aio_get_output] + +{{#include ../refs.md}} diff --git a/docs/reference/src/refs.md b/docs/reference/src/refs.md index 5c67ab09..44dd69a3 100644 --- a/docs/reference/src/refs.md +++ b/docs/reference/src/refs.md @@ -27,6 +27,13 @@ [sub]: ../proto/sub.md [surveyor]: ../proto/surveyor.md +<!-- Transports --> + +[inproc]: ../tran/inproc.md +[ipc]: ../tran/ipc.md +[tls]: ../tran/tls.md +[tcp]: ../tran/tcp.md + <!-- Sockets --> [nng_bus_open]: ../sock/nng_bus_open.md @@ -99,6 +106,14 @@ [nng_aio_stop]: ../aio/nng_aio_stop.md [nng_aio_wait]: ../aio/nng_aio_wait.md +<!-- IO Provider --> + +[nng_aio_begin]: ../iop/nng_aio_begin.md +[nng_aio_defer]: ../iop/nng_aio_defer.md +[nng_aio_finish]: ../iop/nng_aio_finish.md +[nng_aio_get_input]: ../iop/nng_aio_get_input.md +[nng_aio_set_output]: ../iop/nng_aio_set_output.md + <!-- Threads --> [nng_cv_alloc]: ../thr/nng_cv_alloc.md diff --git a/docs/reference/src/tran/index.md b/docs/reference/src/tran/index.md index 2e61d68d..cec3ae04 100644 --- a/docs/reference/src/tran/index.md +++ b/docs/reference/src/tran/index.md @@ -10,4 +10,6 @@ The [{{i:*inproc* transport}}][inproc] provides {{i: intra-process}} communicati ## TCP -The [{{i:*tcp* transport}}][tcp] provides communication over {{i:TCP/IP}} networks. +The {{hi:*tcp* transport}}[_tcp_ transport][tcp] provides communication over {{i:TCP/IP}} networks. + +{{#include ../refs.md}} diff --git a/docs/reference/src/util/index.md b/docs/reference/src/util/index.md index 0d7db007..3a91f69c 100644 --- a/docs/reference/src/util/index.md +++ b/docs/reference/src/util/index.md @@ -2,10 +2,10 @@ # See Also -[nng_alloc()][nng_alloc], -[nng_clock()][nng_clock], -[nng_free()][nng_free], -[nng_random()][nng_random], -[nng_version()][nng_version] +[nng_alloc][nng_alloc], +[nng_clock][nng_clock], +[nng_free][nng_free], +[nng_random][nng_random], +[nng_version][nng_version] {{#include ../refs.md}} |