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_bus.adoc | 52 +++++++++++++++++++--------------------------------- 1 file changed, 19 insertions(+), 33 deletions(-) (limited to 'docs/nng_bus.adoc') diff --git a/docs/nng_bus.adoc b/docs/nng_bus.adoc index 886d2adf..a8147a2f 100644 --- a/docs/nng_bus.adoc +++ b/docs/nng_bus.adoc @@ -1,23 +1,19 @@ -nng_bus(7) += nng_bus(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_bus - bus protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +22,7 @@ SYNOPSIS int nng_bus0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_bus_ protocol provides for building mesh networks where every peer is connected to every other peer. In this protocol, @@ -52,38 +47,29 @@ should not be used for high throughput communications. Furthermore, the more traffic _in aggregate_ that occurs across the topology, the more likely that message loss is to occur. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_bus0_open()` call creates a bus socket. This socket may be used to send and receive messages. Sending messages will attempt to deliver to each directly connected peer. -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_bus_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_bus_ 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} \ No newline at end of file -- cgit v1.2.3-70-g09d2