aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-24 15:00:39 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-24 15:00:39 -0800
commit2df4d2e814f34d8e1cc0816885543dbb568812cc (patch)
tree1918f29e3037680e5cd3cdc377ff056f2f010de9 /docs/man
parent2afc725ff5a41fbc7445f3681e83cf579f13b578 (diff)
downloadnng-2df4d2e814f34d8e1cc0816885543dbb568812cc.tar.gz
nng-2df4d2e814f34d8e1cc0816885543dbb568812cc.tar.bz2
nng-2df4d2e814f34d8e1cc0816885543dbb568812cc.zip
Remove all the get_ptr option accessors.
Temporarily we have removed access to the peer alt names, but that was never used and was not tested (it also didn't work with WolfSSL.)
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_dialer_get.3.adoc8
-rw-r--r--docs/man/nng_listener_get.3.adoc8
-rw-r--r--docs/man/nng_stream_dialer_get.3str.adoc12
-rw-r--r--docs/man/nng_stream_get.3str.adoc12
-rw-r--r--docs/man/nng_stream_listener_get.3str.adoc12
5 files changed, 0 insertions, 52 deletions
diff --git a/docs/man/nng_dialer_get.3.adoc b/docs/man/nng_dialer_get.3.adoc
index 29c0341a..9b1e6577 100644
--- a/docs/man/nng_dialer_get.3.adoc
+++ b/docs/man/nng_dialer_get.3.adoc
@@ -25,8 +25,6 @@ int nng_dialer_get_int(nng_dialer d, const char *opt, int *ivalp);
int nng_dialer_get_ms(nng_dialer d, const char *opt, nng_duration *durp);
-int nng_dialer_get_ptr(nng_dialer d, const char *opt, void **ptr);
-
int nng_dialer_get_size(nng_dialer d, const char *opt, size_t *zp);
int nng_dialer_get_addr(nng_dialer d, const char *opt, nng_sockaddr *sap);
@@ -69,12 +67,6 @@ This function is used to retrieve time xref:nng_duration.5.adoc[durations]
(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and
the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.)
-`nng_dialer_get_ptr()`::
-This function is used to retrieve a pointer, _ptr_, to structured data.
-The data referenced by _ptr_ is generally managed using other functions.
-Note that this form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-
`nng_dialer_get_size()`::
This function is used to retrieve a size into the pointer _zp_,
typically for buffer sizes, message maximum sizes, and similar options.
diff --git a/docs/man/nng_listener_get.3.adoc b/docs/man/nng_listener_get.3.adoc
index 216a28f6..a5df826d 100644
--- a/docs/man/nng_listener_get.3.adoc
+++ b/docs/man/nng_listener_get.3.adoc
@@ -25,8 +25,6 @@ int nng_listener_get_int(nng_listener l, const char *opt, int *ivalp);
int nng_listener_get_ms(nng_listener l, const char *opt, nng_duration *durp);
-int nng_listener_get_ptr(nng_listener l, const char *opt, void **ptr);
-
int nng_listener_get_size(nng_listener l, const char *opt, size_t *zp);
int nng_listener_get_addr(nng_listener l, const char *opt, nng_sockaddr *sap);
@@ -67,12 +65,6 @@ The value will be stored at _ivalp_.
This function is used to retrieve time xref:nng_duration.5.adoc[durations]
(such as timeouts), stored in _durp_ as a number of milliseconds.
-`nng_listener_get_ptr()`::
-This function is used to retrieve a pointer, _ptr_, to structured data.
-The data referenced by _ptr_ is generally managed using other functions.
-Note that this form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-
`nng_listener_get_size()`::
This function is used to retrieve a size into the pointer _zp_,
typically for buffer sizes, message maximum sizes, and similar options.
diff --git a/docs/man/nng_stream_dialer_get.3str.adoc b/docs/man/nng_stream_dialer_get.3str.adoc
index 13813c1f..aece5521 100644
--- a/docs/man/nng_stream_dialer_get.3str.adoc
+++ b/docs/man/nng_stream_dialer_get.3str.adoc
@@ -26,8 +26,6 @@ int nng_stream_dialer_get_int(nng_stream_dialer *d, const char *opt, int *valp);
int nng_stream_dialer_get_ms(nng_stream_dialer *d, const char *opt, nng_duration *valp);
-int nng_stream_dialer_get_ptr(nng_stream_dialer *d, const char *opt, void **valp);
-
int nng_stream_dialer_get_size(nng_stream_dialer *d, const char *opt, size_t *valp);
int nng_stream_dialer_get_addr(nng_stream_dialer *d, const char *opt, nng_sockaddr *valp);
@@ -69,16 +67,6 @@ xref:nng_duration.5.adoc[durations]
(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and
the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.)
-`nng_stream_dialer_get_ptr()`::
-This function is used to retrieve a pointer to structured data.
-The data referenced is generally managed using other functions.
-Note that this form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-+
-NOTE: Care must be taken to ensure that the application respects any
-considerations about the lifetime of the underlying object.
-See the documentation for the option for more specific guidance.
-
`nng_stream_dialer_get_size()`::
This function is used to retrieve a size,
typically for buffer sizes, message maximum sizes, and similar options.
diff --git a/docs/man/nng_stream_get.3str.adoc b/docs/man/nng_stream_get.3str.adoc
index b0f8ee19..a7137ecb 100644
--- a/docs/man/nng_stream_get.3str.adoc
+++ b/docs/man/nng_stream_get.3str.adoc
@@ -26,8 +26,6 @@ int nng_stream_get_int(nng_stream *s, const char *opt, int *valp);
int nng_stream_get_ms(nng_stream *s, const char *opt, nng_duration *valp);
-int nng_stream_get_ptr(nng_stream *s, const char *opt, void **valp);
-
int nng_stream_get_size(nng_stream *s, const char *opt, size_t *valp);
int nng_stream_get_addr(nng_stream *s, const char *opt, nng_sockaddr *valp);
@@ -68,16 +66,6 @@ xref:nng_duration.5.adoc[durations]
(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and
the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.)
-`nng_stream_get_ptr()`::
-This function is used to retrieve a pointer to structured data.
-The data referenced is generally managed using other functions.
-Note that this form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-+
-NOTE: Care must be taken to ensure that the application respects any
-considerations about the lifetime of the underyling object.
-See the documentation for the option for more specific guidance.
-
`nng_stream_get_size()`::
This function is used to retrieve a size,
typically for buffer sizes, message maximum sizes, and similar options.
diff --git a/docs/man/nng_stream_listener_get.3str.adoc b/docs/man/nng_stream_listener_get.3str.adoc
index 77c8e4b1..3aeec857 100644
--- a/docs/man/nng_stream_listener_get.3str.adoc
+++ b/docs/man/nng_stream_listener_get.3str.adoc
@@ -26,8 +26,6 @@ int nng_stream_listener_get_int(nng_stream_listener *l, const char *opt, int *va
int nng_stream_listener_get_ms(nng_stream_listener *l, const char *opt, nng_duration *valp);
-int nng_stream_listener_get_ptr(nng_stream_listener *l, const char *opt, void **valp);
-
int nng_stream_listener_get_size(nng_stream_listener *l, const char *opt, size_t *valp);
int nng_stream_listener_get_addr(nng_stream_listener *l, const char *opt, nng_sockaddr *valp);
@@ -70,16 +68,6 @@ xref:nng_duration.5.adoc[durations]
(The special value ((`NNG_DURATION_INFINITE`)) means an infinite amount of time, and
the special value ((`NNG_DURATION_DEFAULT`)) means a context-specific default.)
-`nng_stream_listener_get_ptr()`::
-This function is used to retrieve a pointer to structured data.
-The data referenced is generally managed using other functions.
-Note that this form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-+
-NOTE: Care must be taken to ensure that the application respects any
-considerations about the lifetime of the underyling object.
-See the documentation for the option for more specific guidance.
-
`nng_stream_listener_get_size()`::
This function is used to retrieve a size,
typically for buffer sizes, message maximum sizes, and similar options.