diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-01-22 20:38:20 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-01-22 20:41:24 -0800 |
| commit | edced7d757bc3bfb98961e0d78695e4bedbb4561 (patch) | |
| tree | 7f67764d6618ecd2841e0b40077a851fa24a483e /docs/nng_zerotier.adoc | |
| parent | 3d075fad7496ec126c5087d1c36ab7a4af73ce16 (diff) | |
| download | nng-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_zerotier.adoc')
| -rw-r--r-- | docs/nng_zerotier.adoc | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/nng_zerotier.adoc b/docs/nng_zerotier.adoc index 40ebabff..16bb647c 100644 --- a/docs/nng_zerotier.adoc +++ b/docs/nng_zerotier.adoc @@ -64,19 +64,19 @@ cannot be initialized for any reason. URI Format ~~~~~~~~~~ -This transport uses URIs using the scheme `zt://`, followed by a network -address (sixteen hexadecimal digits), followed by a `/` delimiter, -followed by the node number (ten hexadecimal digits) of the listening -node, followed by a service or port number (decimal value, up to 24-bits). -For example, the URI `zt://0123456789abdef/fedcba9876:999` indicates -that node fedcba9876 on network 0123456789abcdef listening on port 999. - -Listening nodes may use port 0, or `*`, to indicate that a suitable port -number be selected automatically. Applications using this must get the -selected port address using the `nng_listener_getopt` function. - -Listening nodes may also elide their own node number, as well as the -delimiter separating the node number. +This transport uses URIs using the scheme `zt://`, followed by a node +number (ten hexadecimal digits) followed by a `.` delimited, and then +a network address (sixteen hexadecimal digits), followed by a colon (`.`) +and service or port number (decimal value, up to 24-bits). +For example, the URI `zt://fedcba9876.0123456789abdef:999` indicates +that node fedcba9876 on network 0123456789abcdef is listening on port 999. + +The special value `*` can be used in lieu of a node number to represent +the node's own node number. + +Listeners may use port 0 to indicate that a suitable port +number be selected automatically. Applications using this must determine the +selected port number using the `nng_listener_getopt` function. Socket Address ~~~~~~~~~~~~~~ |
