From a7b20c3babd965b12dec8cb5ff0883a4d8d1116d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 24 Oct 2017 11:46:24 -0700 Subject: Doc directory moved to make github pages happy. --- docs/nng.adoc | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 docs/nng.adoc (limited to 'docs/nng.adoc') diff --git a/docs/nng.adoc b/docs/nng.adoc new file mode 100644 index 00000000..8a9d2596 --- /dev/null +++ b/docs/nng.adoc @@ -0,0 +1,88 @@ +nng(7) +====== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 7 +:icons:font +:copyright: Copyright 2017 Garrett D'Amore \ + Copyright 2017 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 +---- +nng - nanomsg next generation + +SYNOPSIS +-------- +*cc* ['flags'] 'files' *-lnng* ['libraries'] + + +DESCRIPTION +----------- + +The _nng_ library provides a common messaging framework intended to +solve common communication problems in distributed applications. +It offers a number of _protocols_, and also a number of _transports_. + +The _protocols_ implement the semantics associated with particular +communications scenarios, such as RPC style services, service discovery, +publish/subscribe, and so forth. + +The _transports_ provide support for underlying transport methods, such +as TCP, IPC, websockets, and so forth. + +The _nng_ library is designed to permit easy creation of new _transports_ and, +to a lesser extent, new _protocols_. + +The _nng_ library is wire compatible with the SP protocols described in +the nanomsg project; projects using _libnanomsg_ can interoperate with +nng as well as other conforming implementations. (One such implementation +is the https://github.com/go-mangos/mangos[mangos]. Applications using _nng_ +which wish to communicate with older libraries must ensure that they only +use protocols or transports offered by the earlier library. + +The _nng_ library also offers a compatible API, permitting legacy code to +be recompiled or relinked against _nng_. When doing this, support for +certain enhancements or features will likely be absent, requiring the +application developer to use the new-style API. + +The _nng_ library is implemented in pure C; if you need bindings for +other languages please check the http://nanomsg.org/[website]. + +Protocols +~~~~~~~~~ + +* <> - Bus protocol +* <> - Pair protocol +* <> - Publish/Subscribe protocol +* <> - Request/Reply protocol +* <> - Survey/Respond protocol + +Transports +~~~~~~~~~~ + +* <> - Intra-process transport +* <> - Inter-process transport +* <> - TCP (and TCPv6) transport +* <> - ZeroTier transport + +AUTHORS +------- +link:mailto:garrett@damore.org[Garrett D'Amore] + +SEE ALSO +-------- +<> + +COPYRIGHT +--------- + +Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/LICENSE.txt[MIT License]. -- cgit v1.2.3-70-g09d2