diff options
31 files changed, 53 insertions, 48 deletions
diff --git a/docs/man/nng_ctx_open.3.adoc b/docs/man/nng_ctx_open.3.adoc index f8d5b546..7c799078 100644 --- a/docs/man/nng_ctx_open.3.adoc +++ b/docs/man/nng_ctx_open.3.adoc @@ -24,7 +24,7 @@ int nng_ctx_open(nng_ctx *ctxp, nng_socket s); == DESCRIPTION -The `nng_ctx0_open()` function creates a separate ((context)) to be used with +The `nng_ctx_open()` function creates a separate ((context)) to be used with the socket _s_, and returns it at the location pointed by _ctxp_. diff --git a/docs/man/nng_dialer_close.3.adoc b/docs/man/nng_dialer_close.3.adoc index 5ec1a5fe..e1cf741f 100644 --- a/docs/man/nng_dialer_close.3.adoc +++ b/docs/man/nng_dialer_close.3.adoc @@ -24,7 +24,7 @@ int nng_dialer_close(nng_dialer d); == DESCRIPTION -The `nng_dialer_close()` function closes the listener _d_. +The `nng_dialer_close()` function closes the dialer _d_. This also closes any `<<nng_pipe.5#,nng_pipe>>` objects that have been created by the dialer. diff --git a/docs/man/nng_iov.5.adoc b/docs/man/nng_iov.5.adoc index 161dd297..30681185 100644 --- a/docs/man/nng_iov.5.adoc +++ b/docs/man/nng_iov.5.adoc @@ -1,4 +1,4 @@ -= nng_sockaddr_in(5) += nng_iov(5) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_listener_setopt.3.adoc b/docs/man/nng_listener_setopt.3.adoc index d0968059..35721bee 100644 --- a/docs/man/nng_listener_setopt.3.adoc +++ b/docs/man/nng_listener_setopt.3.adoc @@ -22,6 +22,8 @@ nng_listener_setopt - set listener option int nng_listener_setopt(nng_listener l, const char *opt, const void *val, size_t valsz); +int nng_listener_setopt_bool(nng_listener l, const char *opt, bool bval); + int nng_listener_setopt_int(nng_listener l, const char *opt, int ival); int nng_listener_setopt_ms(nng_listener l, const char *opt, nng_duration dur); diff --git a/docs/man/nng_mtx_unlock.3supp.adoc b/docs/man/nng_mtx_unlock.3supp.adoc index 4f2d219e..7d855b7b 100644 --- a/docs/man/nng_mtx_unlock.3supp.adoc +++ b/docs/man/nng_mtx_unlock.3supp.adoc @@ -11,7 +11,7 @@ == NAME -nng_mtx_lock - lock mutex +nng_mtx_unlock - unlock mutex == SYNOPSIS diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc index b5c9fcf8..c8242be5 100644 --- a/docs/man/nng_pipe_getopt.3.adoc +++ b/docs/man/nng_pipe_getopt.3.adoc @@ -27,7 +27,7 @@ int nng_pipe_getopt_int(nng_pipe p, const char *opt, int *ivalp); int nng_pipe_getopt_ms(nng_pipe p, const char *opt, nng_duration *durp); -int nng_dialer_getopt_ptr(nng_pipe p, const char *opt, void **ptr); +int nng_pipe_getopt_ptr(nng_pipe p, const char *opt, void **ptr); int nng_pipe_getopt_sockaddr(nng_pipe p, const char *opt, nng_sockaddr *sap); diff --git a/docs/man/nng_rep_open.3.adoc b/docs/man/nng_rep_open.3.adoc index 2bebc490..29f6935a 100644 --- a/docs/man/nng_rep_open.3.adoc +++ b/docs/man/nng_rep_open.3.adoc @@ -21,6 +21,8 @@ nng_rep_open - create rep socket #include <nng/protocol/reqrep0/rep.h> int nng_rep0_open(nng_socket *s); + +int nng_rep0_open_raw(nng_socket *); ---- == DESCRIPTION diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc index 966e3914..b3b1d3b5 100644 --- a/docs/man/nng_setopt.3.adoc +++ b/docs/man/nng_setopt.3.adoc @@ -21,7 +21,7 @@ nng_setopt - set socket option int nng_setopt(nng_socket s, const char *opt, const void *val, size_t valsz); -int nng_setopt_bool(nng_socket s, const char *opt, int bval); +int nng_setopt_bool(nng_socket s, const char *opt, bool bval); int nng_setopt_int(nng_socket s, const char *opt, int ival); diff --git a/docs/man/nng_sockaddr_in6.5.adoc b/docs/man/nng_sockaddr_in6.5.adoc index cd967296..47a61e8c 100644 --- a/docs/man/nng_sockaddr_in6.5.adoc +++ b/docs/man/nng_sockaddr_in6.5.adoc @@ -11,7 +11,7 @@ == NAME -nng_sockaddr_in - IPv6 socket address +nng_sockaddr_in6 - IPv6 socket address == SYNOPSIS diff --git a/docs/man/nng_stat.5.adoc b/docs/man/nng_stat.5.adoc index d0d377c8..54b54883 100644 --- a/docs/man/nng_stat.5.adoc +++ b/docs/man/nng_stat.5.adoc @@ -1,4 +1,4 @@ -= nng_socket(5) += nng_stat(5) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_child.3.adoc b/docs/man/nng_stat_child.3.adoc index c77e7135..c86e368e 100644 --- a/docs/man/nng_stat_child.3.adoc +++ b/docs/man/nng_stat_child.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_child(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_desc.3.adoc b/docs/man/nng_stat_desc.3.adoc index 3f184366..af6a76f1 100644 --- a/docs/man/nng_stat_desc.3.adoc +++ b/docs/man/nng_stat_desc.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_desc(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_name.3.adoc b/docs/man/nng_stat_name.3.adoc index aaf854f5..4aa7455d 100644 --- a/docs/man/nng_stat_name.3.adoc +++ b/docs/man/nng_stat_name.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_name(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_next.3.adoc b/docs/man/nng_stat_next.3.adoc index d2ae24a4..ba9e770d 100644 --- a/docs/man/nng_stat_next.3.adoc +++ b/docs/man/nng_stat_next.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_next(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_string.3.adoc b/docs/man/nng_stat_string.3.adoc index 9f44b5b7..44173c86 100644 --- a/docs/man/nng_stat_string.3.adoc +++ b/docs/man/nng_stat_string.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_string(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_timestamp.3.adoc b/docs/man/nng_stat_timestamp.3.adoc index f23d8720..78e395b2 100644 --- a/docs/man/nng_stat_timestamp.3.adoc +++ b/docs/man/nng_stat_timestamp.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_timestamp(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stat_type.3.adoc b/docs/man/nng_stat_type.3.adoc index d583ee55..b494fed2 100644 --- a/docs/man/nng_stat_type.3.adoc +++ b/docs/man/nng_stat_type.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_type(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> @@ -11,7 +11,7 @@ == NAME -nng_stat_value - get statistic value +nng_stat_type - get statistic type == SYNOPSIS diff --git a/docs/man/nng_stat_unit.3.adoc b/docs/man/nng_stat_unit.3.adoc index cb9bb7cf..895e1a10 100644 --- a/docs/man/nng_stat_unit.3.adoc +++ b/docs/man/nng_stat_unit.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_unit(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> @@ -11,7 +11,7 @@ == NAME -nng_stat_value - get statistic value +nng_stat_unit - get statistic unit == SYNOPSIS diff --git a/docs/man/nng_stat_value.3.adoc b/docs/man/nng_stat_value.3.adoc index c62d761c..c33e376c 100644 --- a/docs/man/nng_stat_value.3.adoc +++ b/docs/man/nng_stat_value.3.adoc @@ -1,4 +1,4 @@ -= nng_version(3) += nng_stat_value(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stats_free.3.adoc b/docs/man/nng_stats_free.3.adoc index 3b5c7457..285bf248 100644 --- a/docs/man/nng_stats_free.3.adoc +++ b/docs/man/nng_stats_free.3.adoc @@ -1,4 +1,4 @@ -= nng_free(3) += nng_stats_free(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stats_get.3.adoc b/docs/man/nng_stats_get.3.adoc index 48fde26c..1d16cadb 100644 --- a/docs/man/nng_stats_get.3.adoc +++ b/docs/man/nng_stats_get.3.adoc @@ -1,4 +1,4 @@ -= nng_alloc(3) += nng_stats_get(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> diff --git a/docs/man/nng_stream_dialer_set.3str.adoc b/docs/man/nng_stream_dialer_set.3str.adoc index 1a1b6862..7afc83b5 100644 --- a/docs/man/nng_stream_dialer_set.3str.adoc +++ b/docs/man/nng_stream_dialer_set.3str.adoc @@ -22,7 +22,7 @@ nng_stream_dialer_set - set option on byte stream dialer int nng_stream_dialer_set(nng_stream_dialer *d, const char *name, const void *data, size_t size); -int nng_stream_dialer_set_bool(nng_stream_dialer *d, const char *opt, int val); +int nng_stream_dialer_set_bool(nng_stream_dialer *d, const char *opt, bool val); int nng_stream_dialer_set_int(nng_stream_dialer *d, const char *opt, int val); diff --git a/docs/man/nng_stream_listener.5.adoc b/docs/man/nng_stream_listener.5.adoc index c8966326..f7b85e55 100644 --- a/docs/man/nng_stream_listener.5.adoc +++ b/docs/man/nng_stream_listener.5.adoc @@ -20,7 +20,7 @@ nng_stream_listener - byte stream listener ---- #include <nng/nng.h> -typedef struct nng_stream_dialer nng_stream_dialer; +typedef struct nng_stream_listener nng_stream_listener; ---- == DESCRIPTION diff --git a/docs/man/nng_stream_listener_set.3str.adoc b/docs/man/nng_stream_listener_set.3str.adoc index 4fd47d4f..386c6d87 100644 --- a/docs/man/nng_stream_listener_set.3str.adoc +++ b/docs/man/nng_stream_listener_set.3str.adoc @@ -22,7 +22,7 @@ nng_stream_listener_set - set option on byte stream listener int nng_stream_listener_set(nng_stream_listener *l, const char *name, const void *data, size_t size); -int nng_stream_listener_set_bool(nng_stream_listener *l, const char *opt, int val); +int nng_stream_listener_set_bool(nng_stream_listener *l, const char *opt, bool val); int nng_stream_listener_set_int(nng_stream_listener *l, const char *opt, int val); diff --git a/docs/man/nng_stream_recv.3str.adoc b/docs/man/nng_stream_recv.3str.adoc index 3acb1921..6b5e5b37 100644 --- a/docs/man/nng_stream_recv.3str.adoc +++ b/docs/man/nng_stream_recv.3str.adoc @@ -1,4 +1,4 @@ -= nng_stream_send(3str) += nng_stream_recv(3str) // // Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> @@ -12,7 +12,7 @@ == NAME -nng_stream_send - receive from byte stream +nng_stream_recv - receive from byte stream == SYNOPSIS @@ -20,12 +20,12 @@ nng_stream_send - receive from byte stream ---- #include <nng/nng.h> -void nng_stream_send(nng_stream *s, nng_aio *aio); +void nng_stream_recv(nng_stream *s, nng_aio *aio); ---- == DESCRIPTION -The `nng_stream_send()` function starts an asynchronous receive from the +The `nng_stream_recv()` function starts an asynchronous receive from the xref:nng_stream.5.adoc[byte stream] _s_ into the scatter/gather vector located in the asynchronous I/O structure _aio_. diff --git a/docs/man/nng_stream_set.3str.adoc b/docs/man/nng_stream_set.3str.adoc index cc6d4610..eb19c349 100644 --- a/docs/man/nng_stream_set.3str.adoc +++ b/docs/man/nng_stream_set.3str.adoc @@ -22,7 +22,7 @@ nng_stream_set - set option on byte stream int nng_stream_set(nng_stream *s, const char *name, const void *data, size_t size); -int nng_stream_set_bool(nng_stream *s, const char *opt, int val); +int nng_stream_set_bool(nng_stream *s, const char *opt, bool val); int nng_stream_set_int(nng_stream *s, const char *opt, int val); diff --git a/docs/man/nng_surveyor.7.adoc b/docs/man/nng_surveyor.7.adoc index 259003e4..19e792af 100644 --- a/docs/man/nng_surveyor.7.adoc +++ b/docs/man/nng_surveyor.7.adoc @@ -137,7 +137,7 @@ When the response finally arrives back at the initiating surveyor, it should have only a single element in the message, which will be the survey ID it originally used for the request. -// TODO: Insert reference to RFC. +https://github.com/nanomsg/nanomsg/blob/master/rfc/sp-surveyor-01.txt[RFC sp-surveyor-01] == SEE ALSO diff --git a/docs/man/nng_tcp.5.adoc b/docs/man/nng_tcp.5.adoc index b06901b6..12cb8399 100644 --- a/docs/man/nng_tcp.5.adoc +++ b/docs/man/nng_tcp.5.adoc @@ -61,8 +61,9 @@ accessed using the <<nng_tcp_getopt.3tcp#,`nng_tcp_getopt()`>> and * <<nng_options.5#NNG_OPT_LOCADDR,`NNG_OPT_LOCADDR`>> * <<nng_options.5#NNG_OPT_REMADDR,`NNG_OPT_REMADDR`>> -* <<nng_tcp_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>> * <<nng_tcp_options.5#NNG_OPT_TCP_NO_DELAY,`NNG_OPT_TCP_NODELAY`>> +* <<nng_tcp_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>> +* <<nng_tcp_options.5#NNG_OPT_TCP_BOUND_PORT,`NNG_OPT_TCP_BOUND_PORT`>> Other platform specific options may be available as well. diff --git a/docs/man/nng_tcp_options.5.adoc b/docs/man/nng_tcp_options.5.adoc index 862128ec..1ca31a32 100644 --- a/docs/man/nng_tcp_options.5.adoc +++ b/docs/man/nng_tcp_options.5.adoc @@ -20,9 +20,9 @@ nng_tcp_options - TTCP-specific options ---- #include <nng/nng.h> - -#define NNG_OPT_TCP_NODELAY "tcp-nodelay" -#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive" +#define NNG_OPT_TCP_NODELAY "tcp-nodelay" +#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive" +#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port" ---- == DESCRIPTION @@ -45,18 +45,6 @@ TCP/IP communications. === TCP Options -[[NNG_OPT_TCP_BOUND_PORT]] -((`NNG_OPT_TCP_BOUND_PORT`)):: -(`int`) -This option is available on listeners, after the listern has bound to -a port, and provides the port bound to in native byte order. -This is most useful when using a listener with an ephemeral port -(configured by using port 0 at configuration time), as it allows -the caller to determine the actual ephemeral port that was chosen by the -system. -While the value is of type `int`, it will be a legal TCP port number, that -is a value between 1 and 65535, inclusive. - [[NNG_OPT_TCP_NODELAY]] ((`NNG_OPT_TCP_NODELAY`)):: (`bool`) @@ -101,6 +89,18 @@ First, it can be used to detect dead peers on an otherwise quiescent network. Second, it can be used to keep connection table entries in NAT and other middleware from being expiring due to lack of activity. +[[NNG_OPT_TCP_BOUND_PORT]] +((`NNG_OPT_TCP_BOUND_PORT`)):: +(`int`) +This option is available on listeners, after the listern has bound to +a port, and provides the port bound to in native byte order. +This is most useful when using a listener with an ephemeral port +(configured by using port 0 at configuration time), as it allows +the caller to determine the actual ephemeral port that was chosen by the +system. +While the value is of type `int`, it will be a legal TCP port number, that +is a value between 1 and 65535, inclusive. + === Inherited Options Generally, the following option values are also available for TCP objects, diff --git a/docs/man/nng_url_parse.3.adoc b/docs/man/nng_url_parse.3.adoc index f26d522d..0cce5d2e 100644 --- a/docs/man/nng_url_parse.3.adoc +++ b/docs/man/nng_url_parse.3.adoc @@ -34,8 +34,8 @@ The `nng_url` structure has at least the following members: [source, c] ---- struct nng_url { - char *u_scheme; // Scheme, such as "http"; always lower case. char *u_rawurl; // Unparsed URL, with minimal canonicalization. + char *u_scheme; // Scheme, such as "http"; always lower case. char *u_userinfo; // Userinfo component, or NULL. char *u_host; // Full host, including port if present. char *u_hostname; // Hostname only (or address), or empty string. diff --git a/docs/man/nng_wss_register.3.adoc b/docs/man/nng_wss_register.3.adoc index e822c4d6..0b485429 100644 --- a/docs/man/nng_wss_register.3.adoc +++ b/docs/man/nng_wss_register.3.adoc @@ -11,7 +11,7 @@ == NAME -nng_ws_register - register WebSocket secure transport +nng_wss_register - register WebSocket secure transport == SYNOPSIS |