diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-15 08:40:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 08:49:12 -0700 |
| commit | 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch) | |
| tree | e3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_push.adoc | |
| parent | 91866ed9365ab89069c12da41c873c23d0ba1d19 (diff) | |
| download | nng-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_push.adoc')
| -rw-r--r-- | docs/man/nng_push.adoc | 71 |
1 files changed, 0 insertions, 71 deletions
diff --git a/docs/man/nng_push.adoc b/docs/man/nng_push.adoc deleted file mode 100644 index 42cc2dd5..00000000 --- a/docs/man/nng_push.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= nng_push(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_push - push protocol - -== SYNOPSIS - -[source,c] ----------- -#include <nng/protocol/pipeline0/push.h> - -int nng_push0_open(nng_socket *s); ----------- - -== DESCRIPTION - -The _nng_push_ protocol is one half of a pipeline pattern. The -other side is the <<nng_pull#,nng_pull(7)>> protocol. - -In the pipeline pattern, pushers distribute messages to pullers. -Each message sent -by a pusher will be sent to one of its peer pullers, -chosen in a round-robin fashion -from the set of connected peers available for receiving. -This property makes this pattern useful in load-balancing scenarios. - -=== Socket Operations - -The `nng_push0_open()` call creates a pusher socket. This socket -may be used to send messages, but is unable to receive them. Attempts -to receive messages will result in `NNG_ENOTSUP`. - -Send operations will observe flow control (back-pressure), so that -only peers capable of accepting a message will be considered. If no -peer is available to receive a message, then the send operation will -wait until one is available, or the operation times out. - -NOTE: Although the pipeline protocol honors flow control, and attempts -to avoid dropping messages, no guarantee of delivery is made. Furthermore, -as there is no capability for message acknowledgement, applications that -need reliable delivery are encouraged to consider the -<<nng_req#,nng_req(7)>> protocol instead. - -=== 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 _nng_push_ protocol has no protocol-specific options. - -=== Protocol Headers - -The _nng_push_ protocol has no protocol-specific headers. - -== SEE ALSO - -<<nng#,nng(7)>>, -<<nng_pull#,nng_pull(7)>>, -<<nng_req#,nng_req(7)>> |
