aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_inproc.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_inproc.7.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_inproc.7.adoc')
-rw-r--r--docs/man/nng_inproc.7.adoc68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/man/nng_inproc.7.adoc b/docs/man/nng_inproc.7.adoc
new file mode 100644
index 00000000..363ad705
--- /dev/null
+++ b/docs/man/nng_inproc.7.adoc
@@ -0,0 +1,68 @@
+= nng_inproc(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_inproc - intra-process transport
+
+== SYNOPSIS
+
+[source,c]
+----
+#include <nng/transport/inproc/inproc.h>
+
+int nng_inproc_register(void);
+----
+
+== DESCRIPTION
+
+(((transport, _inproc_)))
+(((intra-process)))
+The ((_inproc_ transport)) provides communication support between
+_nng_ sockets within the same process.
+This may be used as an alternative
+to slower transports when data must be moved within the same process.
+
+This transport tries hard to avoid copying data, and thus is very
+light-weight.
+
+=== Registration
+
+The _inproc_ transport is generally built-in to the _nng_ core, so
+no extra steps to use it should be necessary.
+
+=== URI Format
+(((URI, `inproc://`)))
+This transport uses URIs using the scheme `inproc://`, followed by
+an arbitrary string of text, terminated by a `NUL` byte.
+
+Multiple URIs can be used within the
+same application, and they will not interfere with one another.
+
+Two applications may also use the same URI without interfering with each
+other, and they will be unable to communicate with each other using
+that URI.
+
+=== Socket Address
+
+When using an <<nng_sockaddr.5#,`nng_sockaddr`>> structure,
+the actual structure is of type
+<<nng_sockaddr_inproc.5#,`nng_sockaddr_inproc`>>.
+
+=== Transport Options
+
+The _inproc_ transport has no special options.
+
+== SEE ALSO
+
+<<nng_inproc_register.3#,nng_inproc_register(3)>>,
+<<nng_sockaddr_inproc.5#,nng_sockaddr_inproc(5)>>,
+<<nng.7#,nng(7)>>