aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-03 08:21:00 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-03 08:38:19 -0800
commitcefc6e1995f7f8e53e16db745eac7a86c2ebffd3 (patch)
tree0ac186f87a1d33b3b4090ea1c1dd51c85553b5f3 /docs
parentfb03061dfd20f0d85f73d22380acf5b8f88cf6b3 (diff)
downloadnng-cefc6e1995f7f8e53e16db745eac7a86c2ebffd3.tar.gz
nng-cefc6e1995f7f8e53e16db745eac7a86c2ebffd3.tar.bz2
nng-cefc6e1995f7f8e53e16db745eac7a86c2ebffd3.zip
api: drop the 64-bit option accessors (no more 64-bit option types)
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/api/stream.md18
-rw-r--r--docs/ref/migrate/nng1.md15
-rw-r--r--docs/ref/xref.md7
3 files changed, 18 insertions, 22 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