diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-02 15:43:43 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-02 17:02:40 -0800 |
| commit | c2deb4a479be750b054372e83154f4b3b051c95a (patch) | |
| tree | a6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_req.adoc | |
| parent | 4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff) | |
| download | nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2 nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip | |
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_req.adoc')
| -rw-r--r-- | docs/nng_req.adoc | 54 |
1 files changed, 19 insertions, 35 deletions
diff --git a/docs/nng_req.adoc b/docs/nng_req.adoc index 37262d24..25da41ef 100644 --- a/docs/nng_req.adoc +++ b/docs/nng_req.adoc @@ -1,23 +1,18 @@ -nng_req(7) -========== += nng_req(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ - Copyright 2018 Capitar IT Group BV <info@capitar.com> \ - This software 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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_req - request protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_req0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_req_ protocol is one half of a request/reply pattern. In this pattern, a requester sends a message to one replier, who @@ -53,8 +47,7 @@ help provide a degree of load-balancing. The _nng_req_ protocol is the requester side, and the <<nng_rep#,nng_rep(7)>> protocol is the replier side. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_req0_open()` call creates a requester socket. This socket may be used to send messages (requests), and then to receive replies. Generally @@ -72,14 +65,12 @@ in `NNG_ESTATE`. Raw mode sockets (set with `NNG_OPT_RAW`) ignore all these restrictions. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== 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 -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -102,8 +93,7 @@ The following protocol-specific options are available. of 0 may be used to disable the loop protection, allowing an infinite number of hops. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_req_ protocol uses a _backtrace_ in the header. This form uses an array of 32-bit big-endian identifiers, where the first @@ -119,17 +109,11 @@ and randomly when a request is first issued.) // TODO: Insert reference to RFC. - -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_rep#,nng_rep(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file |