diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-04-30 19:02:00 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-04-30 19:02:00 -0700 |
| commit | 63bdb2c28bc185096e579d1922d57cb71ecaa36b (patch) | |
| tree | 96b7b759cdea1eeb96554ea6127dcb14b1b4eafb | |
| parent | 264ed002f15645193ad53d4ba51218365d979699 (diff) | |
| download | nng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.tar.gz nng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.tar.bz2 nng-63bdb2c28bc185096e579d1922d57cb71ecaa36b.zip | |
fixes #387 Document that IPC paths must be absolute
| -rw-r--r-- | docs/man/nng_compat.3compat.adoc | 9 | ||||
| -rw-r--r-- | docs/man/nng_ipc.7.adoc | 5 |
2 files changed, 10 insertions, 4 deletions
diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc index f46fc7df..42b0942e 100644 --- a/docs/man/nng_compat.3compat.adoc +++ b/docs/man/nng_compat.3compat.adoc @@ -115,9 +115,9 @@ Consequently, socket numbers can become quite large, and should probably not be used for array indices. NOTE: The following options (`nn_getsockopt`) are unsupported: -`NN_IPC_INBUFSZ`, `NN_OUTBUFSZ`, `NN_SNDPRIO`, `NN_RCVPRIO`, `NN_IPV4ONLY`. -Some of these may be supported in the future when the relevant support -is added to _nng_. +`NN_SNDPRIO`, `NN_RCVPRIO`, `NN_IPV4ONLY`. +The priority options may be supported in the future, when +the underlying capability is present in _nng_. NOTE: Access to statistics using this legacy API (`<<nn_get_statistic.3compat#,nn_get_statistic()>>`) is unsupported. @@ -126,6 +126,9 @@ NOTE: Some transports can support longer URLs than legacy _libnanomsg_ can. It is a good idea to use short pathnames in URLs if interoperability is a concern. +NOTE: Only absolute paths are supported in `ipc://` URLs. +For example, `ipc:///tmp/mysocket` is acceptable, but `ipc://mysocket` is not. + NOTE: Some transports are unusable from this mode. In particular, this legacy API offers no way to configure TLS parameters that are required for use. 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, |