diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-06-08 14:02:02 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-06-08 14:10:01 -0700 |
| commit | 0f8d5fc8bae0f20fa870dc5eda778aee12ccbda8 (patch) | |
| tree | 8ec01c3d62a067bb403abcbd1466da7feaa7f94d /docs | |
| parent | a43e6170bdc97a27602d7a75afcbb37e9d4e69e1 (diff) | |
| download | nng-0f8d5fc8bae0f20fa870dc5eda778aee12ccbda8.tar.gz nng-0f8d5fc8bae0f20fa870dc5eda778aee12ccbda8.tar.bz2 nng-0f8d5fc8bae0f20fa870dc5eda778aee12ccbda8.zip | |
fixes #509 We need "relative" IPC URLs
This special cases the URL parser for inproc and IPC urls,
changing so that they no longer parse the thing after the ://
as anything special. This allows IPC URLs to be relative.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_ipc.7.adoc | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/docs/man/nng_ipc.7.adoc b/docs/man/nng_ipc.7.adoc index 9b49c87c..0ebf1d3d 100644 --- a/docs/man/nng_ipc.7.adoc +++ b/docs/man/nng_ipc.7.adoc @@ -41,14 +41,21 @@ no extra steps to use it should be necessary. === URI Format (((URI, `ipc://`))) -This transport uses URIs using the scheme `ipc://`, followed by -an absolute path name in the file system where the socket or named pipe -should be created. +This transport uses URIs using the scheme `ipc://`, followed by a 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 root directory. +reside in the normal file system. +On POSIX platforms, the path is taken literally, and is relative to +the current directory, unless it begins with `/`, in which case it is +relative to the root directory. + +NOTE: When using relative paths on POSIX systems, the address used and returned +in properties like `NNG_OPT_LOCADDR` and `NNG_OPT_URL` will also be relative. +Consequently, they will only be interpreted the same by processes that have +the same working directory. +To ensure maximum portability and safety, absolute paths are recommended +whenever possible. NOTE: If compatibility with legacy _nanomsg_ applications is required, then pathnames must not be longer than 122 bytes, including the final @@ -56,9 +63,6 @@ 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, |