aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ipc.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-04-30 19:02:00 -0700
committerGarrett D'Amore <garrett@damore.org>2018-04-30 19:02:00 -0700
commit63bdb2c28bc185096e579d1922d57cb71ecaa36b (patch)
tree96b7b759cdea1eeb96554ea6127dcb14b1b4eafb /docs/man/nng_ipc.7.adoc
parent264ed002f15645193ad53d4ba51218365d979699 (diff)
downloadnng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.tar.gz
nng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.tar.bz2
nng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.zip
fixes #387 Document that IPC paths must be absolute
Diffstat (limited to 'docs/man/nng_ipc.7.adoc')
-rw-r--r--docs/man/nng_ipc.7.adoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/man/nng_ipc.7.adoc b/docs/man/nng_ipc.7.adoc
index 199aa757..5a73ce25 100644
--- a/docs/man/nng_ipc.7.adoc
+++ b/docs/man/nng_ipc.7.adoc
@@ -42,7 +42,7 @@ no extra steps to use it should be necessary.
(((URI, `ipc://`)))
This transport uses URIs using the scheme `ipc://`, followed by
-a an absolute path name in the file system where the socket or named pipe
+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
@@ -56,6 +56,9 @@ then pathnames must not be longer than 122 bytes, including the final
This is because legacy versions of _nanomsg_ cannot express URLs
longer than 128 bytes, including the `ipc://` prefix.
+NOTE: Legacy _nanomsg_ supported relative IPC path names; modern _nng_ does not.
+Therefore, always use an absolute path name if interoperability is required.
+
=== Socket Address
When using an <<nng_sockaddr.5#,`nng_sockaddr`>> structure,