From c2deb4a479be750b054372e83154f4b3b051c95a Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 2 Feb 2018 15:43:43 -0800 Subject: Update markup with simpler copyright and new-style asciidoctor. --- docs/nng_pull.adoc | 53 +++++++++++++++++++---------------------------------- 1 file changed, 19 insertions(+), 34 deletions(-) (limited to 'docs/nng_pull.adoc') diff --git a/docs/nng_pull.adoc b/docs/nng_pull.adoc index 6c730e54..3d9b506e 100644 --- a/docs/nng_pull.adoc +++ b/docs/nng_pull.adoc @@ -1,23 +1,18 @@ -nng_pull(7) -=========== += nng_pull(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -:copyright: Copyright 2018 Garrett D'Amore \ - Copyright 2018 Capitar IT Group BV \ - 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_pull - pull protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_pull0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_pull_ protocol is one half of a pipeline pattern. The other half is the <> protocol. @@ -39,8 +33,7 @@ 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 -~~~~~~~~~~~~~~~~~ +=== 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 @@ -50,32 +43,24 @@ 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 -~~~~~~~~~~~~~~~~~ +=== 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 _nng_pull_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_pull_ protocol has no protocol-specific headers. -SEE ALSO --------- +== SEE ALSO + <>, <> -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} -- cgit v1.2.3-70-g09d2