diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-02 15:43:43 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-02 17:02:40 -0800 |
| commit | c2deb4a479be750b054372e83154f4b3b051c95a (patch) | |
| tree | a6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_bus.adoc | |
| parent | 4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff) | |
| download | nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2 nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip | |
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_bus.adoc')
| -rw-r--r-- | docs/nng_bus.adoc | 52 |
1 files changed, 19 insertions, 33 deletions
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 <garrett@damore.org> \ - Copyright 2018 Capitar IT Group BV <info@capitar.com> \ - 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 --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -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 |