aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-03-13 00:50:48 -0700
committerGarrett D'Amore <garrett@damore.org>2019-03-13 00:50:48 -0700
commitf723fa9655e1e7fadc1a15b94b66de674ab9fe17 (patch)
tree8788e128e723bbd936bee0b03287a49df789a116 /docs
parentf65f819f7fb3bbe9e24bc73342b4f335f5034fe0 (diff)
downloadnng-f723fa9655e1e7fadc1a15b94b66de674ab9fe17.tar.gz
nng-f723fa9655e1e7fadc1a15b94b66de674ab9fe17.tar.bz2
nng-f723fa9655e1e7fadc1a15b94b66de674ab9fe17.zip
fixes #815 Eliminate socket filters on message queues
This also eliminates the enforcement of NNG_OPT_RECVMAXSZ for inproc, which never really made much sense. This helps inproc go faster. While here, also clean up the entry point for protocols to support a drain option, since we don't use that anywhere.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_inproc.7.adoc18
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/man/nng_inproc.7.adoc b/docs/man/nng_inproc.7.adoc
index cfd3806d..733b7789 100644
--- a/docs/man/nng_inproc.7.adoc
+++ b/docs/man/nng_inproc.7.adoc
@@ -1,6 +1,6 @@
= nng_inproc(7)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// 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
@@ -53,17 +53,23 @@ that URI.
=== Socket Address
-When using an `<<nng_sockaddr.5#,nng_sockaddr>>` structure,
+When using an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] structure,
the actual structure is of type
-`<<nng_sockaddr_inproc.5#,nng_sockaddr_inproc>>`.
+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]
-<<nng_inproc_register.3#,nng_inproc_register(3)>>,
-<<nng_sockaddr_inproc.5#,nng_sockaddr_inproc(5)>>,
-<<nng.7#,nng(7)>>
+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)]