aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/migrate
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-23 07:27:47 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-23 07:27:47 -0800
commitb34990f79058c6b433a970c519ac13b4fec2cf38 (patch)
tree4c1d1d86c6b8b933c56c831e380e8368c18ad203 /docs/ref/migrate
parentded2f41e048f9b03332c6bf1dacfbf9364f8aa6a (diff)
downloadnng-b34990f79058c6b433a970c519ac13b4fec2cf38.tar.gz
nng-b34990f79058c6b433a970c519ac13b4fec2cf38.tar.bz2
nng-b34990f79058c6b433a970c519ac13b4fec2cf38.zip
docs: Document removal of NNG_OPT_URL, even though it isn't done yet.
We're going to start ripping out support for it. The alternative functions should be used instead.
Diffstat (limited to 'docs/ref/migrate')
-rw-r--r--docs/ref/migrate/nng1.md7
1 files changed, 7 insertions, 0 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