diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/api/stream.md | 6 | ||||
| -rw-r--r-- | docs/ref/migrate/nng1.md | 14 | ||||
| -rw-r--r-- | docs/ref/xref.md | 4 |
3 files changed, 11 insertions, 13 deletions
diff --git a/docs/ref/api/stream.md b/docs/ref/api/stream.md index 3bed7923..bce310ec 100644 --- a/docs/ref/api/stream.md +++ b/docs/ref/api/stream.md @@ -267,14 +267,12 @@ stream = nng_aio_get_output(aio, 0); ## Stream Factory Options ```c -nng_err nng_stream_dialer_get_addr(nng_stream_dialer *dialer, const char *opt, nng_sockaddr *valp); nng_err nng_stream_dialer_get_bool(nng_stream_dialer *dialer, const char *opt, bool *valp); nng_err nng_stream_dialer_get_int(nng_stream_dialer *dialer, const char *opt, int *valp); nng_err nng_stream_dialer_get_ms(nng_stream_dialer *dialer, const char *opt, nng_duration *valp); nng_err nng_stream_dialer_get_size(nng_stream_dialer *dialer, const char *opt, size_t *valp); nng_err nng_stream_dialer_get_string(nng_stream_dialer *dialer, const char *opt, const char **valp); -nng_err nng_stream_listener_get_addr(nng_stream_listener *listener, const char *opt, nng_sockaddr *valp); nng_err nng_stream_listener_get_bool(nng_stream_listener *listener, const char *opt, bool *valp); nng_err nng_stream_listener_get_int(nng_stream_listener *listener, const char *opt, int *valp); nng_err nng_stream_listener_get_ms(nng_stream_listener *listener, const char *opt, nng_duration *valp); @@ -288,7 +286,6 @@ nng_err nng_stream_dialer_set_ms(nng_stream_dialer *dialer, const char *opt, nng nng_err nng_stream_dialer_set_size(nng_stream_dialer *dialer, const char *opt, size_t val); nng_err nng_stream_dialer_set_string(nng_stream_dialer *dialer, const char *opt, const char *val); -nng_err nng_stream_listener_set_addr(nng_stream_listener *listener, const char *opt, const nng_sockaddr *val); nng_err nng_stream_listener_set_bool(nng_stream_listener *listener, const char *opt, bool val); nng_err nng_stream_listener_set_int(nng_stream_listener *listener, const char *opt, int val); nng_err nng_stream_listener_set_ms(nng_stream_listener *listener, const char *opt, nng_duration val); @@ -300,7 +297,6 @@ nng_err nng_stream_listener_set_string(nng_stream_listener *listener, const char {{hi:`nng_stream_dialer_get_int`}} {{hi:`nng_stream_dialer_get_ms`}} {{hi:`nng_stream_dialer_get_size`}} -{{hi:`nng_stream_dialer_get_addr`}} {{hi:`nng_stream_dialer_get_string`}} {{hi:`nng_stream_dialer_set_bool`}} {{hi:`nng_stream_dialer_set_int`}} @@ -333,7 +329,7 @@ the string is only valid as long as the associated object remains open. In the case of `nng_stream_dialer_set_string` and `nng_stream_listener_set_string`, the string contents are copied if necessary, so that the caller need not retain the value referenced once the function returns. -In the case of `nng_stream_dialer_set_addr` and `nng_stream_listener_set_addr`, the contents of _addr_ are copied if necessary, so that the caller +In the case of `nng_stream_dialer_set_addr`, the contents of _addr_ are copied if necessary, so that the caller need not retain the value referenced once the function returns. ### Example 4: Socket Activation<a name="socket-activation"></a> diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md index 6e0a1143..1f78ee15 100644 --- a/docs/ref/migrate/nng1.md +++ b/docs/ref/migrate/nng1.md @@ -173,12 +173,13 @@ address separated by a semicolon. This was provided for legacy libnanomsg compatibility, and is no longer offered. The correct way to specify a local address is by setting `NNG_OPT_LOCADDR` on the dialer. -## Support for Remote Address Options Removed +## Support for Address Options Removed -The `NNG_OPT_REMADDR` option is removed. For streams and pipes, there are +The `NNG_OPT_REMADDR` and `NNG_OPT_LOCADDR` options are removed. For streams and pipes, there are [`nng_stream_peer_addr`] and [`nng_pipe_peer_addr`] functions. For dialers and stream dialers, the application should track the relevant information -used to configure the listener. +used to configure the listener. Functions formerly used to configure these are +removed as well. ## IPC Option Type Changes @@ -228,6 +229,7 @@ and are thus removed: - `nng_stream_listener_set_ptr` - `nng_stream_listener_get_uint64` - `nng_stream_listener_set_uint64` +- `nng_stream_listener_get_addr` - `nng_ctx_get_ptr` (not documented) - `nng_ctx_set_ptr` (not documented) @@ -379,6 +381,10 @@ They may silently truncate data. The HTTP handler objects may not be modified once in use. Previously this would fail with `NNG_EBUSY`. These checks are removed now, but debug builds will assert if an application tries to do so. +The `nng_http_server_get_addr` function is removed. Instead there is now +[`nng_http_server_get_port`] which can be used to obtain the port actually bound if the server +was configured with port 0. + ## WebSocket API The `NNG_OPT_WSS_REQUEST_HEADERS`, `NNG_OPT_WSS_RESPONSE_HEADERS` and @@ -417,7 +423,7 @@ is planned to provided coexistence between ZeroTier & the native stack's TCP/IP ## Abstract Autobinding No Longer Supported -As we have removed `NNG_OPT_LOCADDR` for listeners, it is no longer possible to meaningfully +As we have removed `NNG_OPT_LOCADDR`, it is no longer possible to meaningfully use autobinding with abstract sockets on Linux. This is trivially worked around by using a large (say 128-bit) random integer as the name. diff --git a/docs/ref/xref.md b/docs/ref/xref.md index 80a3d1b7..55f77fff 100644 --- a/docs/ref/xref.md +++ b/docs/ref/xref.md @@ -149,7 +149,6 @@ [`nng_stream_dialer_get_int`]: ../api/stream.md#stream-factory-options [`nng_stream_dialer_get_ms`]: ../api/stream.md#stream-factory-options [`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_set_bool`]: ../api/stream.md#stream-factory-options [`nng_stream_dialer_set_int`]: ../api/stream.md#stream-factory-options @@ -222,12 +221,10 @@ [`nng_listener_create`]: ../TODO.md [`nng_listener_close`]: ../TODO.md [`nng_listener_set`]: ../TODO.md -[`nng_socket_set`]: ../api/sock.md#socket-options [`nng_socket_set_bool`]: ../api/sock.md#socket-options [`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_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 @@ -449,7 +446,6 @@ [`NNG_OPT_SENDBUF`]: ../api/sock.md#NNG_OPT_SENDBUF [`NNG_OPT_RECVBUF`]: ../api/sock.md#NNG_OPT_RECVBUF [`NNG_OPT_RECVMAXSZ`]: ../api/sock.md#NNG_OPT_RECVMAXSZ -[`NNG_OPT_LOCADDR`]: ../api/sock.md#NNG_OPT_LOCADDR [`NNG_OPT_PEER_UID`]: ../tran/ipc.md#NNG_OPT_PEER_UID [`NNG_OPT_PEER_GID`]: ../tran/ipc.md#NNG_OPT_PEER_GID [`NNG_OPT_PEER_PID`]: ../tran/ipc.md#NNG_OPT_PEER_PID |