aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-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
-rw-r--r--docs/ref/migrate/nng1.md5
6 files changed, 5 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.
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index 54e89e8e..bff5b581 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -92,14 +92,19 @@ and are thus removed:
- `nng_ctx_get_string`
- `nng_ctx_set_string`
+- `nng_dialer_get_ptr`
- `nng_dialer_set_ptr`
+- `nng_listener_get_ptr`
- `nng_listener_set_ptr`
- `nng_socket_get_ptr`
- `nng_socket_set_ptr`
- `nng_socket_get_string`
- `nng_socket_set_string`
+- `nng_stream_get_ptr`
- `nng_stream_set_ptr`
+- `nng_stream_dialer_get_ptr`
- `nng_stream_dialer_set_ptr`
+- `nng_stream_listener_get_ptr`
- `nng_stream_listener_set_ptr`
- `nng_ctx_get_ptr` (not documented)
- `nng_ctx_set_ptr` (not documented)