Skip to content

Commit

Permalink
socket: remove unused nng_socket_get_ptr and nng_socket_set_ptr.
Browse files Browse the repository at this point in the history
We will be removing these pointer based functions more generally
as we we have type-specific accessors instead.

We also removed the context versions of these functions, which were
not previously documented.
  • Loading branch information
gdamore committed Nov 24, 2024
1 parent 895ea65 commit cc3b5fe
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 57 deletions.
13 changes: 0 additions & 13 deletions docs/man/nng_socket_get.3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ int nng_socket_get_uint64(nng_socket s, const char *opt, uint64_t *u64p);
int nng_socket_get_string(nng_socket s, const char *opt, char **strp);
int nng_socket_get_ptr(nng_socket s, const char *opt, void **ptr);
int nng_socket_get_ms(nng_socket s, const char *opt, nng_duration *durp);
int nng_socket_get_addr(nng_socket s, const char *opt, nng_sockaddr *addrp);
Expand All @@ -47,11 +45,6 @@ A number of them are documented in xref:nng_options.5.adoc[nng_options(5)].

Additionally protocol-specific options are documented with the protocols themselves.

IMPORTANT: Access to transport options via this function is deprecated, and may be
removed from a future release. Applications should instead make use of
xref:nng_dialer_get.3.adoc[nng_dialer_get] or
xref:nng_listener_get.3.adoc[nng_listener_get] for specific dialers or listeners.

=== Forms

In all of these forms, the option _opt_ is retrieved from the socket _s_.
Expand All @@ -74,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_socket_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_socket_get_size()`::
This function is used to retrieve a size into the pointer _zp_,
typically for buffer sizes, message maximum sizes, and similar options.
Expand Down
17 changes: 0 additions & 17 deletions docs/man/nng_socket_set.3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ int nng_socket_set_int(nng_socket s, const char *opt, int ival);
int nng_socket_set_ms(nng_socket s, const char *opt, nng_duration dur);
int nng_socket_set_ptr(nng_socket s, const char *opt, void *ptr);
int nng_socket_set_size(nng_socket s, const char *opt, size_t z);
int nng_socket_set_string(nng_socket s, const char *opt, const char *str);
Expand All @@ -44,11 +42,6 @@ A number of them are documented in xref:nng_options.5.adoc[nng_options(5)].

Protocol-specific options are documented with the protocol in question.

IMPORTANT: Access to transport options via this function is deprecated, and may be
removed from a future release. Applications should instead make use of
xref:nng_dialer_set.3.adoc[nng_dialer_get] or
xref:nng_listener_set.3.adoc[nng_listener_get] for specific dialers or listeners.

=== Forms

The details of the type, size, and semantics of the option will depend
Expand All @@ -67,16 +60,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_socket_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_socket_set_size()`::
This function is used to configure a size, _z_, typically for buffer sizes,
message maximum sizes, and similar options.
Expand Down
8 changes: 8 additions & 0 deletions docs/ref/migrate/nng1.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,14 @@ The `_getopt` and `_setopt` functions for contexts, listeners, and dialers are n
present. Simply changing `_getopt` to `_get` or `_setopt` to `_set` in the function name
should be sufficient in most cases.

The following functions served no useful purpose (after other changes described in this document),
and are thus removed:

- `nng_socket_get_ptr`
- `nng_socket_set_ptr`
- `nng_ctx_get_ptr` (not documented)
- `nng_ctx_set_ptr` (not documented)

## Untyped Option Functions Removed

The following functions are removed. To access options, use a proper typed access function,
Expand Down
3 changes: 0 additions & 3 deletions include/nng/nng.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,15 +231,13 @@ NNG_DECL int nng_socket_set_int(nng_socket, const char *, int);
NNG_DECL int nng_socket_set_size(nng_socket, const char *, size_t);
NNG_DECL int nng_socket_set_uint64(nng_socket, const char *, uint64_t);
NNG_DECL int nng_socket_set_string(nng_socket, const char *, const char *);
NNG_DECL int nng_socket_set_ptr(nng_socket, const char *, void *);
NNG_DECL int nng_socket_set_ms(nng_socket, const char *, nng_duration);

NNG_DECL int nng_socket_get_bool(nng_socket, const char *, bool *);
NNG_DECL int nng_socket_get_int(nng_socket, const char *, int *);
NNG_DECL int nng_socket_get_size(nng_socket, const char *, size_t *);
NNG_DECL int nng_socket_get_uint64(nng_socket, const char *, uint64_t *);
NNG_DECL int nng_socket_get_string(nng_socket, const char *, char **);
NNG_DECL int nng_socket_get_ptr(nng_socket, const char *, void **);
NNG_DECL int nng_socket_get_ms(nng_socket, const char *, nng_duration *);

// These functions are used to obtain a file descriptor that will poll
Expand Down Expand Up @@ -488,7 +486,6 @@ NNG_DECL int nng_ctx_get_int(nng_ctx, const char *, int *);
NNG_DECL int nng_ctx_get_size(nng_ctx, const char *, size_t *);
NNG_DECL int nng_ctx_get_uint64(nng_ctx, const char *, uint64_t *);
NNG_DECL int nng_ctx_get_string(nng_ctx, const char *, char **);
NNG_DECL int nng_ctx_get_ptr(nng_ctx, const char *, void **);
NNG_DECL int nng_ctx_get_ms(nng_ctx, const char *, nng_duration *);

NNG_DECL int nng_ctx_set(nng_ctx, const char *, const void *, size_t);
Expand Down
24 changes: 0 additions & 24 deletions src/nng.c
Original file line number Diff line number Diff line change
Expand Up @@ -441,12 +441,6 @@ nng_ctx_get_string(nng_ctx id, const char *n, char **v)
return (ctx_get(id, n, v, NULL, NNI_TYPE_STRING));
}

int
nng_ctx_get_ptr(nng_ctx id, const char *n, void **v)
{
return (ctx_get(id, n, v, NULL, NNI_TYPE_POINTER));
}

int
nng_ctx_get_ms(nng_ctx id, const char *n, nng_duration *v)
{
Expand Down Expand Up @@ -497,12 +491,6 @@ nng_ctx_set_ms(nng_ctx id, const char *n, nng_duration v)
return (ctx_set(id, n, &v, sizeof(v), NNI_TYPE_DURATION));
}

int
nng_ctx_set_ptr(nng_ctx id, const char *n, void *v)
{
return (ctx_set(id, n, &v, sizeof(v), NNI_TYPE_POINTER));
}

int
nng_ctx_set_string(nng_ctx id, const char *n, const char *v)
{
Expand Down Expand Up @@ -1145,12 +1133,6 @@ nng_socket_set_ms(nng_socket id, const char *n, nng_duration v)
return (socket_set(id, n, &v, sizeof(v), NNI_TYPE_DURATION));
}

int
nng_socket_set_ptr(nng_socket id, const char *n, void *v)
{
return (socket_set(id, n, &v, sizeof(v), NNI_TYPE_POINTER));
}

int
nng_socket_set_string(nng_socket id, const char *n, const char *v)
{
Expand Down Expand Up @@ -1202,12 +1184,6 @@ nng_socket_get_string(nng_socket id, const char *n, char **v)
return (socket_get(id, n, v, NULL, NNI_TYPE_STRING));
}

int
nng_socket_get_ptr(nng_socket id, const char *n, void **v)
{
return (socket_get(id, n, v, NULL, NNI_TYPE_POINTER));
}

int
nng_socket_get_ms(nng_socket id, const char *n, nng_duration *v)
{
Expand Down

0 comments on commit cc3b5fe

Please sign in to comment.