diff options
Diffstat (limited to 'docs/man/nng_inproc.7.adoc')
| -rw-r--r-- | docs/man/nng_inproc.7.adoc | 68 |
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)>> |
