diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_pull.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_pull.adoc')
| -rw-r--r-- | docs/nng_pull.adoc | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/nng_pull.adoc b/docs/nng_pull.adoc deleted file mode 100644 index f56afb5e..00000000 --- a/docs/nng_pull.adoc +++ /dev/null @@ -1,63 +0,0 @@ -= nng_pull(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_pull - pull protocol - -== SYNOPSIS - -[source,c] ----------- -#include <nng/protocol/pipeline0/pull.h> - -int nng_pull0_open(nng_socket *s); ----------- - -== DESCRIPTION - -The _nng_pull_ protocol is one half of a pipeline pattern. The other half -is the <<nng_push#,nng_push(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_pull0_open()` call creates a puller socket. This socket -may be used to receive messages, but is unable to send them. Attempts -to send messages will result in `NNG_ENOTSUP`. - -When receiving messages, the _nng_pull_ protocol accepts messages as -they arrive from peers. If two peers both have a message ready, the -order in which messages are handled is undefined. - -=== 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_pull_ protocol has no protocol-specific options. - -=== Protocol Headers - -The _nng_pull_ protocol has no protocol-specific headers. - -== SEE ALSO - -<<nng#,nng(7)>>, -<<nng_push#,nng_push(7)>> |