diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-24 13:55:44 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-24 13:55:44 -0700 |
| commit | 7504183730d37b362ab4cb78e926d7bd90f2fd2c (patch) | |
| tree | 27e6c5e6b42fa3b9b9241f980e723b59b4258e2f /docs | |
| parent | abb4dcaf84b4224788c1d343fe557079e053ee5b (diff) | |
| download | nng-7504183730d37b362ab4cb78e926d7bd90f2fd2c.tar.gz nng-7504183730d37b362ab4cb78e926d7bd90f2fd2c.tar.bz2 nng-7504183730d37b362ab4cb78e926d7bd90f2fd2c.zip | |
more doc updates
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_free.3.adoc | 53 | ||||
| -rw-r--r-- | docs/man/nng_rep.7.adoc | 86 | ||||
| -rw-r--r-- | docs/reference/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | docs/reference/src/api/nng_free.md | 35 | ||||
| -rw-r--r-- | docs/reference/src/protocols/rep.md | 56 |
5 files changed, 93 insertions, 139 deletions
diff --git a/docs/man/nng_free.3.adoc b/docs/man/nng_free.3.adoc deleted file mode 100644 index b4fdc249..00000000 --- a/docs/man/nng_free.3.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_free(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_free - free memory - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -void nng_free(void *ptr, size_t size); ----- - -== DESCRIPTION - -The `nng_free()` function deallocates a memory region of size _size_, -that was previously allocated by xref:nng_alloc.3.adoc[`nng_alloc()`] or -xref:nng_recv.3.adoc[`nng_recv()`] with the `NNG_FLAG_ALLOC` flag. - -IMPORTANT: It is very important that _size_ match the allocation size -used to allocate the memory. - -IMPORTANT: Do not attempt to use this function to deallocate memory -obtained by a call to the system `malloc()` or `calloc()` functions, -or the {cpp} `new` operator. -Doing so may result in unpredictable -behavior, including corruption of application memory. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_alloc.3.adoc[nng_alloc(3)], -xref:nng_recv.3.adoc[nng_recv(3)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_rep.7.adoc b/docs/man/nng_rep.7.adoc deleted file mode 100644 index ea40eb3a..00000000 --- a/docs/man/nng_rep.7.adoc +++ /dev/null @@ -1,86 +0,0 @@ -= nng_rep(7) -// -// 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_rep - reply protocol - -== SYNOPSIS - -[source,c] ----- -#include <nng/protocol/reqrep0/rep.h> ----- - -== DESCRIPTION - -(((protocol, _rep_))) -The ((_rep_ protocol)) is one half of a ((request/reply pattern)). -In this pattern, a requester sends a message to one replier, who -is expected to reply. -The request is resent if no reply arrives, -until a reply is received or the request times out. - -TIP: This protocol is useful in setting up RPC-like services. -It is also reliable, in that a requester will keep retrying until -a reply is received. - -The _rep_ protocol is the replier side, and the -xref:nng_req.7.adoc[_req_] protocol is the requester side. - -=== Socket Operations - -The xref:nng_rep_open.3.adoc[`nng_rep0_open()`] functions create a replier socket. -This socket may be used to receive messages (requests), and then to send -replies. - -Generally a reply can only be sent after receiving a request. - -Send operations will result in `NNG_ESTATE` if no corresponding request -was previously received. - -Likewise, only one receive operation may be pending at a time. -Any additional concurrent receive operations will result in `NNG_ESTATE`. - -xref:nng.7.adoc#raw_mode[Raw] mode sockets ignore all these restrictions. - -=== Context Operations - -This protocol supports the creation of xref:nng_ctx.5.adoc[contexts] for concurrent -use cases using xref:nng_ctx_open.3.adoc[`nng_ctx_open()`]. - -Each context may have at most one outstanding request, and operates -independently of the others. -The restrictions for order of operations with sockets apply equally -well for contexts, except that each context will be treated as if it were -a separate socket. - -=== Protocol Versions - -Only version 0 of this protocol is supported. -(At the time of writing, no other versions of this protocol have been defined.) - -==== Protocol Options - -The _rep_ protocol has no protocol-specific options. - -==== Protocol Headers - -(((backtrace))) -The _rep_ protocol uses a _backtrace_ in the header. -This is more fully documented in the xref:nng_req.7.adoc[_req_] manual. - -== SEE ALSO - -[.text-left] -xref:nng_rep_open.3.adoc[nng_rep_open(3)], -xref:nng.7.adoc[nng(7)], -xref:nng_req.7.adoc[nng_req(7)] diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md index c605fa3b..ce473546 100644 --- a/docs/reference/src/SUMMARY.md +++ b/docs/reference/src/SUMMARY.md @@ -9,6 +9,7 @@ - [Protocols](./protocols/index.md) - [BUS](protocols/bus.md) + - [REP](protocols/rep.md) - [Transports](./transports/index.md) @@ -53,6 +54,7 @@ - [nng_cv_wait](api/nng_cv_wait.md) - [nng_cv_wake](api/nng_cv_wake.md) - [nng_cv_wake1](api/nng_cv_wake1.md) + - [nng_free](api/nng_free.md) - [Context Functions](api/context.md) diff --git a/docs/reference/src/api/nng_free.md b/docs/reference/src/api/nng_free.md new file mode 100644 index 00000000..cc1d3308 --- /dev/null +++ b/docs/reference/src/api/nng_free.md @@ -0,0 +1,35 @@ +# nng_free() + +## NAME + +nng_free --- free memory + +## SYNOPSIS + +```c +#include <nng/nng.h> + +void nng_free(void *ptr, size_t size); +``` + +## DESCRIPTION + +The `nng_free()` function deallocates a memory region of size _size_, +that was previously allocated by [`nng_alloc()`](nng_alloc.md) or +[`nng_recv()`](nng_recv.md) with the `NNG_FLAG_ALLOC` flag. + +> [!IMPORTANT] +> It is very important that _size_ match the allocation size +> used to allocate the memory. + +> [!IMPORTANT] +> Do not attempt to use this function to deallocate memory +> obtained by a call to the system `malloc()` or `calloc()` functions, +> or the C++ `new` operator. +> Doing so may result in unpredictable +> behavior, including corruption of application memory. + +## SEE ALSO + +[nng_alloc()](nng_alloc.md), +[nng_recv()](nng_free.md) diff --git a/docs/reference/src/protocols/rep.md b/docs/reference/src/protocols/rep.md new file mode 100644 index 00000000..cb602e47 --- /dev/null +++ b/docs/reference/src/protocols/rep.md @@ -0,0 +1,56 @@ +# REP Protocol + +{{hi:protocol, _REP_}} +The {{i:_REP_ protocol}} is one half of a {{i:request/reply pattern}}. +In this pattern, a requester sends a message to one replier, who +is expected to reply. +The request is resent if no reply arrives, +until a reply is received or the request times out. + +> [!TIP] +> This protocol is useful in setting up RPC-like services. +> It is also reliable, in that a requester will keep retrying until +> a reply is received. + +The _REP_ protocol is the replier side, and the +[_REP_](req.md) protocol is the requester side. + +## Socket Operations + +The [`nng_rep0_open()`](nng_rep_open.md) functions create a replier socket. +This socket may be used to receive messages (requests), and then to send +replies. + +Generally a reply can only be sent after receiving a request. + +Send operations will result in `NNG_ESTATE` if no corresponding request +was previously received. + +Likewise, only one receive operation may be pending at a time. +Any additional concurrent receive operations will result in `NNG_ESTATE`. + +[Raw](../overview/raw.md) mode sockets ignore all these restrictions. + +## Context Operations + +This protocol supports the creation of [contexts](../api/nng_ctx.md) for concurrent use cases using [`nng_ctx_open()`](../api/nng_ctx_open.md). + +Each context may have at most one outstanding request, and operates +independently of the others. +The restrictions for order of operations with sockets apply equally +well for contexts, except that each context will be treated as if it were +a separate socket. + +## Protocol Versions + +Only version 0 of this protocol is supported. +(At the time of writing, no other versions of this protocol have been defined.) + +## Protocol Options + +The _REP_ protocol has no protocol-specific options. + +## Protocol Headers + +The _REP_ protocol uses a {{ii:backtrace}} in the header. +This is more fully documented in the [_REQ_](req.md) chapter. |
