summaryrefslogtreecommitdiff
path: root/docs/nng_inproc.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 15:43:43 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 17:02:40 -0800
commitc2deb4a479be750b054372e83154f4b3b051c95a (patch)
treea6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_inproc.adoc
parent4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff)
downloadnng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz
nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2
nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_inproc.adoc')
-rw-r--r--docs/nng_inproc.adoc50
1 files changed, 18 insertions, 32 deletions
diff --git a/docs/nng_inproc.adoc b/docs/nng_inproc.adoc
index 47a088a5..904fd15e 100644
--- a/docs/nng_inproc.adoc
+++ b/docs/nng_inproc.adoc
@@ -1,23 +1,18 @@
-nng_inproc(7)
-=============
+= nng_inproc(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_inproc - intra-process transport for nng
-SYNOPSIS
---------
+== SYNOPSIS
[source,c]
----------
@@ -26,8 +21,7 @@ SYNOPSIS
int nng_inproc_register(void);
----------
-DESCRIPTION
------------
+== DESCRIPTION
The _nng_inproc_ transport provides communication support between
_nng_ sockets within the same process. This may be used as an alternative
@@ -42,8 +36,7 @@ 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 Format
This transport uses URIs using the scheme `inproc://`, followed by
an arbitrary string of text, terminated by a `NUL` byte.
@@ -55,8 +48,7 @@ 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
-~~~~~~~~~~~~~~
+=== Socket Address
When using an `nng_sockaddr` structure, the actual structure is of type
`struct nng_sockaddr_inproc`. This type has the following definition:
@@ -82,20 +74,14 @@ The `sa_family` member will have the value `NNG_AF_INPROC`.
The `sa_path` member is an ASCIIZ string, and may contain any characters,
terminated by a `NUL` byte.
-Transport Options
-~~~~~~~~~~~~~~~~~
+=== Transport Options
The _inproc_ transport has no special options.
-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