Convert inproc doc to mdbook.

1 files changed, 50 insertions, 0 deletions

diff --git a/docs/ref/tran/inproc.md b/docs/ref/tran/inproc.md
new file mode 100644
index 00000000..9c0f917d
--- /dev/null
+++ b/docs/ref/tran/inproc.md
@@ -0,0 +1,50 @@
+# INPROC Transport
+
+The {{i:*inproc* transport}}{{hi:*inproc*}}{{i:intra-process}} 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.
+
+## URI Format
+
+This transport uses URIs using the scheme {{i:`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`][sockaddr] structure,
+the actual structure is of type
+[`nng_sockaddr_inproc`][sockaddr_inproc].
+
+## Transport Options
+
+The _inproc_ transport has no special options.
+
+> [!NOTE]
+> While _inproc_ accepts the option `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, so the protection afforded by `NNG_OPT_RECVMAXSZ` is unnecessary.
+
+## Mixing Implementations
+
+When mixing the _NNG_ library with other implementations of these
+protocols in the same process (such as the _mangos_
+or _libnanomsg_ implementations), it will not be possible to utilize
+the _inproc_ transport to communicate across this boundary.
+
+This limitation also extends to using different instances of the _NNG_
+library within the same process.
+
+[sockaddr]: TODO.md
+[sockaddr_inproc]: TODO.md