aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_ipc.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-01-22 20:38:20 -0800
committerGarrett D'Amore <garrett@damore.org>2018-01-22 20:41:24 -0800
commitedced7d757bc3bfb98961e0d78695e4bedbb4561 (patch)
tree7f67764d6618ecd2841e0b40077a851fa24a483e /docs/nng_ipc.adoc
parent3d075fad7496ec126c5087d1c36ab7a4af73ce16 (diff)
downloadnng-edced7d757bc3bfb98961e0d78695e4bedbb4561.tar.gz
nng-edced7d757bc3bfb98961e0d78695e4bedbb4561.tar.bz2
nng-edced7d757bc3bfb98961e0d78695e4bedbb4561.zip
fixes #221 zerotier URL format changes
We are adopting a more standard URL format for zerotier, and making more use of the URL parsing common layer. While here we updated the docs to reflect correctly the URI syntax we are using everywhere.
Diffstat (limited to 'docs/nng_ipc.adoc')
-rw-r--r--docs/nng_ipc.adoc9
1 files changed, 2 insertions, 7 deletions
diff --git a/docs/nng_ipc.adoc b/docs/nng_ipc.adoc
index 6367a681..c1fcd5c4 100644
--- a/docs/nng_ipc.adoc
+++ b/docs/nng_ipc.adoc
@@ -47,17 +47,12 @@ URI Format
~~~~~~~~~~
This transport uses URIs using the scheme `ipc://`, followed by
-a path name in the file system where the socket or named pipe
+a an absolute path name in the file system where the socket or named pipe
should be created.
TIP: On Windows, all names are prefixed by `\.\pipe\` and do not
occupy the normal file system. On POSIX platforms, the path is
-taken literally, and is relative to the current directory, unless
-an extra leading `/` is provided. For example, `ipc://myname` refers
-to the name `myname` in the current directory, whereas `ipc:///tmp/myname`
-refers to `myname` located in `/tmp`.
-
-The entire URI must be less than `NNG_MAXADDRLEN` bytes long.
+taken literally, and is relative to the root directory.
Socket Address
~~~~~~~~~~~~~~