diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-24 14:06:58 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-24 14:06:58 -0700 |
| commit | 7875c06bc3c00f52760c5e6b2aafd099f56802d5 (patch) | |
| tree | ac92aeb92216fa0ae19af5231de91357cf9b0c2c /docs/man | |
| parent | 7504183730d37b362ab4cb78e926d7bd90f2fd2c (diff) | |
| download | nng-7875c06bc3c00f52760c5e6b2aafd099f56802d5.tar.gz nng-7875c06bc3c00f52760c5e6b2aafd099f56802d5.tar.bz2 nng-7875c06bc3c00f52760c5e6b2aafd099f56802d5.zip | |
Added inproc, and more detail about inproc limitations
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/nng_inproc.7.adoc | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/docs/man/nng_inproc.7.adoc b/docs/man/nng_inproc.7.adoc deleted file mode 100644 index 833ba353..00000000 --- a/docs/man/nng_inproc.7.adoc +++ /dev/null @@ -1,75 +0,0 @@ -= nng_inproc(7) -// -// Copyright 2019 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 -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 - -This transport is generally built-in to the 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 xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure, -the actual structure is of type -xref:nng_sockaddr_inproc.5.adoc[`nng_sockaddr_inproc`]. - -=== Transport Options - -The _inproc_ transport has no special options. - -NOTE: While _inproc_ accepts the option -xref:nng_options.5.adoc#NNG_OPT_RECVMAXSZ[`NNG_OPT_RECVMAXSZ`] for -compatibility, the value of the option is ignored with no enforcement. -As _inproc_ peers are in the same address space, they are implicitly trusted, -and thus it makes no sense to spend cycles protecting a program from itself. - -== SEE ALSO - -[.text-left] -xref:nng_inproc_register.3.adoc[nng_inproc_register(3)], -xref:nng_sockaddr_inproc.5.adoc[nng_sockaddr_inproc(5)], -xref:nng.7.adoc[nng(7)] |
