summaryrefslogtreecommitdiff
path: root/docs/man/nng_dialer_get.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-04 18:22:27 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-04 18:22:27 -0800
commit561fc87c4ae15d2349d9169fbd340d649a364ebd (patch)
tree139296a35483f1caaa147d1a7e1d8e8b95c64b1d /docs/man/nng_dialer_get.3.adoc
parent0260bd8f717a430e5327af4cce8f9431710ab233 (diff)
downloadnng-561fc87c4ae15d2349d9169fbd340d649a364ebd.tar.gz
nng-561fc87c4ae15d2349d9169fbd340d649a364ebd.tar.bz2
nng-561fc87c4ae15d2349d9169fbd340d649a364ebd.zip
api: introduce NNG 2.0 compatible nng_dialer_get_url and nng_listener_get_url
This is meant to help applications start adopting new interfaces before converting to NNG 2.0
Diffstat (limited to 'docs/man/nng_dialer_get.3.adoc')
-rw-r--r--docs/man/nng_dialer_get.3.adoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/man/nng_dialer_get.3.adoc b/docs/man/nng_dialer_get.3.adoc
index 5084c1b3..6750a535 100644
--- a/docs/man/nng_dialer_get.3.adoc
+++ b/docs/man/nng_dialer_get.3.adoc
@@ -37,6 +37,8 @@ int nng_dialer_get_string(nng_dialer d, const char *opt, char **strp);
int nng_dialer_get_uint64(nng_dialer d, const char *opt, uint64_t *u64p);
+int nng_dialer_get_url(nng_dialer d, const nng_url **url);
+
----
== DESCRIPTION
@@ -117,6 +119,9 @@ referenced by _u64p_.
This is typically used for options related to identifiers, network
numbers, and similar.
+`nng_dialer_get_url()`::
+This function is used to obtain the URL that dialer is configured for.
+
== RETURN VALUES
These functions returns 0 on success, and non-zero otherwise.