aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-11-24 13:12:56 -0800
committerGarrett D'Amore <garrett@damore.org>2024-11-24 13:12:56 -0800
commit2afc725ff5a41fbc7445f3681e83cf579f13b578 (patch)
treeaafc445c2857c83edaae6378094ec5f217a9cbad
parent5ab47e210de76d29cffbc9ea47800775a3627210 (diff)
downloadnng-2afc725ff5a41fbc7445f3681e83cf579f13b578.tar.gz
nng-2afc725ff5a41fbc7445f3681e83cf579f13b578.tar.bz2
nng-2afc725ff5a41fbc7445f3681e83cf579f13b578.zip
Remove all the set_ptr option functions.
This hopefully ensures that we have good typed functions instead of just passing around pointers blithely.
-rw-r--r--docs/man/nng_dialer_set.3.adoc12
-rw-r--r--docs/man/nng_listener_set.3.adoc12
-rw-r--r--docs/man/nng_stream_dialer_set.3str.adoc13
-rw-r--r--docs/man/nng_stream_listener_set.3str.adoc13
-rw-r--r--docs/ref/migrate/nng1.md5
-rw-r--r--include/nng/nng.h6
-rw-r--r--src/core/stream.c13
-rw-r--r--src/nng.c12
8 files changed, 5 insertions, 81 deletions
diff --git a/docs/man/nng_dialer_set.3.adoc b/docs/man/nng_dialer_set.3.adoc
index 82673959..efad700c 100644
--- a/docs/man/nng_dialer_set.3.adoc
+++ b/docs/man/nng_dialer_set.3.adoc
@@ -25,8 +25,6 @@ int nng_dialer_set_int(nng_dialer d, const char *opt, int ival);
int nng_dialer_set_ms(nng_dialer d, const char *opt, nng_duration dur);
-int nng_dialer_set_ptr(nng_dialer d, const char *opt, void *ptr);
-
int nng_dialer_set_size(nng_dialer d, const char *opt, size_t z);
int nng_dialer_set_string(nng_dialer d, const char *opt, const char *str);
@@ -67,16 +65,6 @@ This function is used to configure time durations (such as timeouts) using
type xref:nng_duration.5.adoc[`nng_duration`].
The duration _dur_ is an integer number of milliseconds.
-`nng_dialer_set_ptr()`::
-This function is used to pass a pointer, _ptr_, to structured data.
-The data referenced by _ptr_ is generally managed by other functions.
-For example, TLS configuration objects created with
-(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`])
-can be passed this way.
-
-NOTE: This form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-
`nng_dialer_set_size()`::
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.
diff --git a/docs/man/nng_listener_set.3.adoc b/docs/man/nng_listener_set.3.adoc
index 37c9b48e..f245fe60 100644
--- a/docs/man/nng_listener_set.3.adoc
+++ b/docs/man/nng_listener_set.3.adoc
@@ -25,8 +25,6 @@ int nng_listener_set_int(nng_listener l, const char *opt, int ival);
int nng_listener_set_ms(nng_listener l, const char *opt, nng_duration dur);
-int nng_listener_set_ptr(nng_listener l, const char *opt, void *ptr);
-
int nng_listener_set_size(nng_listener l, const char *opt, size_t z);
int nng_listener_set_string(nng_listener l, const char *opt, const char *str);
@@ -68,16 +66,6 @@ This function is used to configure time durations (such as timeouts) using
type xref:nng_duration.5.adoc[`nng_duration`].
The duration _dur_ is an integer number of milliseconds.
-`nng_listener_set_ptr()`::
-This function is used to pass a pointer, _ptr_, to structured data.
-The data referenced by _ptr_ is generally managed by other functions.
-For example, TLS configuration objects created with
-(xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`])
-can be passed this way.
-
-NOTE: This form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-
`nng_listener_set_size()`::
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.
diff --git a/docs/man/nng_stream_dialer_set.3str.adoc b/docs/man/nng_stream_dialer_set.3str.adoc
index 6a610500..2c75c9d9 100644
--- a/docs/man/nng_stream_dialer_set.3str.adoc
+++ b/docs/man/nng_stream_dialer_set.3str.adoc
@@ -26,8 +26,6 @@ int nng_stream_dialer_set_int(nng_stream_dialer *d, const char *opt, int val);
int nng_stream_dialer_set_ms(nng_stream_dialer *d, const char *opt, nng_duration val);
-int nng_stream_dialer_set_ptr(nng_stream_dialer *d, const char *opt, void *val);
-
int nng_stream_dialer_set_size(nng_stream_dialer *d, const char *opt, size_t val);
int nng_stream_dialer_set_string(nng_stream_dialer *d, const char *opt, const char *val);
@@ -67,17 +65,6 @@ the type
xref:nng_duration.5.adoc[`nng_duration`].
The duration is an integer number of milliseconds.
-`nng_stream_dialer_set_ptr()`::
-This function is used to pass a pointer to structured data.
-The data referenced by is generally managed by other functions.
-For example, TLS configuration objects created with
-xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]
-can be passed this way.
-+
-NOTE: This form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-Please see the documentation for the specific option for further details.
-
`nng_stream_dialer_set_size()`::
This function is used to configure a size, typically for buffer sizes,
message maximum sizes, and similar options.
diff --git a/docs/man/nng_stream_listener_set.3str.adoc b/docs/man/nng_stream_listener_set.3str.adoc
index 08a852bf..a623eef3 100644
--- a/docs/man/nng_stream_listener_set.3str.adoc
+++ b/docs/man/nng_stream_listener_set.3str.adoc
@@ -26,8 +26,6 @@ int nng_stream_listener_set_int(nng_stream_listener *l, const char *opt, int val
int nng_stream_listener_set_ms(nng_stream_listener *l, const char *opt, nng_duration val);
-int nng_stream_listener_set_ptr(nng_stream_listener *l, const char *opt, void *val);
-
int nng_stream_listener_set_size(nng_stream_listener *l, const char *opt, size_t val);
int nng_stream_listener_set_string(nng_stream_listener *l, const char *opt, const char *val);
@@ -67,17 +65,6 @@ the type
xref:nng_duration.5.adoc[`nng_duration`].
The duration is an integer number of milliseconds.
-`nng_stream_listener_set_ptr()`::
-This function is used to pass a pointer to structured data.
-The data referenced by is generally managed by other functions.
-For example, TLS configuration objects created with
-xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`]
-can be passed this way.
-+
-NOTE: This form is somewhat special in that the object is generally
-not copied, but instead the *pointer* to the object is copied.
-Please see the documentation for the specific option for further details.
-
`nng_stream_listener_set_size()`::
This function is used to configure 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 152c464b..54e89e8e 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -92,10 +92,15 @@ and are thus removed:
- `nng_ctx_get_string`
- `nng_ctx_set_string`
+- `nng_dialer_set_ptr`
+- `nng_listener_set_ptr`
- `nng_socket_get_ptr`
- `nng_socket_set_ptr`
- `nng_socket_get_string`
- `nng_socket_set_string`
+- `nng_stream_set_ptr`
+- `nng_stream_dialer_set_ptr`
+- `nng_stream_listener_set_ptr`
- `nng_ctx_get_ptr` (not documented)
- `nng_ctx_set_ptr` (not documented)
diff --git a/include/nng/nng.h b/include/nng/nng.h
index 3d762ee6..78b570ec 100644
--- a/include/nng/nng.h
+++ b/include/nng/nng.h
@@ -351,7 +351,6 @@ NNG_DECL int nng_dialer_set_int(nng_dialer, const char *, int);
NNG_DECL int nng_dialer_set_size(nng_dialer, const char *, size_t);
NNG_DECL int nng_dialer_set_uint64(nng_dialer, const char *, uint64_t);
NNG_DECL int nng_dialer_set_string(nng_dialer, const char *, const char *);
-NNG_DECL int nng_dialer_set_ptr(nng_dialer, const char *, void *);
NNG_DECL int nng_dialer_set_ms(nng_dialer, const char *, nng_duration);
NNG_DECL int nng_dialer_set_addr(
nng_dialer, const char *, const nng_sockaddr *);
@@ -373,7 +372,6 @@ NNG_DECL int nng_listener_set_int(nng_listener, const char *, int);
NNG_DECL int nng_listener_set_size(nng_listener, const char *, size_t);
NNG_DECL int nng_listener_set_uint64(nng_listener, const char *, uint64_t);
NNG_DECL int nng_listener_set_string(nng_listener, const char *, const char *);
-NNG_DECL int nng_listener_set_ptr(nng_listener, const char *, void *);
NNG_DECL int nng_listener_set_ms(nng_listener, const char *, nng_duration);
NNG_DECL int nng_listener_set_addr(
nng_listener, const char *, const nng_sockaddr *);
@@ -1178,8 +1176,6 @@ NNG_DECL int nng_stream_dialer_set_uint64(
nng_stream_dialer *, const char *, uint64_t);
NNG_DECL int nng_stream_dialer_set_string(
nng_stream_dialer *, const char *, const char *);
-NNG_DECL int nng_stream_dialer_set_ptr(
- nng_stream_dialer *, const char *, void *);
NNG_DECL int nng_stream_dialer_set_addr(
nng_stream_dialer *, const char *, const nng_sockaddr *);
@@ -1225,8 +1221,6 @@ NNG_DECL int nng_stream_listener_set_uint64(
nng_stream_listener *, const char *, uint64_t);
NNG_DECL int nng_stream_listener_set_string(
nng_stream_listener *, const char *, const char *);
-NNG_DECL int nng_stream_listener_set_ptr(
- nng_stream_listener *, const char *, void *);
NNG_DECL int nng_stream_listener_set_addr(
nng_stream_listener *, const char *, const nng_sockaddr *);
diff --git a/src/core/stream.c b/src/core/stream.c
index e46eb59a..cc7ac496 100644
--- a/src/core/stream.c
+++ b/src/core/stream.c
@@ -507,12 +507,6 @@ nng_stream_dialer_set_ms(nng_stream_dialer *d, const char *n, nng_duration v)
}
int
-nng_stream_dialer_set_ptr(nng_stream_dialer *d, const char *n, void *v)
-{
- return (nni_stream_dialer_set(d, n, &v, sizeof(v), NNI_TYPE_POINTER));
-}
-
-int
nng_stream_dialer_set_string(
nng_stream_dialer *d, const char *n, const char *v)
{
@@ -567,13 +561,6 @@ nng_stream_listener_set_ms(
}
int
-nng_stream_listener_set_ptr(nng_stream_listener *l, const char *n, void *v)
-{
- return (
- nni_stream_listener_set(l, n, &v, sizeof(v), NNI_TYPE_POINTER));
-}
-
-int
nng_stream_listener_set_string(
nng_stream_listener *l, const char *n, const char *v)
{
diff --git a/src/nng.c b/src/nng.c
index 872f15b9..51700bb4 100644
--- a/src/nng.c
+++ b/src/nng.c
@@ -764,12 +764,6 @@ nng_dialer_set_ms(nng_dialer id, const char *n, nng_duration v)
}
int
-nng_dialer_set_ptr(nng_dialer id, const char *n, void *v)
-{
- return (dialer_set(id, n, &v, sizeof(v), NNI_TYPE_POINTER));
-}
-
-int
nng_dialer_set_string(nng_dialer id, const char *n, const char *v)
{
return (dialer_set(
@@ -916,12 +910,6 @@ nng_listener_set_ms(nng_listener id, const char *n, nng_duration v)
}
int
-nng_listener_set_ptr(nng_listener id, const char *n, void *v)
-{
- return (listener_set(id, n, &v, sizeof(v), NNI_TYPE_POINTER));
-}
-
-int
nng_listener_set_string(nng_listener id, const char *n, const char *v)
{
return (listener_set(