diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/migrate/nng1.md | 7 | ||||
| -rw-r--r-- | docs/ref/tran/ipc.md | 4 | ||||
| -rw-r--r-- | docs/ref/tran/socket.md | 1 | ||||
| -rw-r--r-- | docs/ref/tran/udp.md | 2 |
4 files changed, 8 insertions, 6 deletions
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index 1d903215..2b305b75 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -166,6 +166,13 @@ The use of `*` to act as a wild card meaning all local interface addresses is removed. The empty string already performs this function, and unlike `*` is RFC compliant. +## URL Option Removed + +The `NNG_OPT_URL` option has been removed. +It is replaced by the type safe [`nng_dialer_get_url`] and +[`nng_listener_get_url`] functions, which return an [`nng_url`] +structure instead of a string. + ## URL Structure Changes The details of [`nng_url`] have changed significantly, and direct diff --git a/docs/ref/tran/ipc.md b/docs/ref/tran/ipc.md index ebf2fe89..c186cadd 100644 --- a/docs/ref/tran/ipc.md +++ b/docs/ref/tran/ipc.md @@ -24,7 +24,7 @@ name in the file system where the socket or named pipe should be created. > [!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. +> in properties like `NNG_OPT_LOCADDR` 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 @@ -84,7 +84,6 @@ where supported by the underlying platform. - [`NNG_OPT_PEER_PID`][NNG_OPT_PEER_PID] - [`NNG_OPT_PEER_UID`][NNG_OPT_PEER_UID] - [`NNG_OPT_PEER_ZONEID`][NNG_OPT_PEER_ZONEID] -- [`NNG_OPT_URL`][NNG_OPT_URL] [NNG_OPT_IPC_PERMISSIONS]: TODO.md [NNG_OPT_IPC_SECURITY_DESCRIPTOR]: TODO.md @@ -94,7 +93,6 @@ where supported by the underlying platform. [NNG_OPT_PEER_PID]: TODO.md [NNG_OPT_PEER_UID]: TODO.md [NNG_OPT_PEER_ZONEID]: TODO.md -[NNG_OPT_URL]: TODO.md [sockaddr]: TODO.md [sockaddr_ipc]: TODO.md [sockaddr_abstract]: TODO.md diff --git a/docs/ref/tran/socket.md b/docs/ref/tran/socket.md index 98cf0962..219f2abc 100644 --- a/docs/ref/tran/socket.md +++ b/docs/ref/tran/socket.md @@ -66,7 +66,6 @@ Additionally, the following options may be supported on pipes when the platform [nng_socket_pair]: ../../api/misc.md#create-socket-pair [NNG_OPT_LOCADDR]: [TODO.md] [NNG_OPT_REMADDR]: [TODO.md] -[NNG_OPT_URL]: [TODO.md] [NNG_OPT_PEER_GID]: [TODO.md] [NNG_OPT_PEER_PID]: [TODO.md] [NNG_OPT_PEER_UID]: [TODO.md] diff --git a/docs/ref/tran/udp.md b/docs/ref/tran/udp.md index e7912085..91d9a988 100644 --- a/docs/ref/tran/udp.md +++ b/docs/ref/tran/udp.md @@ -70,7 +70,6 @@ where supported by the underlying platform. - [`NNG_OPT_LOCADDR`][NNG_OPT_LOCADDR] - [`NNG_OPT_REMADDR`][NNG_OPT_REMADDR] -- [`NNG_OPT_URL`][NNG_OPT_URL] TODO: Document other options. @@ -109,5 +108,4 @@ TODO: Document the tunables for this. [nng_sockaddr_in6]: [TODO.md] [NNG_OPT_LOCADDR]: [TODO.md] [NNG_OPT_REMADDR]: [TODO.md] -[NNG_OPT_URL]: [TODO.md] [NNG_OPT_RECVMAXSZ]: [TODO.md] |