aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_rep.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_rep.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_rep.adoc')
-rw-r--r--docs/man/nng_rep.adoc83
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/man/nng_rep.adoc b/docs/man/nng_rep.adoc
deleted file mode 100644
index dcc7e6fb..00000000
--- a/docs/man/nng_rep.adoc
+++ /dev/null
@@ -1,83 +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>
-
-int nng_rep0_open(nng_socket *s);
-----------
-
-DESCRIPTION
------------
-
-The _nng_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 the requester will keep retrying until
-a reply is received.
-
-The _nng_rep_ protocol is the replier side, and the
-<<nng_req#,nng_req(7)>> protocol is the requester side.
-
-Socket Operations
-~~~~~~~~~~~~~~~~~
-
-The `nng_rep0_open()` call creates a requester 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. (Attempts to receive
-a message will result in `NNG_ESTATE` if there is no outstanding request.)
-
-Attempts to send on a socket with no outstanding requests will result
-in `NNG_ESTATE`.
-
-Raw mode sockets (set with `NNG_OPT_RAW`) ignore all these restrictions.
-
-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 following protocol-specific options are available.
-
-`NNG_OPT_MAXTTL`::
-
- Maximum time-to-live. This option is an integer value
- between 0 and 255,
- inclusive, and is the maximum number of "hops" that a message may
- pass through until it is discarded. The default value is 8. A value
- of 0 may be used to disable the loop protection, allowing an infinite
- number of hops.
-
-Protocol Headers
-~~~~~~~~~~~~~~~~
-
-The _nng_rep_ protocol uses a _backtrace_ in the header. This is
-more fully documented in the <<nng_req#,nng_req(7)>> manual.
-
-SEE ALSO
---------
-<<nng#,nng(7)>>,
-<<nng_req#,nng_req(7)>>