From cefc6e1995f7f8e53e16db745eac7a86c2ebffd3 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 3 Jan 2025 08:21:00 -0800 Subject: api: drop the 64-bit option accessors (no more 64-bit option types) --- docs/ref/api/stream.md | 18 ++++-------------- docs/ref/migrate/nng1.md | 15 ++++++++++++++- docs/ref/xref.md | 7 ------- include/nng/nng.h | 1 - src/core/defs.h | 1 - src/core/options.c | 23 ----------------------- src/core/options.h | 4 +--- src/core/stream.c | 32 -------------------------------- src/nng.c | 24 ------------------------ 9 files changed, 19 insertions(+), 106 deletions(-) diff --git a/docs/ref/api/stream.md b/docs/ref/api/stream.md index ce312f84..ed72c90c 100644 --- a/docs/ref/api/stream.md +++ b/docs/ref/api/stream.md @@ -85,7 +85,6 @@ int nng_stream_get_ms(nng_stream *s, const char *opt, nng_duration *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); int nng_stream_get_string(nng_stream *s, const char *opt, char **valp); -int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp); ``` {{hi:`nng_stream_get_bool`}} @@ -94,7 +93,6 @@ int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp); {{hi:`nng_stream_get_size`}} {{hi:`nng_stream_get_addr`}} {{hi:`nng_stream_get_string`}} -{{hi:`nng_stream_get_uint64`}} These functions are used to obtain value of an option named _opt_ from the stream _s_, and store it in the location referenced by _valp_. @@ -258,37 +256,33 @@ stream = nng_aio_get_output(aio, 0); ## Stream Factory Options ```c +int nng_stream_dialer_get_addr(nng_stream_dialer *dialer, const char *opt, nng_sockaddr *valp); int nng_stream_dialer_get_bool(nng_stream_dialer *dialer, const char *opt, bool *valp); int nng_stream_dialer_get_int(nng_stream_dialer *dialer, const char *opt, int *valp); int nng_stream_dialer_get_ms(nng_stream_dialer *dialer, const char *opt, nng_duration *valp); int nng_stream_dialer_get_size(nng_stream_dialer *dialer, const char *opt, size_t *valp); -int nng_stream_dialer_get_addr(nng_stream_dialer *dialer, const char *opt, nng_sockaddr *valp); int nng_stream_dialer_get_string(nng_stream_dialer *dialer, const char *opt, char **valp); -int nng_stream_dialer_get_uint64(nng_stream_dialer *dialer, const char *opt, uint64_t *valp); +int nng_stream_listener_get_addr(nng_stream_listener *listener, const char *opt, nng_sockaddr *valp); int nng_stream_listener_get_bool(nng_stream_listener *listener, const char *opt, bool *valp); int nng_stream_listener_get_int(nng_stream_listener *listener, const char *opt, int *valp); int nng_stream_listener_get_ms(nng_stream_listener *listener, const char *opt, nng_duration *valp); int nng_stream_listener_get_size(nng_stream_listener *listener, const char *opt, size_t *valp); -int nng_stream_listener_get_addr(nng_stream_listener *listener, const char *opt, nng_sockaddr *valp); int nng_stream_listener_get_string(nng_stream_listener *listener, const char *opt, char **valp); -int nng_stream_listener_get_uint64(nng_stream_listener *listener, const char *opt, uint64_t *valp); +int nng_stream_dialer_set_addr(nng_stream_dialer *dialer, const char *opt, const nng_sockaddr *val); int nng_stream_dialer_set_bool(nng_stream_dialer *dialer, const char *opt, bool val); int nng_stream_dialer_set_int(nng_stream_dialer *dialer, const char *opt, int val); int nng_stream_dialer_set_ms(nng_stream_dialer *dialer, const char *opt, nng_duration val); int nng_stream_dialer_set_size(nng_stream_dialer *dialer, const char *opt, size_t val); int nng_stream_dialer_set_string(nng_stream_dialer *dialer, const char *opt, const char *val); -int nng_stream_dialer_set_uint64(nng_stream_dialer *dialer, const char *opt, uint64_t val); -int nng_stream_dialer_set_addr(nng_stream_dialer *dialer, const char *opt, const nng_sockaddr *val); +int nng_stream_listener_set_addr(nng_stream_listener *listener, const char *opt, const nng_sockaddr *val); int nng_stream_listener_set_bool(nng_stream_listener *listener, const char *opt, bool val); int nng_stream_listener_set_int(nng_stream_listener *listener, const char *opt, int val); int nng_stream_listener_set_ms(nng_stream_listener *listener, const char *opt, nng_duration val); int nng_stream_listener_set_size(nng_stream_listener *listener, const char *opt, size_t val); int nng_stream_listener_set_string(nng_stream_listener *listener, const char *opt, const char *val); -int nng_stream_listener_set_uint64(nng_stream_listener *listener, const char *opt, uint64_t val); -int nng_stream_listener_set_addr(nng_stream_listener *listener, const char *opt, const nng_sockaddr *val); ``` {{hi:`nng_stream_dialer_get_bool`}} @@ -297,28 +291,24 @@ int nng_stream_listener_set_addr(nng_stream_listener *listener, const char *opt, {{hi:`nng_stream_dialer_get_size`}} {{hi:`nng_stream_dialer_get_addr`}} {{hi:`nng_stream_dialer_get_string`}} -{{hi:`nng_stream_dialer_get_uint64`}} {{hi:`nng_stream_dialer_set_bool`}} {{hi:`nng_stream_dialer_set_int`}} {{hi:`nng_stream_dialer_set_ms`}} {{hi:`nng_stream_dialer_set_size`}} {{hi:`nng_stream_dialer_set_addr`}} {{hi:`nng_stream_dialer_set_string`}} -{{hi:`nng_stream_dialer_set_uint64`}} {{hi:`nng_stream_listener_get_bool`}} {{hi:`nng_stream_listener_get_int`}} {{hi:`nng_stream_listener_get_ms`}} {{hi:`nng_stream_listener_get_size`}} {{hi:`nng_stream_listener_get_addr`}} {{hi:`nng_stream_listener_get_string`}} -{{hi:`nng_stream_listener_get_uint64`}} {{hi:`nng_stream_listener_set_bool`}} {{hi:`nng_stream_listener_set_int`}} {{hi:`nng_stream_listener_set_ms`}} {{hi:`nng_stream_listener_set_size`}} {{hi:`nng_stream_listener_set_addr`}} {{hi:`nng_stream_listener_set_string`}} -{{hi:`nng_stream_listener_set_uint64`}} These functions are used to retrieve or change the value of an option named _opt_ from the stream _dialer_ or _listener_. The `nng_stream_dialer_get_` and `nng_stream_listener_get_` function families retrieve the value, and store it in the location _valp_ references. The `nng_stream_dialer_set_` and `nng_stream_listener_set_` function families change the value for the _dialer_ or _listener_, taking it from _val_. diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index 960e8626..8306e71f 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -128,6 +128,11 @@ address separated by a semicolon. This was provided for legacy libnanomsg compatilibility, and is no longer offered. The correct way to specify a local address is by setting `NNG_OPT_LOCADDR` on the dialer. +## IPC Option Type Changes + +The types of [`NNG_OPT_PEER_GID`], [`NNG_OPT_PEER_PID`], [`NNG_OPT_PEER_UID`], and [`NNG_OPT_PEER_ZONEID`] +have changed from `uint64_t` to `int`. The underlying platforms all use 32-bit quantities for these. + ## Option Functions The previously deprecated `nng_pipe_getopt_xxx` family of functions is removed. @@ -146,11 +151,14 @@ and are thus removed: - `nng_ctx_get_string` - `nng_ctx_set_string` - `nng_ctx_get_uint64` -- `nng_ctx_set_uint64` - `nng_dialer_get_ptr` - `nng_dialer_set_ptr` +- `nng_dialer_get_uint64` +- `nng_dialer_set_uint64` - `nng_listener_get_ptr` - `nng_listener_set_ptr` +- `nng_listener_get_uint64` +- `nng_listener_set_uint64` - `nng_socket_get_ptr` - `nng_socket_set_ptr` - `nng_socket_get_string` @@ -159,10 +167,15 @@ and are thus removed: - `nng_socket_set_uint64` - `nng_stream_get_ptr` - `nng_stream_set_ptr` +- `nng_stream_get_uint64` - `nng_stream_dialer_get_ptr` - `nng_stream_dialer_set_ptr` +- `nng_stream_dialer_get_uint64` +- `nng_stream_dialer_set_uint64` - `nng_stream_listener_get_ptr` - `nng_stream_listener_set_ptr` +- `nng_stream_listener_get_uint64` +- `nng_stream_listener_set_uint64` - `nng_ctx_get_ptr` (not documented) - `nng_ctx_set_ptr` (not documented) diff --git a/docs/ref/xref.md b/docs/ref/xref.md index f03377fa..62f09540 100644 --- a/docs/ref/xref.md +++ b/docs/ref/xref.md @@ -118,7 +118,6 @@ [`nng_stream_get_size`]: /api/stream.md#getting-stream-options [`nng_stream_get_addr`]: /api/stream.md#getting-stream-options [`nng_stream_get_string`]: /api/stream.md#getting-stream-options -[`nng_stream_get_uint64`]: /api/stream.md#getting-stream-options [`nng_stream_dialer`]: /api/stream.md#stream-factories [`nng_stream_listener`]: /api/stream.md#stream-factories [`nng_stream_dialer_alloc`]: /api/stream.md#creating-a-stream-factory @@ -144,28 +143,24 @@ [`nng_stream_dialer_get_size`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_get_addr`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_get_string`]: /api/stream.md#stream-factory-options -[`nng_stream_dialer_get_uint64`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_bool`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_int`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_ms`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_size`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_addr`]: /api/stream.md#stream-factory-options [`nng_stream_dialer_set_string`]: /api/stream.md#stream-factory-options -[`nng_stream_dialer_set_uint64`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_bool`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_int`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_ms`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_size`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_addr`]: /api/stream.md#stream-factory-options [`nng_stream_listener_get_string`]: /api/stream.md#stream-factory-options -[`nng_stream_listener_get_uint64`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_bool`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_int`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_ms`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_size`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_addr`]: /api/stream.md#stream-factory-options [`nng_stream_listener_set_string`]: /api/stream.md#stream-factory-options -[`nng_stream_listener_set_uint64`]: /api/stream.md#stream-factory-options [`nng_init`]: /api/init.md#initialization [`nng_fini`]: /api/init.md#finalization [`nng_sub0_ctx_subscribe`]: /TODO.md @@ -221,13 +216,11 @@ [`nng_socket_set_int`]: /api/sock.md#socket-options [`nng_socket_set_ms`]: /api/sock.md#socket-options [`nng_socket_set_size`]: /api/sock.md#socket-options -[`nng_socket_set_uint64`]: /api/sock.md#socket-options [`nng_socket_get`]: /api/sock.md#socket-options [`nng_socket_get_bool`]: /api/sock.md#socket-options [`nng_socket_get_int`]: /api/sock.md#socket-options [`nng_socket_get_ms`]: /api/sock.md#socket-options [`nng_socket_get_size`]: /api/sock.md#socket-options -[`nng_socket_get_uint64`]: /api/sock.md#socket-options [`nng_send`]: /api/sock.md#nng_send [`nng_sendmsg`]: /api/sock.md#nng_sendmsg [`nng_send_aio`]: /api/sock.md#nng_send_aio diff --git a/include/nng/nng.h b/include/nng/nng.h index 00b7bd89..9ae38817 100644 --- a/include/nng/nng.h +++ b/include/nng/nng.h @@ -688,7 +688,6 @@ NNG_DECL int nng_pipe_get_bool(nng_pipe, const char *, bool *); NNG_DECL int nng_pipe_get_int(nng_pipe, const char *, int *); NNG_DECL int nng_pipe_get_ms(nng_pipe, const char *, nng_duration *); NNG_DECL int nng_pipe_get_size(nng_pipe, const char *, size_t *); -NNG_DECL int nng_pipe_get_uint64(nng_pipe, const char *, uint64_t *); NNG_DECL int nng_pipe_get_string(nng_pipe, const char *, char **); NNG_DECL int nng_pipe_get_addr(nng_pipe, const char *, nng_sockaddr *); diff --git a/src/core/defs.h b/src/core/defs.h index 979c0300..419f5ba7 100644 --- a/src/core/defs.h +++ b/src/core/defs.h @@ -189,7 +189,6 @@ typedef enum { NNI_TYPE_NONE, // DO NOT USE NNI_TYPE_BOOL, NNI_TYPE_INT32, - NNI_TYPE_UINT64, NNI_TYPE_SIZE, NNI_TYPE_DURATION, NNI_TYPE_STRING, diff --git a/src/core/options.c b/src/core/options.c index 1540a807..7e05c23e 100644 --- a/src/core/options.c +++ b/src/core/options.c @@ -105,18 +105,6 @@ nni_copyin_str(char *s, const void *v, size_t maxsz, nni_type t) return (0); } -int -nni_copyin_u64(uint64_t *up, const void *v, size_t sz, nni_type t) -{ - NNI_ARG_UNUSED(sz); - - if (t != NNI_TYPE_UINT64) { - return (NNG_EBADTYPE); - } - *up = *(uint64_t *) v; - return (0); -} - int nni_copyin_sockaddr(nng_sockaddr *ap, const void *v, nni_type t) { @@ -183,17 +171,6 @@ nni_copyout_sockaddr( return (0); } -int -nni_copyout_u64(uint64_t u, void *dst, size_t *szp, nni_type t) -{ - NNI_ARG_UNUSED(szp); - if (t != NNI_TYPE_UINT64) { - return (NNG_EBADTYPE); - } - *(uint64_t *) dst = u; - return (0); -} - int nni_copyout_str(const char *str, void *dst, size_t *szp, nni_type t) { diff --git a/src/core/options.h b/src/core/options.h index 89006630..8aa7fce7 100644 --- a/src/core/options.h +++ b/src/core/options.h @@ -1,5 +1,5 @@ // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2025 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // Copyright 2018 Devolutions // @@ -33,7 +33,6 @@ extern int nni_copyin_size( size_t *, const void *, size_t, size_t, size_t, nni_type); extern int nni_copyin_str(char *, const void *, size_t, nni_type); extern int nni_copyin_ptr(void **, const void *, size_t, nni_type); -extern int nni_copyin_u64(uint64_t *, const void *, size_t, nni_type); extern int nni_copyin_sockaddr(nng_sockaddr *, const void *, nni_type); // nni_copyout_xxx copies out a type of the named value. It assumes that @@ -46,7 +45,6 @@ extern int nni_copyout_ptr(void *, void *, size_t *, nni_type); extern int nni_copyout_size(size_t, void *, size_t *, nni_type); extern int nni_copyout_sockaddr( const nng_sockaddr *, void *, size_t *, nni_type); -extern int nni_copyout_u64(uint64_t, void *, size_t *, nni_type); // nni_copyout_str copies out a string. If the type is NNI_TYPE_STRING, // then it passes through a pointer, created by nni_strdup(). diff --git a/src/core/stream.c b/src/core/stream.c index 2c7a9ff3..8686e5b2 100644 --- a/src/core/stream.c +++ b/src/core/stream.c @@ -367,12 +367,6 @@ nng_stream_get_size(nng_stream *s, const char *n, size_t *v) return (nni_stream_get(s, n, v, NULL, NNI_TYPE_SIZE)); } -int -nng_stream_get_uint64(nng_stream *s, const char *n, uint64_t *v) -{ - return (nni_stream_get(s, n, v, NULL, NNI_TYPE_UINT64)); -} - int nng_stream_get_string(nng_stream *s, const char *n, char **v) { @@ -409,12 +403,6 @@ nng_stream_dialer_get_size(nng_stream_dialer *d, const char *n, size_t *v) return (nni_stream_dialer_get(d, n, v, NULL, NNI_TYPE_SIZE)); } -int -nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *n, uint64_t *v) -{ - return (nni_stream_dialer_get(d, n, v, NULL, NNI_TYPE_UINT64)); -} - int nng_stream_dialer_get_string(nng_stream_dialer *d, const char *n, char **v) { @@ -458,13 +446,6 @@ nng_stream_listener_get_size(nng_stream_listener *l, const char *n, size_t *v) return (nni_stream_listener_get(l, n, v, NULL, NNI_TYPE_SIZE)); } -int -nng_stream_listener_get_uint64( - nng_stream_listener *l, const char *n, uint64_t *v) -{ - return (nni_stream_listener_get(l, n, v, NULL, NNI_TYPE_UINT64)); -} - int nng_stream_listener_get_string(nng_stream_listener *l, const char *n, char **v) { @@ -509,12 +490,6 @@ nng_stream_dialer_set_size(nng_stream_dialer *d, const char *n, size_t v) return (nni_stream_dialer_set(d, n, &v, sizeof(v), NNI_TYPE_SIZE)); } -int -nng_stream_dialer_set_uint64(nng_stream_dialer *d, const char *n, uint64_t v) -{ - return (nni_stream_dialer_set(d, n, &v, sizeof(v), NNI_TYPE_UINT64)); -} - int nng_stream_dialer_set_ms(nng_stream_dialer *d, const char *n, nng_duration v) { @@ -560,13 +535,6 @@ nng_stream_listener_set_size(nng_stream_listener *l, const char *n, size_t v) return (nni_stream_listener_set(l, n, &v, sizeof(v), NNI_TYPE_SIZE)); } -int -nng_stream_listener_set_uint64( - nng_stream_listener *l, const char *n, uint64_t v) -{ - return (nni_stream_listener_set(l, n, &v, sizeof(v), NNI_TYPE_UINT64)); -} - int nng_stream_listener_set_ms( nng_stream_listener *l, const char *n, nng_duration v) diff --git a/src/nng.c b/src/nng.c index 363d4d28..77d16b9e 100644 --- a/src/nng.c +++ b/src/nng.c @@ -704,12 +704,6 @@ nng_dialer_set_size(nng_dialer id, const char *n, size_t v) return (dialer_set(id, n, &v, sizeof(v), NNI_TYPE_SIZE)); } -int -nng_dialer_set_uint64(nng_dialer id, const char *n, uint64_t v) -{ - return (dialer_set(id, n, &v, sizeof(v), NNI_TYPE_UINT64)); -} - int nng_dialer_set_ms(nng_dialer id, const char *n, nng_duration v) { @@ -761,12 +755,6 @@ nng_dialer_get_size(nng_dialer id, const char *n, size_t *v) return (dialer_get(id, n, v, NULL, NNI_TYPE_SIZE)); } -int -nng_dialer_get_uint64(nng_dialer id, const char *n, uint64_t *v) -{ - return (dialer_get(id, n, v, NULL, NNI_TYPE_UINT64)); -} - int nng_dialer_get_string(nng_dialer id, const char *n, char **v) { @@ -844,12 +832,6 @@ nng_listener_set_size(nng_listener id, const char *n, size_t v) return (listener_set(id, n, &v, sizeof(v), NNI_TYPE_SIZE)); } -int -nng_listener_set_uint64(nng_listener id, const char *n, uint64_t v) -{ - return (listener_set(id, n, &v, sizeof(v), NNI_TYPE_UINT64)); -} - int nng_listener_set_ms(nng_listener id, const char *n, nng_duration v) { @@ -902,12 +884,6 @@ nng_listener_get_size(nng_listener id, const char *n, size_t *v) return (listener_get(id, n, v, NULL, NNI_TYPE_SIZE)); } -int -nng_listener_get_uint64(nng_listener id, const char *n, uint64_t *v) -{ - return (listener_get(id, n, v, NULL, NNI_TYPE_UINT64)); -} - int nng_listener_get_string(nng_listener id, const char *n, char **v) { -- cgit v1.2.3-70-g09d2