From ec6acef262bc96f0763a455ec1c0c8f1e3746d0d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 31 May 2018 17:00:09 -0700 Subject: man page updates for tip --- man/tip/index.html | 100 +++++++-- man/tip/libnng.3.html | 8 +- man/tip/nn_allocmsg.3compat.html | 4 +- man/tip/nn_bind.3compat.html | 2 +- man/tip/nn_close.3compat.html | 2 +- man/tip/nn_cmsg.3compat.html | 4 +- man/tip/nn_connect.3compat.html | 4 +- man/tip/nn_device.3compat.html | 38 ++-- man/tip/nn_errno.3compat.html | 2 +- man/tip/nn_freemsg.3compat.html | 2 +- man/tip/nn_get_statistic.3compat.html | 2 +- man/tip/nn_getsockopt.3compat.html | 6 +- man/tip/nn_poll.3compat.html | 8 +- man/tip/nn_reallocmsg.3compat.html | 2 +- man/tip/nn_recv.3compat.html | 2 +- man/tip/nn_recvmsg.3compat.html | 6 +- man/tip/nn_send.3compat.html | 2 +- man/tip/nn_sendmsg.3compat.html | 4 +- man/tip/nn_setsockopt.3compat.html | 8 +- man/tip/nn_shutdown.3compat.html | 2 +- man/tip/nn_socket.3compat.html | 2 +- man/tip/nn_strerror.3compat.html | 2 +- man/tip/nn_term.3compat.html | 2 +- man/tip/nng.7.html | 190 +++++++++++----- man/tip/nng_aio.5.html | 4 +- man/tip/nng_aio_abort.3.html | 2 +- man/tip/nng_aio_alloc.3.html | 18 +- man/tip/nng_aio_cancel.3.html | 2 +- man/tip/nng_aio_count.3.html | 2 +- man/tip/nng_aio_finish.3.html | 2 +- man/tip/nng_aio_free.3.html | 2 +- man/tip/nng_aio_get_input.3.html | 2 +- man/tip/nng_aio_get_msg.3.html | 2 +- man/tip/nng_aio_get_output.3.html | 2 +- man/tip/nng_aio_result.3.html | 30 ++- man/tip/nng_aio_set_input.3.html | 2 +- man/tip/nng_aio_set_iov.3.html | 28 ++- man/tip/nng_aio_set_msg.3.html | 2 +- man/tip/nng_aio_set_output.3.html | 2 +- man/tip/nng_aio_set_timeout.3.html | 2 +- man/tip/nng_aio_stop.3.html | 2 +- man/tip/nng_aio_wait.3.html | 2 +- man/tip/nng_alloc.3.html | 2 +- man/tip/nng_bus.7.html | 4 +- man/tip/nng_bus_open.3.html | 28 ++- man/tip/nng_clock.3supp.html | 2 +- man/tip/nng_close.3.html | 18 +- man/tip/nng_compat.3compat.html | 287 ++++++++++++------------- man/tip/nng_ctx.5.html | 6 +- man/tip/nng_ctx_close.3.html | 18 +- man/tip/nng_ctx_getopt.3.html | 74 ++++--- man/tip/nng_ctx_id.3.html | 2 +- man/tip/nng_ctx_open.3.html | 28 ++- man/tip/nng_ctx_recv.3.html | 68 ++++-- man/tip/nng_ctx_send.3.html | 80 ++++--- man/tip/nng_ctx_setopt.3.html | 60 ++++-- man/tip/nng_cv_alloc.3supp.html | 18 +- man/tip/nng_cv_free.3supp.html | 2 +- man/tip/nng_cv_until.3supp.html | 2 +- man/tip/nng_cv_wait.3supp.html | 2 +- man/tip/nng_cv_wake.3supp.html | 2 +- man/tip/nng_cv_wake1.3supp.html | 2 +- man/tip/nng_device.3.html | 50 +++-- man/tip/nng_dial.3.html | 98 ++++++--- man/tip/nng_dialer.5.html | 2 +- man/tip/nng_dialer_close.3.html | 20 +- man/tip/nng_dialer_create.3.html | 38 ++-- man/tip/nng_dialer_getopt.3.html | 72 ++++--- man/tip/nng_dialer_id.3.html | 2 +- man/tip/nng_dialer_setopt.3.html | 70 ++++-- man/tip/nng_dialer_start.3.html | 108 +++++++--- man/tip/nng_duration.5.html | 4 +- man/tip/nng_free.3.html | 2 +- man/tip/nng_getopt.3.html | 74 ++++--- man/tip/nng_http_client_alloc.3http.html | 30 ++- man/tip/nng_http_client_connect.3http.html | 58 +++-- man/tip/nng_http_client_free.3http.html | 2 +- man/tip/nng_http_client_get_tls.3http.html | 28 ++- man/tip/nng_http_client_set_tls.3http.html | 28 ++- man/tip/nng_http_conn_close.3http.html | 2 +- man/tip/nng_http_conn_read.3http.html | 78 ++++--- man/tip/nng_http_conn_read_all.3http.html | 80 ++++--- man/tip/nng_http_conn_read_req.3http.html | 68 ++++-- man/tip/nng_http_conn_read_res.3http.html | 68 ++++-- man/tip/nng_http_conn_write.3http.html | 78 ++++--- man/tip/nng_http_conn_write_all.3http.html | 82 ++++--- man/tip/nng_http_conn_write_req.3http.html | 70 ++++-- man/tip/nng_http_conn_write_res.3http.html | 68 ++++-- man/tip/nng_http_handler_alloc.3http.html | 44 ++-- man/tip/nng_http_handler_free.3http.html | 2 +- man/tip/nng_http_handler_get_data.3http.html | 2 +- man/tip/nng_http_handler_set_data.3http.html | 28 ++- man/tip/nng_http_handler_set_host.3http.html | 30 ++- man/tip/nng_http_handler_set_method.3http.html | 28 ++- man/tip/nng_http_handler_set_tree.3http.html | 28 ++- man/tip/nng_http_hijack.3http.html | 38 ++-- man/tip/nng_http_req_add_header.3http.html | 28 ++- man/tip/nng_http_req_alloc.3http.html | 28 ++- man/tip/nng_http_req_copy_data.3http.html | 28 ++- man/tip/nng_http_req_del_header.3http.html | 28 ++- man/tip/nng_http_req_free.3http.html | 2 +- man/tip/nng_http_req_get_header.3http.html | 2 +- man/tip/nng_http_req_get_method.3http.html | 2 +- man/tip/nng_http_req_get_uri.3http.html | 6 +- man/tip/nng_http_req_get_version.3http.html | 2 +- man/tip/nng_http_req_set_data.3http.html | 28 ++- man/tip/nng_http_req_set_header.3http.html | 28 ++- man/tip/nng_http_req_set_method.3http.html | 28 ++- man/tip/nng_http_req_set_uri.3http.html | 28 ++- man/tip/nng_http_req_set_version.3http.html | 28 ++- man/tip/nng_http_res_add_header.3http.html | 28 ++- man/tip/nng_http_res_alloc.3http.html | 28 ++- man/tip/nng_http_res_alloc_error.3http.html | 28 ++- man/tip/nng_http_res_copy_data.3http.html | 28 ++- man/tip/nng_http_res_del_header.3http.html | 28 ++- man/tip/nng_http_res_free.3http.html | 2 +- man/tip/nng_http_res_get_header.3http.html | 2 +- man/tip/nng_http_res_get_reason.3http.html | 2 +- man/tip/nng_http_res_get_status.3http.html | 2 +- man/tip/nng_http_res_get_version.3http.html | 2 +- man/tip/nng_http_res_set_data.3http.html | 28 ++- man/tip/nng_http_res_set_header.3http.html | 28 ++- man/tip/nng_http_res_set_reason.3http.html | 32 +-- man/tip/nng_http_res_set_status.3http.html | 20 +- man/tip/nng_http_res_set_version.3http.html | 28 ++- man/tip/nng_http_server_add_handler.3http.html | 38 ++-- man/tip/nng_http_server_del_handler.3http.html | 28 ++- man/tip/nng_http_server_get_tls.3http.html | 28 ++- man/tip/nng_http_server_hold.3http.html | 28 ++- man/tip/nng_http_server_release.3http.html | 2 +- man/tip/nng_http_server_set_tls.3http.html | 38 ++-- man/tip/nng_http_server_start.3http.html | 50 +++-- man/tip/nng_http_server_stop.3http.html | 2 +- man/tip/nng_inproc.7.html | 2 +- man/tip/nng_inproc_register.3.html | 28 ++- man/tip/nng_iov.5.html | 2 +- man/tip/nng_ipc.7.html | 4 +- man/tip/nng_ipc_register.3.html | 28 ++- man/tip/nng_listen.3.html | 58 +++-- man/tip/nng_listener.5.html | 2 +- man/tip/nng_listener_close.3.html | 18 +- man/tip/nng_listener_create.3.html | 38 ++-- man/tip/nng_listener_getopt.3.html | 72 ++++--- man/tip/nng_listener_id.3.html | 2 +- man/tip/nng_listener_setopt.3.html | 70 ++++-- man/tip/nng_listener_start.3.html | 28 ++- man/tip/nng_msg.5.html | 20 +- man/tip/nng_msg_alloc.3.html | 18 +- man/tip/nng_msg_append.3.html | 18 +- man/tip/nng_msg_body.3.html | 2 +- man/tip/nng_msg_chop.3.html | 18 +- man/tip/nng_msg_clear.3.html | 2 +- man/tip/nng_msg_dup.3.html | 18 +- man/tip/nng_msg_free.3.html | 2 +- man/tip/nng_msg_get_pipe.3.html | 4 +- man/tip/nng_msg_header.3.html | 2 +- man/tip/nng_msg_header_append.3.html | 18 +- man/tip/nng_msg_header_chop.3.html | 18 +- man/tip/nng_msg_header_clear.3.html | 2 +- man/tip/nng_msg_header_insert.3.html | 18 +- man/tip/nng_msg_header_len.3.html | 2 +- man/tip/nng_msg_header_trim.3.html | 18 +- man/tip/nng_msg_insert.3.html | 20 +- man/tip/nng_msg_len.3.html | 2 +- man/tip/nng_msg_realloc.3.html | 18 +- man/tip/nng_msg_set_pipe.3.html | 2 +- man/tip/nng_msg_trim.3.html | 18 +- man/tip/nng_msleep.3supp.html | 2 +- man/tip/nng_mtx_alloc.3supp.html | 18 +- man/tip/nng_mtx_free.3supp.html | 2 +- man/tip/nng_mtx_lock.3supp.html | 2 +- man/tip/nng_mtx_unlock.3supp.html | 4 +- man/tip/nng_options.5.html | 10 +- man/tip/nng_opts_parse.3supp.html | 40 ++-- man/tip/nng_pair.7.html | 14 +- man/tip/nng_pair_open.3.html | 28 ++- man/tip/nng_pipe.5.html | 2 +- man/tip/nng_pipe_close.3.html | 18 +- man/tip/nng_pipe_dialer.3.html | 2 +- man/tip/nng_pipe_getopt.3.html | 83 ++++--- man/tip/nng_pipe_id.3.html | 2 +- man/tip/nng_pipe_listener.3.html | 4 +- man/tip/nng_pipe_notify.3.html | 18 +- man/tip/nng_pipe_socket.3.html | 2 +- man/tip/nng_pub.7.html | 2 +- man/tip/nng_pub_open.3.html | 28 ++- man/tip/nng_pull.7.html | 2 +- man/tip/nng_pull_open.3.html | 28 ++- man/tip/nng_push.7.html | 4 +- man/tip/nng_push_open.3.html | 28 ++- man/tip/nng_random.3supp.html | 2 +- man/tip/nng_recv.3.html | 78 ++++--- man/tip/nng_recv_aio.3.html | 68 ++++-- man/tip/nng_recvmsg.3.html | 68 ++++-- man/tip/nng_rep.7.html | 2 +- man/tip/nng_rep_open.3.html | 28 ++- man/tip/nng_req.7.html | 6 +- man/tip/nng_req_open.3.html | 28 ++- man/tip/nng_respondent.7.html | 2 +- man/tip/nng_respondent_open.3.html | 28 ++- man/tip/nng_send.3.html | 82 ++++--- man/tip/nng_send_aio.3.html | 80 ++++--- man/tip/nng_sendmsg.3.html | 80 ++++--- man/tip/nng_setopt.3.html | 60 ++++-- man/tip/nng_sleep_aio.3.html | 2 +- man/tip/nng_sockaddr.5.html | 87 +++++--- man/tip/nng_sockaddr_in.5.html | 8 +- man/tip/nng_sockaddr_in6.5.html | 8 +- man/tip/nng_sockaddr_inproc.5.html | 4 +- man/tip/nng_sockaddr_ipc.5.html | 10 +- man/tip/nng_sockaddr_zt.5.html | 4 +- man/tip/nng_socket.5.html | 2 +- man/tip/nng_socket_id.3.html | 4 +- man/tip/nng_strdup.3.html | 4 +- man/tip/nng_strerror.3.html | 2 +- man/tip/nng_strfree.3.html | 2 +- man/tip/nng_sub.7.html | 2 +- man/tip/nng_sub_open.3.html | 28 ++- man/tip/nng_surveyor.7.html | 6 +- man/tip/nng_surveyor_open.3.html | 28 ++- man/tip/nng_tcp.7.html | 2 +- man/tip/nng_tcp_register.3.html | 28 ++- man/tip/nng_thread_create.3supp.html | 18 +- man/tip/nng_thread_destroy.3supp.html | 2 +- man/tip/nng_tls.7.html | 4 +- man/tip/nng_tls_config_alloc.3tls.html | 34 +-- man/tip/nng_tls_config_auth_mode.3tls.html | 40 ++-- man/tip/nng_tls_config_ca_chain.3tls.html | 38 ++-- man/tip/nng_tls_config_ca_file.3tls.html | 58 +++-- man/tip/nng_tls_config_cert_key_file.3tls.html | 58 +++-- man/tip/nng_tls_config_free.3tls.html | 2 +- man/tip/nng_tls_config_own_cert.3tls.html | 38 ++-- man/tip/nng_tls_config_server_name.3tls.html | 28 ++- man/tip/nng_tls_register.3.html | 28 ++- man/tip/nng_url_clone.3.html | 18 +- man/tip/nng_url_free.3.html | 2 +- man/tip/nng_url_parse.3.html | 30 ++- man/tip/nng_version.3.html | 2 +- man/tip/nng_ws.7.html | 2 +- man/tip/nng_ws_register.3.html | 30 ++- man/tip/nng_wss_register.3.html | 30 ++- man/tip/nng_zerotier.7.html | 4 +- man/tip/nng_zt_register.3.html | 28 ++- man/tip/nngcat.1.html | 88 ++++---- 244 files changed, 3716 insertions(+), 2107 deletions(-) diff --git a/man/tip/index.html b/man/tip/index.html index e4e300d2..5faa5639 100644 --- a/man/tip/index.html +++ b/man/tip/index.html @@ -470,7 +470,7 @@ with the distribution.

nngcat(1)

-

command line access to Scalabity Protocols

+

command line access to Scalability Protocols

@@ -480,8 +480,13 @@ with the distribution.

Section 3: Library Functions

-

This section documents core libary functions that are -callable by applications.

+

This section documents core libary functions supporting Scalability +Protocols.

+
+
+

Most Scalability Protocols applications can be written using just +the functions documented in this section, as this represents the +primary API for building such applications.

@@ -895,11 +900,11 @@ callable by applications.

- + - + @@ -913,9 +918,30 @@ callable by applications.

Section 3compat: Compatible Library Functions

-

This section documents the nanomsg 1.0 libary compatible functions. -The functions in this section not be used except to aid in transitioning -from the older libnanomsg library.

+

This section documents the nanomsg 1.0 libary compatible functions.

+
+
+

These functions are provided as a transition aid, for application +developers coming to NNG from libnanomsg, and are discouraged +from use in new applications.

+
+
+

nng_ws_register(3)

register websocket transport

register WebSocket transport

nng_wss_register(3)

register websocket secure transport

register WebSocket secure transport

nng_zt_register(3)
+ + + + +
+ + +While this is discouraged for long term use, as a transition aid +applications may use the value returned by the +nng_socket_id() in these functions just like a +socket descriptor (as if the socket were opened +via nn_socket()). +This sort of API intermixing should only be used during transition from +the legacy API to the new API. +
@@ -1019,8 +1045,19 @@ from the older libnanomsg library.

Section 3http: Supplemental HTTP Functions

-

This section documents supplemental HTTP support functions -that are available.

+

This section documents supplemental HTTP (HyperText Transport Protocol) +support functions that are available.

+
+
+

These functions can be used in conjunction with the +WebSocket transport for Scalability Protocols, or they +may be used to construct other types of applications that communicate +using HTTP.

+
+
+

It is also possible to combine the two, such that an HTTP server providing +static or dynamic content can also be used to host one or more Scalability +Protocols sockets.

@@ -1273,8 +1310,13 @@ that are available.

This section documents supplemental functions that are available. -These functions are not intrinsic to building applications with -this library, but their presence may facilitate writing portable applications.

+These functions are not intrinsic to building Scalability Protocols +applications with this library.

+
+
+

However, their use may facilitate writing portable applications by +providing uniform functions for common application needs such as +mutual exclusion locks, threading, time keeping, and similar needs.

@@ -1354,7 +1396,21 @@ this library, but their presence may facilitate writing portable applications.Section 3tls: Supplemental TLS Functions
-

This section documents supplemental TLS functions that are available.

+

This section documents supplemental TLS (Transport Layer Security) +functions that are available. +TLS support is available when using Scalability Protocols with +the TLS transport, or when using WebSocket, either +with the WebSocket transport for Scalability Protocols, +or combined with other HTTP capabilities.

+
+
+

These functions depend on library support that is not included directly +with NNG however, so their presence will depend on whether this +additional support was present and enabled with libnng was built.

+
+
+

Currently, this extra support can be provided by the +mbedTLS library.

@@ -1404,6 +1460,10 @@ this library, but their presence may facilitate writing portable applications.

This section documents core macros and types that are available.

+
+

These are the core types and macros that most Scalabilty Protocols +applications need will use.

+
@@ -1485,6 +1545,20 @@ this library, but their presence may facilitate writing portable applications.This sections documents various protocols and transports that are available in the distribution.

+
+

+Protocols represent “patterns” of communication, such as +request/reply, publish/subscribe, and so forth. +A given socket is created with exactly one protocol, and that +protocol defines the key behavior of the socket.

+
+
+

+Conversely, transports are the underlying mechansims by which messages +are moved between participants, such as TCP/IP or UNIX domain IPC. +A given socket may be using several transports at the same +time.

+
diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index 6d1758ce..99be7012 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -639,7 +639,7 @@ intended to solve common communication problems in distributed applications.

Connection Management

The following functions are used with either listeners, or dialers. -Listeners accept incoming connection requets, and dialers make them.

+Listeners accept incoming connection requests, and dialers make them.

@@ -724,11 +724,11 @@ Listeners accept incoming connection requets, and dialers make them.

- + - + @@ -1596,7 +1596,7 @@ with TLS support.

SEE ALSO

-
+

nng_compat(3compat), nng(7)

diff --git a/man/tip/nn_allocmsg.3compat.html b/man/tip/nn_allocmsg.3compat.html index 33861666..44ec2748 100644 --- a/man/tip/nn_allocmsg.3compat.html +++ b/man/tip/nn_allocmsg.3compat.html @@ -539,7 +539,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nn_allocmsg() allocates a message structure of size size, and is primarily used to support zero-copy send operations, making use of the NNG_MSG special size indicator. -The value returned is a pointer ot the start of the message payload buffer.

+The value returned is a pointer to the start of the message payload buffer.

The value of size must be positive, and small enough to hold reasonable @@ -616,7 +616,7 @@ on failure.

SEE ALSO

-
+

nn_errno(3compat), nn_freemsg(3compat), nn_reallocmsg(3compat), diff --git a/man/tip/nn_bind.3compat.html b/man/tip/nn_bind.3compat.html index cc700456..764bcc51 100644 --- a/man/tip/nn_bind.3compat.html +++ b/man/tip/nn_bind.3compat.html @@ -640,7 +640,7 @@ supported with this function.

SEE ALSO

-
+

nn_connect(3compat), nn_errno(3compat), nn_shutdown(3compat), diff --git a/man/tip/nn_close.3compat.html b/man/tip/nn_close.3compat.html index ef4173f5..f41fb5ec 100644 --- a/man/tip/nn_close.3compat.html +++ b/man/tip/nn_close.3compat.html @@ -592,7 +592,7 @@ Consider using the relevant modern API instead.

SEE ALSO

-
+

nn_errno(3compat), nn_socket(3compat), nng_compat(3compat), diff --git a/man/tip/nn_cmsg.3compat.html b/man/tip/nn_cmsg.3compat.html index c87acaff..e2c9b8f0 100644 --- a/man/tip/nn_cmsg.3compat.html +++ b/man/tip/nn_cmsg.3compat.html @@ -596,7 +596,7 @@ bytes of following data, and any necessary padding.

size_t NN_CMSG_LEN(size_t len)
-

This macro evalutes to the length of the header (including alignment), +

This macro evaluates to the length of the header (including alignment), and the associated data of length len, but without any trailing padding to align for another header.

@@ -607,7 +607,7 @@ to align for another header.

SEE ALSO

-
+

nn_recvmsg(3compat), nn_sendmsg(3compat), nng_compat(3compat), diff --git a/man/tip/nn_connect.3compat.html b/man/tip/nn_connect.3compat.html index cde634a1..62b51e5e 100644 --- a/man/tip/nn_connect.3compat.html +++ b/man/tip/nn_connect.3compat.html @@ -537,7 +537,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nn_connect() function arranges for the socket sock to -inititate connection to a peer at the address specified by url. +initiate connection to a peer at the address specified by url. An “endpoint identifier” for this socket’s association with the url is returned to the caller on success. This ID can be used with nn_shutdown() to @@ -632,7 +632,7 @@ supported with this function.

SEE ALSO

-
+

nn_bind(3compat), nn_errno(3compat), nn_shutdown(3compat), diff --git a/man/tip/nn_device.3compat.html b/man/tip/nn_device.3compat.html index 34e803e3..f7e7a658 100644 --- a/man/tip/nn_device.3compat.html +++ b/man/tip/nn_device.3compat.html @@ -574,28 +574,40 @@ one of the sockets is closed or an error occurs.

ERRORS

-
-
-
EBADF
-
+
+

return listener that created pipe

nng_pipe_notify())

nng_pipe_notify()

register pipe notification callback

nng_pipe_socket())

nng_pipe_socket()

return owning socket for pipe
+ + + + + + + + + + + + +
+EBADF +

One of the two sockets is invalid or not open, or has

- -
EINVAL
-
+
+EINVAL +

The sockets are not compatible with each other, or not both raw.

- -
ENOMEM
-
+
+ENOMEM +

Insufficient memory is available.

- - +

SEE ALSO

-
+

nn_errno(3compat), nn_socket(3compat), nng_compat(3compat), diff --git a/man/tip/nn_errno.3compat.html b/man/tip/nn_errno.3compat.html index 971ceed1..4fb037f6 100644 --- a/man/tip/nn_errno.3compat.html +++ b/man/tip/nn_errno.3compat.html @@ -764,7 +764,7 @@ If no operation has failed, then this will be zero.

SEE ALSO

-
+

nn_strerror(3compat), nng_compat(3compat), nng(7)

diff --git a/man/tip/nn_freemsg.3compat.html b/man/tip/nn_freemsg.3compat.html index f5f595c9..a3487548 100644 --- a/man/tip/nn_freemsg.3compat.html +++ b/man/tip/nn_freemsg.3compat.html @@ -574,7 +574,7 @@ Consider using the relevant modern API instead.

SEE ALSO

-
+

nn_allocmsg(3compat), nn_freemsg(3compat), nn_errno(3compat), diff --git a/man/tip/nn_get_statistic.3compat.html b/man/tip/nn_get_statistic.3compat.html index ab8a5219..0a04fe58 100644 --- a/man/tip/nn_get_statistic.3compat.html +++ b/man/tip/nn_get_statistic.3compat.html @@ -574,7 +574,7 @@ Consider using the relevant modern API instead.

SEE ALSO

-
+

nng_compat(3compat), nng(7)

diff --git a/man/tip/nn_getsockopt.3compat.html b/man/tip/nn_getsockopt.3compat.html index 268f2f4b..fc8128d5 100644 --- a/man/tip/nn_getsockopt.3compat.html +++ b/man/tip/nn_getsockopt.3compat.html @@ -699,10 +699,10 @@ The default is 100.

Maximum reconnect interval in milliseconds. Subsequent reconnection attempts after a failed attempt are made at -exponentially increasing intervals (backoff), but the interval is +exponentially increasing intervals (back-off), but the interval is capped by this value. If this value is smaller than NN_RECONNECT_IVL, then no exponential -backoff is performed, and each reconnect interval will be determined +back-off is performed, and each reconnect interval will be determined solely by NN_RECONNECT_IVL. The default is zero.

@@ -960,7 +960,7 @@ in this implementation.

SEE ALSO

-
+

nng_socket(5), nn_close(3compat), nn_errno(3compat), diff --git a/man/tip/nn_poll.3compat.html b/man/tip/nn_poll.3compat.html index bc23ef2e..becda07b 100644 --- a/man/tip/nn_poll.3compat.html +++ b/man/tip/nn_poll.3compat.html @@ -569,7 +569,7 @@ of the flags NN_POLLIN and NN_POLLOUT.

The flag NN_POLLIN indicates that a socket is ready for receiving without -blocking (a message is avaiable on the socket), and the flag NN_POLLOUT +blocking (a message is available on the socket), and the flag NN_POLLOUT indicates that a socket is ready for sending without blocking.

@@ -604,11 +604,11 @@ after updating the current status of the sockets.

If the timeout is -1, then the function waits forever, or until one of the requested events occurs.

-
+
@@ -554,9 +569,24 @@ New applications should use the newer nng API
- + This function is only suitable for use with sockets obtained with the @@ -701,7 +701,7 @@ platforms and Windows.

SEE ALSO

-
+

nn_errno(3compat), nn_recv(3compat), nn_send(3compat), diff --git a/man/tip/nn_reallocmsg.3compat.html b/man/tip/nn_reallocmsg.3compat.html index df685b56..c11e01ac 100644 --- a/man/tip/nn_reallocmsg.3compat.html +++ b/man/tip/nn_reallocmsg.3compat.html @@ -608,7 +608,7 @@ on failure.

SEE ALSO

-
+

nn_allocmsg(3compat), nn_freemsg(3compat), nn_errno(3compat), diff --git a/man/tip/nn_recv.3compat.html b/man/tip/nn_recv.3compat.html index 57558c4e..516087b5 100644 --- a/man/tip/nn_recv.3compat.html +++ b/man/tip/nn_recv.3compat.html @@ -637,7 +637,7 @@ the operation shall not block, but instead will fail with the error EAGAIN

SEE ALSO

-
+

nn_errno(3compat), nn_recvmsg(3compat), nn_send(3compat), diff --git a/man/tip/nn_recvmsg.3compat.html b/man/tip/nn_recvmsg.3compat.html index e241bdf7..d9d4a95e 100644 --- a/man/tip/nn_recvmsg.3compat.html +++ b/man/tip/nn_recvmsg.3compat.html @@ -536,7 +536,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

DESCRIPTION

-

The nn_recvmsg() function receives a message into the heade described by +

The nn_recvmsg() function receives a message into the header described by hdr using the socket sock.

@@ -594,7 +594,7 @@ or similar when it is no longer needed.

The values of msg_control and msg_controllen describe a buffer of ancillary data associated with the message. -This is currenly only useful to obtain the message headers +This is currently only useful to obtain the message headers used with raw mode sockets. In all other circumstances these fields should be zero. Details about this structure are covered in @@ -670,7 +670,7 @@ Details about this structure are covered in

SEE ALSO

-
+

nn_cmsg(3compat), nn_errno(3compat), nn_recv(3compat), diff --git a/man/tip/nn_send.3compat.html b/man/tip/nn_send.3compat.html index 8071118f..948ee1f0 100644 --- a/man/tip/nn_send.3compat.html +++ b/man/tip/nn_send.3compat.html @@ -646,7 +646,7 @@ completed before this function returns control to the caller.

SEE ALSO

-
+

nn_errno(3compat), nn_recv(3compat), nn_sendmsg(3compat), diff --git a/man/tip/nn_sendmsg.3compat.html b/man/tip/nn_sendmsg.3compat.html index d35a9752..c843ea09 100644 --- a/man/tip/nn_sendmsg.3compat.html +++ b/man/tip/nn_sendmsg.3compat.html @@ -599,7 +599,7 @@ at its choice.)

The values of msg_control and msg_controllen describe a buffer of ancillary data to send the message. -This is currenly only useful to provide the message headers +This is currently only useful to provide the message headers used with raw mode sockets. In all other circumstances these fields should be zero. Details about this structure are covered in @@ -688,7 +688,7 @@ completed before this function returns control to the caller.

SEE ALSO

-
+

nn_cmsg(3compat), nn_errno(3compat), nn_recv(3compat), diff --git a/man/tip/nn_setsockopt.3compat.html b/man/tip/nn_setsockopt.3compat.html index 326c1946..714219e0 100644 --- a/man/tip/nn_setsockopt.3compat.html +++ b/man/tip/nn_setsockopt.3compat.html @@ -619,7 +619,7 @@ thus size 4, unless otherwise indicated.)

In nng buffers are sized as a count of messages rather than bytes, and so an attempt to estimate a conversion based upon a predetermined message size of 1kB is made. -The value supplied is rouned up to the nearest value divisible by 1024, and +The value supplied is rounded up to the nearest value divisible by 1024, and then divided by 1024 to convert to a message count. Applications that have unusual message sizes may wish to adjust the value used here accordingly. @@ -683,10 +683,10 @@ The default is 100.

Maximum reconnect interval in milliseconds. Subsequent reconnection attempts after a failed attempt are made at -exponentially increasing intervals (backoff), but the interval is +exponentially increasing intervals (back-off), but the interval is capped by this value. If this value is smaller than NN_RECONNECT_IVL, then no exponential -backoff is performed, and each reconnect interval will be determined +back-off is performed, and each reconnect interval will be determined solely by NN_RECONNECT_IVL. The default is zero.

@@ -917,7 +917,7 @@ in this implementation.

SEE ALSO

-
+

nng_socket(5), nn_close(3compat), nn_errno(3compat), diff --git a/man/tip/nn_shutdown.3compat.html b/man/tip/nn_shutdown.3compat.html index bcab691f..35894e8a 100644 --- a/man/tip/nn_shutdown.3compat.html +++ b/man/tip/nn_shutdown.3compat.html @@ -594,7 +594,7 @@ Consider using the relevant modern API instead.

SEE ALSO

-
+

nn_bind(3compat), nn_connect(3compat), nn_errno(3compat), diff --git a/man/tip/nn_socket.3compat.html b/man/tip/nn_socket.3compat.html index 7ce2f3e2..4bda69b8 100644 --- a/man/tip/nn_socket.3compat.html +++ b/man/tip/nn_socket.3compat.html @@ -735,7 +735,7 @@ The following protocols are defined:

SEE ALSO

-
+

nng_socket(5), nn_close(3compat), nn_errno(3compat), diff --git a/man/tip/nn_strerror.3compat.html b/man/tip/nn_strerror.3compat.html index 9478f58c..9dbedd27 100644 --- a/man/tip/nn_strerror.3compat.html +++ b/man/tip/nn_strerror.3compat.html @@ -574,7 +574,7 @@ Consider using the relevant modern API instead.

SEE ALSO

-
+

nn_errno(3compat), nng_compat(3compat), nng(7)

diff --git a/man/tip/nn_term.3compat.html b/man/tip/nn_term.3compat.html index efeeb378..7b9953f9 100644 --- a/man/tip/nn_term.3compat.html +++ b/man/tip/nn_term.3compat.html @@ -595,7 +595,7 @@ own sockets directly.

SEE ALSO

-
+

nn_errno(3compat), nn_socket(3compat), nng_compat(3compat), diff --git a/man/tip/nng.7.html b/man/tip/nng.7.html index b6517f9a..c02ba10f 100644 --- a/man/tip/nng.7.html +++ b/man/tip/nng.7.html @@ -580,66 +580,146 @@ other languages please check the website.

Protocols

-
- +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+nng_bus(7) + +

Bus protocol

+
+nng_pair(7) + +

Pair protocol

+
+nng_pub(7) + +

Publisher side of publish/subscribe protocol

+
+nng_pull(7) + +

Pull side of pipeline protocol

+
+nng_push(7) + +

Push side of pipeline protocol

+
+nng_sub(7) + +

Subscriber side of publish/subscribe protocol

+
+nng_rep(7) + +

Reply side of request/reply protocol

+
+nng_req(7) + +

Request side of request/reply protocol

+
+nng_respondent(7) + +

Respondent side of survey protocol

+
+nng_surveyor(7) + +

Surveyor side of survey protocol

+

Transports

-
- +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+nng_inproc(7) + +

Intra-process transport

+
+nng_ipc(7) + +

Inter-process transport

+
+nng_tls(7) + +

TLSv1.2 over TCP transport

+
+nng_tcp(7) + +

TCP (and TCPv6) transport

+
+nng_ws(7) + +

WebSocket transport

+
+nng_zerotier(7) + +

ZeroTier transport

+
@@ -817,7 +897,7 @@ confusion when they are parsed on different systems.

SEE ALSO

-
+

libnng(3), nng_compat(3compat)

diff --git a/man/tip/nng_aio.5.html b/man/tip/nng_aio.5.html index f88c4d39..6ec6638d 100644 --- a/man/tip/nng_aio.5.html +++ b/man/tip/nng_aio.5.html @@ -534,7 +534,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

DESCRIPTION

-

An nng_aio is an opaque structure used in conjuction with +

An nng_aio is an opaque structure used in conjunction with asynchronous I/O operations. Every asynchronous operation uses one of these structures, each of which can only be used with a single operation at a time.

@@ -566,7 +566,7 @@ and destroyed using nng_aio_free()

SEE ALSO

-
+

nng_aio_abort(3), nng_aio_alloc(3), nng_aio_cancel(3), diff --git a/man/tip/nng_aio_abort.3.html b/man/tip/nng_aio_abort.3.html index 54e663a0..2f515d5d 100644 --- a/man/tip/nng_aio_abort.3.html +++ b/man/tip/nng_aio_abort.3.html @@ -572,7 +572,7 @@ has no effect.

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_cancel(3), nng_aio_result(3), diff --git a/man/tip/nng_aio_alloc.3.html b/man/tip/nng_aio_alloc.3.html index 43b05384..939dcab5 100644 --- a/man/tip/nng_aio_alloc.3.html +++ b/man/tip/nng_aio_alloc.3.html @@ -588,20 +588,24 @@ operation is complete except by calling the aforementioned

ERRORS

-
-
-
NNG_ENOMEM
-
+
+ + + + + +
+NNG_ENOMEM +

Insufficient free memory to perform the operation.

- - +

SEE ALSO

-
+

nng_aio_abort(3), nng_aio_cancel(3), nng_aio_count(3), diff --git a/man/tip/nng_aio_cancel.3.html b/man/tip/nng_aio_cancel.3.html index 1dacb1b1..7780ec85 100644 --- a/man/tip/nng_aio_cancel.3.html +++ b/man/tip/nng_aio_cancel.3.html @@ -585,7 +585,7 @@ This function is the same as calling

SEE ALSO

-
+

nng_aio_abort(3), nng_aio_alloc(3), nng_aio_result(3), diff --git a/man/tip/nng_aio_count.3.html b/man/tip/nng_aio_count.3.html index 9c2c8211..afbdd339 100644 --- a/man/tip/nng_aio_count.3.html +++ b/man/tip/nng_aio_count.3.html @@ -586,7 +586,7 @@ or after waiting for the operation to complete with

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_result(3), nng_aio_set_iov(3), diff --git a/man/tip/nng_aio_finish.3.html b/man/tip/nng_aio_finish.3.html index 08019d94..3b78adca 100644 --- a/man/tip/nng_aio_finish.3.html +++ b/man/tip/nng_aio_finish.3.html @@ -594,7 +594,7 @@ users of the aio should not have any need for this function.

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_cancel(3), nng_aio_result(3), diff --git a/man/tip/nng_aio_free.3.html b/man/tip/nng_aio_free.3.html index fcb70442..a09b316d 100644 --- a/man/tip/nng_aio_free.3.html +++ b/man/tip/nng_aio_free.3.html @@ -563,7 +563,7 @@ that it is safe to deallocate the handle and any associated resources.

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_stop(3), nng_aio(5), diff --git a/man/tip/nng_aio_get_input.3.html b/man/tip/nng_aio_get_input.3.html index a084e0a0..6630b464 100644 --- a/man/tip/nng_aio_get_input.3.html +++ b/man/tip/nng_aio_get_input.3.html @@ -568,7 +568,7 @@ or of the input parameter was not previously set, then NULL is retu

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_get_output(3), nng_aio_set_input(3), diff --git a/man/tip/nng_aio_get_msg.3.html b/man/tip/nng_aio_get_msg.3.html index eeb9175f..82cf03d3 100644 --- a/man/tip/nng_aio_get_msg.3.html +++ b/man/tip/nng_aio_get_msg.3.html @@ -574,7 +574,7 @@ The nng_aio must not have an operation

SEE ALSO

-
+

nng_aio_set_msg(3), nng_recv_aio(3), nng_aio(5), diff --git a/man/tip/nng_aio_get_output.3.html b/man/tip/nng_aio_get_output.3.html index a366a8b7..2c0e1542 100644 --- a/man/tip/nng_aio_get_output.3.html +++ b/man/tip/nng_aio_get_output.3.html @@ -591,7 +591,7 @@ performed using the aio yet.

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_get_output(3), nng_aio_set_input(3), diff --git a/man/tip/nng_aio_result.3.html b/man/tip/nng_aio_result.3.html index 4462f5b6..d758a35f 100644 --- a/man/tip/nng_aio_result.3.html +++ b/man/tip/nng_aio_result.3.html @@ -571,27 +571,35 @@ number on failure.

ERRORS

-
-
-
NNG_ETIMEDOUT
-
+
+ + + + + + + + + +
+NNG_ETIMEDOUT +

The operation timed out.

- -
NNG_ECANCELED
-
+
+NNG_ECANCELED +

The operation was canceled.

- - +
-

Various other return values are possible dependending on the operation.

+

Various other return values are possible depending on the operation.

SEE ALSO

-
+

nng_aio_abort(3), nng_aio_alloc(3), nng_aio_wait(3), diff --git a/man/tip/nng_aio_set_input.3.html b/man/tip/nng_aio_set_input.3.html index fe4b6835..cda8094a 100644 --- a/man/tip/nng_aio_set_input.3.html +++ b/man/tip/nng_aio_set_input.3.html @@ -600,7 +600,7 @@ the nng_aio_get_input() func

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_get_input(3), nng_aio_get_output(3), diff --git a/man/tip/nng_aio_set_iov.3.html b/man/tip/nng_aio_set_iov.3.html index 02e936ed..d99163b0 100644 --- a/man/tip/nng_aio_set_iov.3.html +++ b/man/tip/nng_aio_set_iov.3.html @@ -583,24 +583,32 @@ generally result in NNG_EINVAL.

ERRORS

-
-
-
NNG_ENOMEM
-
+
+ + + + + + + + + +
+NNG_ENOMEM +

Insufficient free memory to perform operation.

- -
NNG_EINVAL
-
+
+NNG_EINVAL +

Value of specified niov is too large.

- - +

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_cancel(3), nng_aio_count(3), diff --git a/man/tip/nng_aio_set_msg.3.html b/man/tip/nng_aio_set_msg.3.html index 78919b47..1fef1eaa 100644 --- a/man/tip/nng_aio_set_msg.3.html +++ b/man/tip/nng_aio_set_msg.3.html @@ -572,7 +572,7 @@ The nng_aio must not have an operation

SEE ALSO

-
+

nng_aio_get_msg(3), nng_send_aio(3), nng_aio(5), diff --git a/man/tip/nng_aio_set_output.3.html b/man/tip/nng_aio_set_output.3.html index 9f16eaff..4e478a47 100644 --- a/man/tip/nng_aio_set_output.3.html +++ b/man/tip/nng_aio_set_output.3.html @@ -587,7 +587,7 @@ the nng_aio_get_output() fu

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_finish(3), nng_aio_get_output(3), diff --git a/man/tip/nng_aio_set_timeout.3.html b/man/tip/nng_aio_set_timeout.3.html index 75cc5559..726443f9 100644 --- a/man/tip/nng_aio_set_timeout.3.html +++ b/man/tip/nng_aio_set_timeout.3.html @@ -590,7 +590,7 @@ timeout.

SEE ALSO

-
+

nng_aio_alloc(3), nng_aio_cancel(3), nng_aio_result(3), diff --git a/man/tip/nng_aio_stop.3.html b/man/tip/nng_aio_stop.3.html index 4dc2ba7b..00d48b5a 100644 --- a/man/tip/nng_aio_stop.3.html +++ b/man/tip/nng_aio_stop.3.html @@ -600,7 +600,7 @@ might attempt to reschedule additional operations.

SEE ALSO

-
+

nng_aio_cancel(3), nng_aio_free(3), nng_aio_wait(3), diff --git a/man/tip/nng_aio_wait.3.html b/man/tip/nng_aio_wait.3.html index 75d7018f..ca538be9 100644 --- a/man/tip/nng_aio_wait.3.html +++ b/man/tip/nng_aio_wait.3.html @@ -566,7 +566,7 @@ function will not be called until the callback has completed.

SEE ALSO

-
+

nng_aio_abort(3), nng_aio_alloc(3), nng_aio(5), diff --git a/man/tip/nng_alloc.3.html b/man/tip/nng_alloc.3.html index c89c95c6..9e558d03 100644 --- a/man/tip/nng_alloc.3.html +++ b/man/tip/nng_alloc.3.html @@ -583,7 +583,7 @@ treated the same as NNG_ENOMEM.

SEE ALSO

-
+

nng_free(3), nng_send(3), nng_strerror(3), diff --git a/man/tip/nng_bus.7.html b/man/tip/nng_bus.7.html index 464e74ae..ac76c96c 100644 --- a/man/tip/nng_bus.7.html +++ b/man/tip/nng_bus.7.html @@ -617,7 +617,7 @@ identified in the header. This behavior is intended for use with device configurations consisting of just a single socket. Such configurations are useful in the creation of rebroadcasters, and this -capaibility prevents a message from being routed back to its source. +capability prevents a message from being routed back to its source. If no header is present, then a message is sent to all connected pipes.

@@ -629,7 +629,7 @@ If no header is present, then a message is sent to all connected pipes.

SEE ALSO

-
+

nng_bus_open(3), nng(7)

diff --git a/man/tip/nng_bus_open.3.html b/man/tip/nng_bus_open.3.html index e8aee826..d9e098f9 100644 --- a/man/tip/nng_bus_open.3.html +++ b/man/tip/nng_bus_open.3.html @@ -560,24 +560,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

ERRORS

-
-
-
NNG_ENOMEM
-
+
+ + + + + + + + + +
+NNG_ENOMEM +

Insufficient memory is available.

- -
NNG_ENOTSUP
-
+
+NNG_ENOTSUP +

The protocol is not supported.

- - +

SEE ALSO

-
+

nng_socket(5), nng_bus(7), nng(7)

diff --git a/man/tip/nng_clock.3supp.html b/man/tip/nng_clock.3supp.html index 1cd2fde3..6f388e90 100644 --- a/man/tip/nng_clock.3supp.html +++ b/man/tip/nng_clock.3supp.html @@ -593,7 +593,7 @@ timeouts using nng_cv_until(3supp).

SEE ALSO

-
+

nng_sleep_aio(3), nng_strerror(3), nng_cv_until(3supp), diff --git a/man/tip/nng_close.3.html b/man/tip/nng_close.3.html index 0c938503..90d166f1 100644 --- a/man/tip/nng_close.3.html +++ b/man/tip/nng_close.3.html @@ -560,20 +560,24 @@ call is executed may also return with an NNG_ECLOSED result.

ERRORS

-
-
-
NNG_ECLOSED
-
+
+ + + + + +
+NNG_ECLOSED +

The socket s is already closed or was never opened.

- - +

SEE ALSO

-
+

nng_strerror(3), nng_options(5), nng_socket(5), diff --git a/man/tip/nng_compat.3compat.html b/man/tip/nng_compat.3compat.html index c9f8d258..233a122e 100644 --- a/man/tip/nng_compat.3compat.html +++ b/man/tip/nng_compat.3compat.html @@ -510,7 +510,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

  • SYNOPSIS
  • DESCRIPTION
  • SEE ALSO
    • @@ -527,7 +529,19 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -
    #include <nn/nn.h>
    +
    #include <nanomsg/nn.h>
+
+#include <nanomsg/bus.h>
+#include <nanomsg/pair.h>
+#include <nanomsg/pipeline.h>
+#include <nanomsg/pubsub.h>
+#include <nanomsg/reqrep.h>
+#include <nanomsg/survey.h>
+
+#include <nanomsg/inproc.h>
+#include <nanomsg/ipc.h>
+#include <nanomsg/tcp.h>
+#include <nanomsg/ws.h>
    @@ -536,7 +550,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng library provides source-level compatibility for +

    +The nng library provides source-level compatibility for most nanomsg 1.0 applications.

    @@ -546,7 +561,7 @@ most nanomsg 1.0 applications.

    		 -This is intended to faciliate converting legacy applications to +This is intended to facilitate converting legacy applications to use the nng library. New applications should use the newer nng API instead.
    -

    Applications making use of this compatibility layer must take care +

    Applications making use of this must take care to link with libnng instead of libnn.

    +
    + + + + + +
    + + +While not recommended for long term use, the value returned by +nng_socket_id() can be used with these functions +just like a value returned by nn_socket(). +This can be way to facilitate incremental transition to the new API. +
    +
    @@ -582,24 +612,46 @@ While reasonable efforts have been made to provide for compatibility, some things may behave differently, and some less common parts of the nanomsg 1.0 API are not supported at this time, including certain options and the statistics API. +See the Caveats section below.
    -
    - - - - - -
    - - -If an installation of the older nanomsg library is present on -the build system, it may be necessary to provide a different search -path for header files to ensure that the compatibility definitions are -used in compilation. -
    +
    +

    Compiling

    +
    +

    When compiling legacy nanomsg applications, it will generally be +necessary to change the include search path to add the “compat” subdirectory +of the directory where headers were installed. +For example, if nng is installed in $prefix, then header files will +normally be located in $prefix/include/nng. +In this case, to build legacy nanomsg apps against nng you would +add $prefix/include/nng/compat to your compiler’s search path.

    +
    +
    +

    Alternatively, you can change your source code so that #include statements +referring to <nanomsg> instead refer to <nng/compat/nanomsg>. +For example, instead of:

    +
    +
    +
    +
    #include <nanomsg/nn.h>
+#include <nanomsg/reqrep.h>
    +
    +
    +
    +

    you would have this:

    +
    +
    +
    +
    #include <nng/compat/nanomsg/nn.h>
+#include <nng/compat/nanomsg/reqrep.h>
    +
    +
    +
    +

    Legacy applications built using these methods should be linked against libnng +instead of libnn, just like any other nng application.

    +

    Functions

    @@ -778,152 +830,81 @@ used in compilation.
    +
    +
    +

    Caveats

    -

    There are a few caveats, that should be kept in mind.

    +

    The following caveats apply when using the legacy API with nng.

    -
    - - - - - -
    - - -Socket numbers can be quite large. +
    +
      +
    • +

      Socket numbers can be quite large. The legacy libnanomsg attempted to reuse socket numbers, like file descriptors in UNIX systems. The nng library avoids this to prevent accidental reuse or collision after a descriptor is closed. Consequently, socket numbers can become quite large, and should -probably not be used for array indices. -

    -
    -
    - - - - - -
    - - -The following options (nn_getsockopt) are unsupported: +probably not be used for array indices.

    + +
  • +

    The following options (nn_getsockopt) are unsupported: NN_SNDPRIO, NN_RCVPRIO, NN_IPV4ONLY. The priority options may be supported in the future, when -the underlying capability is present in nng. -

    • -
    -
    - - - - - -
    - - -Access to statistics using this legacy API -(nn_get_statistic()) is unsupported. -
    -
    -
    - - - - - -
    - - -Some transports can support longer URLs than legacy libnanomsg can. +the underlying capability is present in nng.

    + +
  • +

    Access to statistics using this legacy API +(nn_get_statistic()) is unsupported.

    +
    • +
  • +

    Some transports can support longer URLs than legacy libnanomsg can. It is a good idea to use short pathnames in URLs if interoperability -is a concern. -

    • -
    -
    - - - - - -
    - - -Only absolute paths are supported in ipc:// URLs. -For example, ipc:///tmp/mysocket is acceptable, but ipc://mysocket is not. -
    -
    -
    - - - - - -
    - - -Some transports are unusable from this mode. +is a concern.

    + +
  • +

    Only absolute paths are supported in ipc:// URLs. +For example, ipc:///tmp/mysocket is acceptable, but ipc://mysocket is not.

    +
    • +
  • +

    The WebSocket transport in this implementation (ws:// URLs) +only supports BINARY frames.

    +
    • +
  • +

    Some newer transports are unusable from this mode. In particular, this legacy API offers no way to configure -TLS parameters that are required for use. -

    • -
    -
    - - - - - -
    - - -ABI versioning is not supported. -We don’t offer the NN_VERSION_ macros. Sorry. -
    -
    -
    - - - - - -
    - - -Runtime symbol information is not implemented. +TLS or ZeroTier parameters that may be required for use.

    + +
  • +

    ABI versioning of the compatibility layer is not supported, +and the NN_VERSION_ macros are not present.

    +
    • +
  • +

    Runtime symbol information is not implemented. Specifically, there is no nn_symbol() function yet. -(This may be addressed later if there is a need.) -

    • -
    -
    - - - - - -
    - - -The nn_term() function is destructive and should be avoided. -This function closes down all sockets, and really there is no good -reason to ever use it. -Removal from existing code is advised. -(Keep track of sockets and close them explicitly if necessary.) -
    -
    -
    - - - - - -
    - - -It is possible at present to intermix sockets between the new and -the old APIs, but this is not a guaranteed feature, and should only -be used temporarily to facilitate transitioning code to the new APIs. -
    +(This may be addressed later if there is a need.)

    + +
  • +

    The TCP transport (tcp:// URLs) does not support specifying the local +address or interface when binding. (This could be fixed in the future, +but most likely this will be available only using the new API.)

    +
    • +
  • +

    The values of NN_RCVMAXSIZE are constrained. +Specifically, values set larger than 2GB using the new API will be reported +as unlimited (-1) in the new API, and the value 0 will disable any +enforcement, just like -1. +(There is no practical reason to ever want to limit the receive size to +zero.)

    +
    • +
  • +

    This implementation counts buffers in terms of messages rather than bytes. +As a result, the buffer sizes accessed with NN_SNDBUF and NN_RCVBUF are +rounded up to a whole number of kilobytes, then divided by 1024, in order +to approximate buffering assuming 1 KB messages. +Few applications should need to adjust the default values.

    +
    • +
    @@ -931,7 +912,7 @@ be used temporarily to facilitate transitioning code to the new APIs.

    SEE ALSO

    -
    +

    libnng(3), nng(7)

    diff --git a/man/tip/nng_ctx.5.html b/man/tip/nng_ctx.5.html index 925d083f..8b5e6f0f 100644 --- a/man/tip/nng_ctx.5.html +++ b/man/tip/nng_ctx.5.html @@ -632,11 +632,11 @@ applications, and should be used in lieu of
    -
    +
    @@ -648,7 +648,7 @@ other (due to backpressure or other issues), then the message is discarded.
    - + Use of file descriptor polling (with descriptors @@ -736,7 +736,7 @@ or nng_listen().

    SEE ALSO

    -
    +

    libnng(3), nng_ctx_close(3), nng_ctx_open(3), diff --git a/man/tip/nng_ctx_close.3.html b/man/tip/nng_ctx_close.3.html index 49c95a85..a275ef1c 100644 --- a/man/tip/nng_ctx_close.3.html +++ b/man/tip/nng_ctx_close.3.html @@ -573,20 +573,24 @@ Closing the socket associated with ctx

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + +
    +NNG_ECLOSED +

    The context ctx is already closed or was never opened.

    - - +

    SEE ALSO

    -
    +

    nng_ctx_open(3), nng_strerror(3), nng_ctx(5), diff --git a/man/tip/nng_ctx_getopt.3.html b/man/tip/nng_ctx_getopt.3.html index fd01442a..7288e6c3 100644 --- a/man/tip/nng_ctx_getopt.3.html +++ b/man/tip/nng_ctx_getopt.3.html @@ -604,10 +604,10 @@ and the size of the buffer shall be stored at the location referenced by

    When the function returns, the actual size of the data copied (or that would have been copied if sufficient space were present) is stored at -the location referened by valszp. +the location referenced by valszp. If the caller’s buffer is not large enough to hold the entire object, then the copy is truncated. -Therefore the caller should check for truncation by verifyng that the +Therefore the caller should check for truncation by verifying that the returned size in valszp does not exceed the original buffer size.

    @@ -619,7 +619,7 @@ the object.

    nng_ctx_getopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The value will be stored at ivalp.

    @@ -678,40 +678,64 @@ numbers, and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter s does not refer to an open socket.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    Size of destination val too small for object.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EWRITEONLY
    -
    +
    +NNG_EWRITEONLY +

    The option opt is write-only.

    - - +

    SEE ALSO

    -
    +

    nng_ctx_setopt(3), nng_strdup(3), nng_strerror(3), diff --git a/man/tip/nng_ctx_id.3.html b/man/tip/nng_ctx_id.3.html index e391ce11..117237e7 100644 --- a/man/tip/nng_ctx_id.3.html +++ b/man/tip/nng_ctx_id.3.html @@ -579,7 +579,7 @@ they cannot be confused with a valid context before they are opened.

    SEE ALSO

    -
    +

    nng_ctx(5), nng(7)

    diff --git a/man/tip/nng_ctx_open.3.html b/man/tip/nng_ctx_open.3.html index 20b582cd..fca18f25 100644 --- a/man/tip/nng_ctx_open.3.html +++ b/man/tip/nng_ctx_open.3.html @@ -592,24 +592,32 @@ nonsensical, and not supported.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol does not support separate contexts, or the socket was opened in raw mode.

    - - +

    SEE ALSO

    -
    +

    nng_ctx_close(3), nng_ctx_getopt(3), nng_ctx_recv(3), diff --git a/man/tip/nng_ctx_recv.3.html b/man/tip/nng_ctx_recv.3.html index eb02ae8d..fcee6107 100644 --- a/man/tip/nng_ctx_recv.3.html +++ b/man/tip/nng_ctx_recv.3.html @@ -594,40 +594,64 @@ protocol, so examination of the protocol documentation is encouraged.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was aborted.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The context ctx is not open.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for context ctx does not support receiving.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The context ctx cannot receive data in this state.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    The receive timeout expired.

    - - +

    SEE ALSO

    -
    +

    nng_aio_get_msg(3), nng_aio_set_msg(3), nng_msg_alloc(3), diff --git a/man/tip/nng_ctx_send.3.html b/man/tip/nng_ctx_send.3.html index 72bd2761..83452e5c 100644 --- a/man/tip/nng_ctx_send.3.html +++ b/man/tip/nng_ctx_send.3.html @@ -571,7 +571,7 @@ socket, or in flight over physical media.

    If the operation fails for any reason (including cancellation or timeout), then the aio callback will be executed and nng_aio_result() will return a non-zero error status. -In this case, the callback has a responsibity to retrieve the message from +In this case, the callback has a responsibility to retrieve the message from the aio with nng_aio_get_msg() and dispose of it appropriately. (This may include retrying the send operation on the same or a different @@ -618,44 +618,72 @@ If a synchronous operation is needed, one can be constructed by using a

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was aborted.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The context ctx is not open.

    - -
    NNG_EMSGSIZE
    -
    +
    +NNG_EMSGSIZE +

    The message is too large.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for context ctx does not support sending.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The context ctx cannot send data in this state.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    The send timeout expired.

    - - +

    SEE ALSO

    -
    +

    nng_aio_get_msg(3), nng_aio_set_msg(3), nng_msg_alloc(3), diff --git a/man/tip/nng_ctx_setopt.3.html b/man/tip/nng_ctx_setopt.3.html index a23aded5..7d9b06bc 100644 --- a/man/tip/nng_ctx_setopt.3.html +++ b/man/tip/nng_ctx_setopt.3.html @@ -601,7 +601,7 @@ size of the objected located at val.

    nng_ctx_setopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The bval is passed to the option.

    @@ -659,36 +659,56 @@ and similar.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECLOSED +

    Parameter s does not refer to an open socket.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The value being passed is invalid.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EREADONLY
    -
    +
    +NNG_EREADONLY +

    The option opt is read-only.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket is in an inappropriate state for setting this option.

    - - +

    SEE ALSO

    -
    +

    nng_ctx_getopt(3), nng_setopt(3), nng_strerror(3), diff --git a/man/tip/nng_cv_alloc.3supp.html b/man/tip/nng_cv_alloc.3supp.html index dee2f4de..0e8e8a15 100644 --- a/man/tip/nng_cv_alloc.3supp.html +++ b/man/tip/nng_cv_alloc.3supp.html @@ -564,20 +564,24 @@ The mutex must also be owned when signaling the condition using the

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_cv_free(3supp), nng_cv_until(3supp), nng_cv_wait(3supp), diff --git a/man/tip/nng_cv_free.3supp.html b/man/tip/nng_cv_free.3supp.html index a67b52e1..ea484ad1 100644 --- a/man/tip/nng_cv_free.3supp.html +++ b/man/tip/nng_cv_free.3supp.html @@ -560,7 +560,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng(7)

    diff --git a/man/tip/nng_cv_until.3supp.html b/man/tip/nng_cv_until.3supp.html index c5873492..9331a092 100644 --- a/man/tip/nng_cv_until.3supp.html +++ b/man/tip/nng_cv_until.3supp.html @@ -618,7 +618,7 @@ tests for true.

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_cv_wait(3supp), nng_cv_wake(3supp), diff --git a/man/tip/nng_cv_wait.3supp.html b/man/tip/nng_cv_wait.3supp.html index 044f4420..23b0332a 100644 --- a/man/tip/nng_cv_wait.3supp.html +++ b/man/tip/nng_cv_wait.3supp.html @@ -614,7 +614,7 @@ tests for true.

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_cv_until(3supp), nng_cv_wake(3supp), diff --git a/man/tip/nng_cv_wake.3supp.html b/man/tip/nng_cv_wake.3supp.html index 72387fd8..7b7be37b 100644 --- a/man/tip/nng_cv_wake.3supp.html +++ b/man/tip/nng_cv_wake.3supp.html @@ -594,7 +594,7 @@ See nng_cv_wake1() for a solu

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_cv_until(3supp), nng_cv_wait(3supp), diff --git a/man/tip/nng_cv_wake1.3supp.html b/man/tip/nng_cv_wake1.3supp.html index c0b271de..9d55d5db 100644 --- a/man/tip/nng_cv_wake1.3supp.html +++ b/man/tip/nng_cv_wake1.3supp.html @@ -595,7 +595,7 @@ When in doubt, it is safer to use nng_cv_

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_cv_until(3supp), nng_cv_wait(3supp), diff --git a/man/tip/nng_device.3.html b/man/tip/nng_device.3.html index 6d7a71bb..93997e8f 100644 --- a/man/tip/nng_device.3.html +++ b/man/tip/nng_device.3.html @@ -563,9 +563,9 @@ is closed.

    Reflectors

    -

    One of the sockets may be passed an inititalize -1 (cast to an, -nng_socket of course). -If this is the case, then the other socket must be valid, and must be +

    One of the sockets passed may be an unopened socket initialized with +the NNG_SOCKET_INITIALIZER special value. +If this is the case, then the other socket must be valid, and must use a protocol that is bidirectional and can peer with itself (such as pair or bus.) @@ -600,7 +600,7 @@ header of the output bound message. The underlying raw mode protocols supply the necessary header adjustments to add or remove routing headers as needed. This allows replies to be -returned to requestors, and responses to be routed back to surveyors.

    +returned to requesters, and responses to be routed back to surveyors.

    Additionally, some protocols have a maximum time-to-live to protect @@ -620,7 +620,7 @@ option.

    		 Not all protocols have support for guarding against forwarding loops, -and even for those that do, forwarding loops can be extremely determintal +and even for those that do, forwarding loops can be extremely detrimental to network performance.
    Use the request/reply pattern, which includes automatic retries by -the requestor, if reliable delivery is needed. +the requester, if reliable delivery is needed.
    @@ -668,28 +668,40 @@ one occurs, or if one of the sockets is closed.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + + + + + + + + + +
    +NNG_ECLOSED +

    At least one of the sockets is not open.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The sockets are not compatible, or are both invalid.

    - - +

    SEE ALSO

    -
    +

    nng_options(5), nng_socket(5), nng(7)

    diff --git a/man/tip/nng_dial.3.html b/man/tip/nng_dial.3.html index abff9cb1..b0a09546 100644 --- a/man/tip/nng_dial.3.html +++ b/man/tip/nng_dial.3.html @@ -615,52 +615,88 @@ using nng_dialer_create() an

    ERRORS

    -
    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EADDRINVAL +

    An invalid url was specified.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_ECONNREFUSED
    -
    +
    +NNG_ECONNREFUSED +

    The remote peer refused the connection.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The remote peer reset the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EPEERAUTH
    -
    +
    +NNG_EPEERAUTH +

    Authentication or authorization failure.

    - -
    NNG_EPROTO
    -
    +
    +NNG_EPROTO +

    A protocol error occurred.

    - -
    NNG_EUNREACHABLE
    -
    +
    +NNG_EUNREACHABLE +

    The remote address is not reachable.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_close(3), nng_dialer_create(3) nng_dialer_start(3), diff --git a/man/tip/nng_dialer.5.html b/man/tip/nng_dialer.5.html index fda23272..c5c2a794 100644 --- a/man/tip/nng_dialer.5.html +++ b/man/tip/nng_dialer.5.html @@ -617,7 +617,7 @@ before it is opened, to prevent confusion with valid open dialers.

    SEE ALSO

    -
    +

    nng_dial(3), nng_dialer_close(3), nng_dialer_create(3), diff --git a/man/tip/nng_dialer_close.3.html b/man/tip/nng_dialer_close.3.html index c254cde0..44cbad27 100644 --- a/man/tip/nng_dialer_close.3.html +++ b/man/tip/nng_dialer_close.3.html @@ -537,7 +537,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_dialer_close() function closes the listener d. -This also closes any nng_pipe ojects that have +This also closes any nng_pipe objects that have been created by the dialer.

    @@ -563,20 +563,24 @@ this function has returned.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + +
    +NNG_ECLOSED +

    Parameter d does not refer to an open listener.

    - - +

    SEE ALSO

    -
    +

    nng_close(3), nng_dial(3), nng_dialer_create(3) diff --git a/man/tip/nng_dialer_create.3.html b/man/tip/nng_dialer_create.3.html index 4301b09d..fcf8e01b 100644 --- a/man/tip/nng_dialer_create.3.html +++ b/man/tip/nng_dialer_create.3.html @@ -603,28 +603,40 @@ simpler nng_dial() function instead.

    ERRORS

    -
    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EADDRINVAL +

    An invalid url was specified.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - - +

    SEE ALSO

    -
    +

    nng_dial(3), nng_dialer_close(3), nng_dialer_getopt(3), diff --git a/man/tip/nng_dialer_getopt.3.html b/man/tip/nng_dialer_getopt.3.html index 8336b932..8e118858 100644 --- a/man/tip/nng_dialer_getopt.3.html +++ b/man/tip/nng_dialer_getopt.3.html @@ -600,7 +600,7 @@ by valszp.

    When the function returns, the actual size of the data copied (or that would have been copied if sufficient space were present) is stored at -the location referened by valszp. +the location referenced by valszp. If the caller’s buffer is not large enough to hold the entire object, then the copy is truncated. Therefore the caller should validate that the returned size in valszp does not @@ -615,7 +615,7 @@ the object.

    nng_dialer_getopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The value will be stored at bvalp.

    @@ -690,40 +690,64 @@ numbers, and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter d does not refer to an open dialer.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    Size of destination val too small for object.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EWRITEONLY
    -
    +
    +NNG_EWRITEONLY +

    The option opt is write-only.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_create(3) nng_dialer_setopt(3) nng_strdup(3), diff --git a/man/tip/nng_dialer_id.3.html b/man/tip/nng_dialer_id.3.html index d1e76d5c..1b6141e5 100644 --- a/man/tip/nng_dialer_id.3.html +++ b/man/tip/nng_dialer_id.3.html @@ -580,7 +580,7 @@ they cannot be confused with a valid dialer before they are created properly.

    SEE ALSO

    -
    +

    nng_dialer(5), nng(7)

    diff --git a/man/tip/nng_dialer_setopt.3.html b/man/tip/nng_dialer_setopt.3.html index 4e0c9747..bb09f650 100644 --- a/man/tip/nng_dialer_setopt.3.html +++ b/man/tip/nng_dialer_setopt.3.html @@ -610,7 +610,7 @@ size of the objected located at val.

    nng_dialer_setopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The bval is passed to the option.

    @@ -680,40 +680,64 @@ and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter d does not refer to an open dialer.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The value being passed is invalid.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EREADONLY
    -
    +
    +NNG_EREADONLY +

    The option opt is read-only.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The dialer d is already started.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_create(3) nng_dialer_getopt(3) nng_strerror(3), diff --git a/man/tip/nng_dialer_start.3.html b/man/tip/nng_dialer_start.3.html index 7317a9a3..18bc9fc9 100644 --- a/man/tip/nng_dialer_start.3.html +++ b/man/tip/nng_dialer_start.3.html @@ -590,56 +590,96 @@ its configuration.

    ERRORS

    -
    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EADDRINVAL +

    An invalid url was specified.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_ECONNREFUSED
    -
    +
    +NNG_ECONNREFUSED +

    The remote peer refused the connection.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The remote peer reset the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EPEERAUTH
    -
    +
    +NNG_EPEERAUTH +

    Authentication or authorization failure.

    - -
    NNG_EPROTO
    -
    +
    +NNG_EPROTO +

    A protocol error occurred.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The dialer d is already started.

    - -
    NNG_EUNREACHABLE
    -
    +
    +NNG_EUNREACHABLE +

    The remote address is not reachable.

    - - +

    SEE ALSO

    -
    +

    nng_dial(3), nng_dialer_create(3) nng_strerror(3), diff --git a/man/tip/nng_duration.5.html b/man/tip/nng_duration.5.html index 742ed008..c456f9bf 100644 --- a/man/tip/nng_duration.5.html +++ b/man/tip/nng_duration.5.html @@ -540,7 +540,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_duration is a relative time, measured in milliseconds. -This type is most often used in conjuction with timers and timeouts.

    +This type is most often used in conjunction with timers and timeouts.

    A couple of special values have been set aside, and carry special meanings.

    @@ -566,7 +566,7 @@ This type is most often used in conjuction with timers and timeouts.

    SEE ALSO

    -
    +

    nng_options(5), nng(7)

    diff --git a/man/tip/nng_free.3.html b/man/tip/nng_free.3.html index 84771d0f..5b4abbcb 100644 --- a/man/tip/nng_free.3.html +++ b/man/tip/nng_free.3.html @@ -590,7 +590,7 @@ behavior, including corruption of application memory.

    SEE ALSO

    -
    +

    nng_alloc(3), nng_recv(3), nng(7)

    diff --git a/man/tip/nng_getopt.3.html b/man/tip/nng_getopt.3.html index 51177aeb..6e468435 100644 --- a/man/tip/nng_getopt.3.html +++ b/man/tip/nng_getopt.3.html @@ -597,10 +597,10 @@ and the size of the buffer shall be stored at the location referenced by

    When the function returns, the actual size of the data copied (or that would have been copied if sufficient space were present) is stored at -the location referened by valszp. +the location referenced by valszp. If the caller’s buffer is not large enough to hold the entire object, then the copy is truncated. -Therefore the caller should check for truncation by verifyng that the +Therefore the caller should check for truncation by verifying that the returned size in valszp does not exceed the original buffer size.

    @@ -612,7 +612,7 @@ the object.

    nng_getopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The value will be stored at ivalp.

    @@ -680,40 +680,64 @@ numbers, and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter s does not refer to an open socket.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    Size of destination val too small for object.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EWRITEONLY
    -
    +
    +NNG_EWRITEONLY +

    The option opt is write-only.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_getopt(3), nng_listener_getopt(3), nng_pipe_getopt(3), diff --git a/man/tip/nng_http_client_alloc.3http.html b/man/tip/nng_http_client_alloc.3http.html index f4760579..a5370140 100644 --- a/man/tip/nng_http_client_alloc.3http.html +++ b/man/tip/nng_http_client_alloc.3http.html @@ -538,7 +538,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_client_alloc() allocates an HTTP client suitable for -connecting to the server identifyed by url and stores a pointer to +connecting to the server identified by url and stores a pointer to it in the location referenced by clientp.

    @@ -554,24 +554,32 @@ it in the location referenced by clientp.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_client_connect(3http), nng_http_client_free(3http), nng_strerror(3), diff --git a/man/tip/nng_http_client_connect.3http.html b/man/tip/nng_http_client_connect.3http.html index 540d1250..0bd14e70 100644 --- a/man/tip/nng_http_client_connect.3http.html +++ b/man/tip/nng_http_client_connect.3http.html @@ -566,29 +566,49 @@ obtained by

    ERRORS

    -
    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EADDRINVAL +

    The server is configured with an invalid address.

    - -
    NNG_ECANCELED
    -
    +
    +NNG_ECANCELED +

    The operation was aborted.

    - -
    NNG_ECONNREFUSED
    -
    +
    +NNG_ECONNREFUSED +

    The TCP connection was refused by the server.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The TCP connection was reset by the server.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +
    @@ -631,7 +651,7 @@ obtained by

    SEE ALSO

    -
    +

    nng_aio_get_output(3), nng_aio_result(3), nng_aio_wait(3), diff --git a/man/tip/nng_http_client_free.3http.html b/man/tip/nng_http_client_free.3http.html index 8304c740..825db8c1 100644 --- a/man/tip/nng_http_client_free.3http.html +++ b/man/tip/nng_http_client_free.3http.html @@ -575,7 +575,7 @@ and so the caller must close those explicitly if desired.

    SEE ALSO

    -
    +

    nng_http_client_alloc(3), nng_http_client_connect(3), nng(7)

    diff --git a/man/tip/nng_http_client_get_tls.3http.html b/man/tip/nng_http_client_get_tls.3http.html index 6bc45521..61f64e0d 100644 --- a/man/tip/nng_http_client_get_tls.3http.html +++ b/man/tip/nng_http_client_get_tls.3http.html @@ -557,24 +557,32 @@ to use HTTPS.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    Either HTTP or TLS not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_client_alloc(3http), nng_http_client_connect(3http), nng_http_client_set_tls(3http), diff --git a/man/tip/nng_http_client_set_tls.3http.html b/man/tip/nng_http_client_set_tls.3http.html index 862358bb..dc751a70 100644 --- a/man/tip/nng_http_client_set_tls.3http.html +++ b/man/tip/nng_http_client_set_tls.3http.html @@ -582,24 +582,32 @@ will continue to use any TLS configuration that they were started with.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    Either HTTP or TLS not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_client_alloc(3http), nng_http_client_connect(3http), nng_http_client_get_tls(3http), diff --git a/man/tip/nng_http_conn_close.3http.html b/man/tip/nng_http_conn_close.3http.html index d5e7a196..d169b202 100644 --- a/man/tip/nng_http_conn_close.3http.html +++ b/man/tip/nng_http_conn_close.3http.html @@ -564,7 +564,7 @@ including any disposing of any underlying file descriptors or related resources.

    SEE ALSO

    -
    +

    nng_http_client_connect(3http), nng_http_handler_alloc(3http), nng_strerror(3), diff --git a/man/tip/nng_http_conn_read.3http.html b/man/tip/nng_http_conn_read.3http.html index 1d6bd9fa..c9094498 100644 --- a/man/tip/nng_http_conn_read.3http.html +++ b/man/tip/nng_http_conn_read.3http.html @@ -595,44 +595,72 @@ Most applications will never need to use this function.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The aio does not contain a valid scatter/gather vector.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_count(3), nng_aio_result(3), diff --git a/man/tip/nng_http_conn_read_all.3http.html b/man/tip/nng_http_conn_read_all.3http.html index 82d78c77..1226f80e 100644 --- a/man/tip/nng_http_conn_read_all.3http.html +++ b/man/tip/nng_http_conn_read_all.3http.html @@ -578,7 +578,7 @@ The actual number of bytes read can be determined with -The main purpose for this function is to faciliate reading HTTP +The main purpose for this function is to facilitate reading HTTP body content, after first determining the length of the body content from the relevant HTTP headers (typically Content-Length). @@ -598,44 +598,72 @@ from the relevant HTTP headers (typically Content-Length).

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The aio does not contain a valid scatter/gather vector.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_count(3), nng_aio_result(3), diff --git a/man/tip/nng_http_conn_read_req.3http.html b/man/tip/nng_http_conn_read_req.3http.html index 9a594778..8916905e 100644 --- a/man/tip/nng_http_conn_read_req.3http.html +++ b/man/tip/nng_http_conn_read_req.3http.html @@ -577,40 +577,64 @@ That result will either be zero or an error code.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_result(3), nng_strerror(3), diff --git a/man/tip/nng_http_conn_read_res.3http.html b/man/tip/nng_http_conn_read_res.3http.html index 4c41e237..9e133e22 100644 --- a/man/tip/nng_http_conn_read_res.3http.html +++ b/man/tip/nng_http_conn_read_res.3http.html @@ -578,40 +578,64 @@ That result will either be zero or an error code.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_result(3), nng_strerror(3), diff --git a/man/tip/nng_http_conn_write.3http.html b/man/tip/nng_http_conn_write.3http.html index ee4a1fc5..fac636d6 100644 --- a/man/tip/nng_http_conn_write.3http.html +++ b/man/tip/nng_http_conn_write.3http.html @@ -594,44 +594,72 @@ Most applications will never need to use this function.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The aio does not contain a valid scatter/gather vector.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_count(3), nng_aio_result(3), diff --git a/man/tip/nng_http_conn_write_all.3http.html b/man/tip/nng_http_conn_write_all.3http.html index 0a8e8ee0..a8b4bee8 100644 --- a/man/tip/nng_http_conn_write_all.3http.html +++ b/man/tip/nng_http_conn_write_all.3http.html @@ -578,7 +578,7 @@ The actual number of bytes written can be determined with -The main purpose for this function is to faciliate writing HTTP +The main purpose for this function is to facilitate writing HTTP body content. @@ -608,7 +608,7 @@ an Content-Length header, and possibly a Content-Type An easier solution to sending HTTP content data, is to include the -conten with the request or reply using a function like +content with the request or reply using a function like nng_http_req_copy_data(). In that case, the body data will be written automatically by the http_conn_write_req() or @@ -630,44 +630,72 @@ In that case, the body data will be written automatically by the

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The aio does not contain a valid scatter/gather vector.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_count(3), nng_aio_result(3), diff --git a/man/tip/nng_http_conn_write_req.3http.html b/man/tip/nng_http_conn_write_req.3http.html index 7b702bea..f781b1bb 100644 --- a/man/tip/nng_http_conn_write_req.3http.html +++ b/man/tip/nng_http_conn_write_req.3http.html @@ -550,7 +550,7 @@ including headers, and if present, the request body data.

    This function returns immediately, with no return value. Completion of the operation is signaled via the aio, and the final result may be obtained via nng_aio_result(). -That result willeither be zero or an error code.

    +That result will either be zero or an error code.

    @@ -565,40 +565,64 @@ That result willeither be zero or an error code.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_result(3), nng_http_client_connect(3http), diff --git a/man/tip/nng_http_conn_write_res.3http.html b/man/tip/nng_http_conn_write_res.3http.html index 0aafce63..dd8859fc 100644 --- a/man/tip/nng_http_conn_write_res.3http.html +++ b/man/tip/nng_http_conn_write_res.3http.html @@ -581,40 +581,64 @@ then the connection is immediately after sending the response.

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was canceled.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ECONNRESET
    -
    +
    +NNG_ECONNRESET +

    The peer closed the connection.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP operations are not supported.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    Timeout waiting for data from the connection.

    - - +

    SEE ALSO

    -
    +

    nng_aio_alloc(3), nng_aio_result(3), nng_http_client_connect(3http), diff --git a/man/tip/nng_http_handler_alloc.3http.html b/man/tip/nng_http_handler_alloc.3http.html index 97969e95..021d4ca6 100644 --- a/man/tip/nng_http_handler_alloc.3http.html +++ b/man/tip/nng_http_handler_alloc.3http.html @@ -634,7 +634,7 @@ The uri is taken as the root, and files are served from the directory tree rooted at path.

    -

    When the client Request-URI resolves to a directory in the filesystem, +

    When the client Request-URI resolves to a directory in the file system, the handler looks first for a file named index.html or index.htm. If one is found, then that file is returned back to the client. If no such index file exists, then an NNG_HTTP_STATUS_NOT_FOUND (404) error is @@ -642,7 +642,7 @@ sent back to the client.

    The Content-Type will be set automatically based upon the extension -of the requsted file name. +of the requested file name. If a content type cannot be determined from the extension, then application/octet-stream is used.

    @@ -656,7 +656,7 @@ or search for index.html or index.htm files.

    The Content-Type will be set automatically based upon the extension -of the requsted file name. +of the requested file name. If a content type cannot be determined from the extension, then application/octet-stream is used.

    @@ -684,28 +684,40 @@ sent the data, with Content-Length of size bytes,

    ERRORS

    -
    -
    -
    NNG_EINVAL
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EINVAL +

    An invalid path was specified.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_aio_finish(3), nng_aio_get_input(3), nng_aio_set_output(3), diff --git a/man/tip/nng_http_handler_free.3http.html b/man/tip/nng_http_handler_free.3http.html index fdcd364b..89c4052b 100644 --- a/man/tip/nng_http_handler_free.3http.html +++ b/man/tip/nng_http_handler_free.3http.html @@ -574,7 +574,7 @@ when the server itself is deallocated.

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_add_handler(3http), nng(7)

    diff --git a/man/tip/nng_http_handler_get_data.3http.html b/man/tip/nng_http_handler_get_data.3http.html index 29fae4ce..8ef8efa1 100644 --- a/man/tip/nng_http_handler_get_data.3http.html +++ b/man/tip/nng_http_handler_get_data.3http.html @@ -563,7 +563,7 @@ stored on handler using the function

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_set_data(3http), nng_http_server_add_handler(3http), diff --git a/man/tip/nng_http_handler_set_data.3http.html b/man/tip/nng_http_handler_set_data.3http.html index 882771fa..b587d005 100644 --- a/man/tip/nng_http_handler_set_data.3http.html +++ b/man/tip/nng_http_handler_set_data.3http.html @@ -562,24 +562,32 @@ this function is deallocate any resources associated with data.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_get_data(3http), nng_http_server_add_handler(3http), diff --git a/man/tip/nng_http_handler_set_host.3http.html b/man/tip/nng_http_handler_set_host.3http.html index fb939b03..853b2e7b 100644 --- a/man/tip/nng_http_handler_set_host.3http.html +++ b/man/tip/nng_http_handler_set_host.3http.html @@ -557,7 +557,7 @@ hosting.

    The value of the host can include a colon and port, and should match exactly the value of the Host header sent by the client. -(Canonicaliztion of the host name is performed though.)

    +(Canonicalization of the host name is performed though.)

    @@ -587,24 +587,32 @@ the hostname or IP address, and ignores any trailing port number.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    +
    + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_add_handler(3http), nng(7)

    diff --git a/man/tip/nng_http_handler_set_method.3http.html b/man/tip/nng_http_handler_set_method.3http.html index 890a5cb8..c4f794c3 100644 --- a/man/tip/nng_http_handler_set_method.3http.html +++ b/man/tip/nng_http_handler_set_method.3http.html @@ -588,24 +588,32 @@ insist that the actual method sent over the wire be capitalized.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_add_handler(3http), nng_http_req_get_method(3http), diff --git a/man/tip/nng_http_handler_set_tree.3http.html b/man/tip/nng_http_handler_set_tree.3http.html index 6e7a2394..a27501c3 100644 --- a/man/tip/nng_http_handler_set_tree.3http.html +++ b/man/tip/nng_http_handler_set_tree.3http.html @@ -567,24 +567,32 @@ service address (path) supports dynamically generated children.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_add_handler(3http), nng_http_req_get_method(3http), diff --git a/man/tip/nng_http_hijack.3http.html b/man/tip/nng_http_hijack.3http.html index f494b4ae..08dae0f6 100644 --- a/man/tip/nng_http_hijack.3http.html +++ b/man/tip/nng_http_hijack.3http.html @@ -593,28 +593,40 @@ Most applications will never need to use this function.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + + + + + + + + + +
    +NNG_ECLOSED +

    The connection was closed.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_http_conn_write_res(3http), nng_http_handler_alloc(3http), diff --git a/man/tip/nng_http_req_add_header.3http.html b/man/tip/nng_http_req_add_header.3http.html index 1b1b5700..f85d8bac 100644 --- a/man/tip/nng_http_req_add_header.3http.html +++ b/man/tip/nng_http_req_add_header.3http.html @@ -593,24 +593,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_del_header(3http), nng_http_req_get_header(3http), diff --git a/man/tip/nng_http_req_alloc.3http.html b/man/tip/nng_http_req_alloc.3http.html index aa231abb..dd402519 100644 --- a/man/tip/nng_http_req_alloc.3http.html +++ b/man/tip/nng_http_req_alloc.3http.html @@ -555,24 +555,32 @@ to perform an HTTP/1.1 GET operation using the URL specified in

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP support not configured.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_read_req(3http), nng_http_conn_write_req(3http), nng_http_req_add_header(3http), diff --git a/man/tip/nng_http_req_copy_data.3http.html b/man/tip/nng_http_req_copy_data.3http.html index a0b2b82c..41acf6c9 100644 --- a/man/tip/nng_http_req_copy_data.3http.html +++ b/man/tip/nng_http_req_copy_data.3http.html @@ -599,24 +599,32 @@ It is a good idea to also set the Content-Type header.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_write_req(3http), nng_http_req_alloc(3http), nng_http_req_set_data(3http), diff --git a/man/tip/nng_http_req_del_header.3http.html b/man/tip/nng_http_req_del_header.3http.html index 794d17a5..bfa8609c 100644 --- a/man/tip/nng_http_req_del_header.3http.html +++ b/man/tip/nng_http_req_del_header.3http.html @@ -559,24 +559,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOENT
    -
    +
    + + + + + + + + + +
    +NNG_ENOENT +

    No header with the key key was present.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_add_header(3http), nng_http_req_del_header(3http), diff --git a/man/tip/nng_http_req_free.3http.html b/man/tip/nng_http_req_free.3http.html index 4ca6dcf5..f37ac9e3 100644 --- a/man/tip/nng_http_req_free.3http.html +++ b/man/tip/nng_http_req_free.3http.html @@ -561,7 +561,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng(7)

    diff --git a/man/tip/nng_http_req_get_header.3http.html b/man/tip/nng_http_req_get_header.3http.html index 07374301..058e9fa2 100644 --- a/man/tip/nng_http_req_get_header.3http.html +++ b/man/tip/nng_http_req_get_header.3http.html @@ -568,7 +568,7 @@ equivalent, whereas the value Host: will not find anything.

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_add_header(3http), nng_http_req_set_header(3http), diff --git a/man/tip/nng_http_req_get_method.3http.html b/man/tip/nng_http_req_get_method.3http.html index d71a2b00..35637e50 100644 --- a/man/tip/nng_http_req_get_method.3http.html +++ b/man/tip/nng_http_req_get_method.3http.html @@ -562,7 +562,7 @@ The value will be a string, such as "GET" or "POST".

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_set_method(3http), nng(7)

    diff --git a/man/tip/nng_http_req_get_uri.3http.html b/man/tip/nng_http_req_get_uri.3http.html index ae4f683b..82e47865 100644 --- a/man/tip/nng_http_req_get_uri.3http.html +++ b/man/tip/nng_http_req_get_uri.3http.html @@ -540,8 +540,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_req_get_uri() returns the URI (path) associated with the HTTP the request req. The value returned includes the path, as well as any query information or -fragment. The value will look like a filesystem path -with those optional components appened, such as /api/get_info.cgi?name=garrett.

    +fragment. The value will look like a file system path +with those optional components appended, such as /api/get_info.cgi?name=garrett.

    @@ -564,7 +564,7 @@ with those optional components appened, such as /api/get_info.cgi?name=gar

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_set_uri(3http), nng(7)

    diff --git a/man/tip/nng_http_req_get_version.3http.html b/man/tip/nng_http_req_get_version.3http.html index a1b7993a..3bf77894 100644 --- a/man/tip/nng_http_req_get_version.3http.html +++ b/man/tip/nng_http_req_get_version.3http.html @@ -561,7 +561,7 @@ protocol version associated with the request req, such as "HTTP/1.1".

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_set_version(3http), nng(7)

    diff --git a/man/tip/nng_http_req_set_data.3http.html b/man/tip/nng_http_req_set_data.3http.html index 62cdd90a..dbd495b7 100644 --- a/man/tip/nng_http_req_set_data.3http.html +++ b/man/tip/nng_http_req_set_data.3http.html @@ -601,24 +601,32 @@ It is a good idea to also set the Content-Type header.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_write_req(3http), nng_http_req_alloc(3http), nng_http_req_copy_data(3http), diff --git a/man/tip/nng_http_req_set_header.3http.html b/man/tip/nng_http_req_set_header.3http.html index 7b22b0de..684e7719 100644 --- a/man/tip/nng_http_req_set_header.3http.html +++ b/man/tip/nng_http_req_set_header.3http.html @@ -575,24 +575,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_add_header(3http), nng_http_req_del_header(3http), diff --git a/man/tip/nng_http_req_set_method.3http.html b/man/tip/nng_http_req_set_method.3http.html index e4e9d343..0cf499ee 100644 --- a/man/tip/nng_http_req_set_method.3http.html +++ b/man/tip/nng_http_req_set_method.3http.html @@ -561,24 +561,32 @@ be upper case.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_get_method(3http), nng(7)

    diff --git a/man/tip/nng_http_req_set_uri.3http.html b/man/tip/nng_http_req_set_uri.3http.html index c76b132a..81a059da 100644 --- a/man/tip/nng_http_req_set_uri.3http.html +++ b/man/tip/nng_http_req_set_uri.3http.html @@ -586,24 +586,32 @@ contain a suitable value that can be used with this function.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_get_uri(3http), nng_url_parse(3), diff --git a/man/tip/nng_http_req_set_version.3http.html b/man/tip/nng_http_req_set_version.3http.html index 5ccb290c..6d07edf7 100644 --- a/man/tip/nng_http_req_set_version.3http.html +++ b/man/tip/nng_http_req_set_version.3http.html @@ -585,24 +585,32 @@ Specifying any other version may result in unspecified behavior.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng_http_req_get_version(3http), nng(7)

    diff --git a/man/tip/nng_http_res_add_header.3http.html b/man/tip/nng_http_res_add_header.3http.html index fff4a1db..e3058ffb 100644 --- a/man/tip/nng_http_res_add_header.3http.html +++ b/man/tip/nng_http_res_add_header.3http.html @@ -593,24 +593,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_del_header(3http), nng_http_res_get_header(3http), diff --git a/man/tip/nng_http_res_alloc.3http.html b/man/tip/nng_http_res_alloc.3http.html index 2cff9201..5a77269c 100644 --- a/man/tip/nng_http_res_alloc.3http.html +++ b/man/tip/nng_http_res_alloc.3http.html @@ -569,24 +569,32 @@ When an error response is needed, consider using

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP support not configured.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_read_res(3http), nng_http_conn_write_res(3http), nng_http_req_alloc(3http), diff --git a/man/tip/nng_http_res_alloc_error.3http.html b/man/tip/nng_http_res_alloc_error.3http.html index 9b215079..7667b4a1 100644 --- a/man/tip/nng_http_res_alloc_error.3http.html +++ b/man/tip/nng_http_res_alloc_error.3http.html @@ -572,24 +572,32 @@ This is the simplest way to generate an error response.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP support not configured.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_free(3http), nng_http_res_set_reason(3http), diff --git a/man/tip/nng_http_res_copy_data.3http.html b/man/tip/nng_http_res_copy_data.3http.html index 0c6bba5b..6cb1cb0a 100644 --- a/man/tip/nng_http_res_copy_data.3http.html +++ b/man/tip/nng_http_res_copy_data.3http.html @@ -599,24 +599,32 @@ It is a good idea to also set the Content-Type header.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_write_res(3http), nng_http_res_alloc(3http), nng_http_res_set_data(3http), diff --git a/man/tip/nng_http_res_del_header.3http.html b/man/tip/nng_http_res_del_header.3http.html index e035046b..32c0cab3 100644 --- a/man/tip/nng_http_res_del_header.3http.html +++ b/man/tip/nng_http_res_del_header.3http.html @@ -558,24 +558,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOENT
    -
    +
    + + + + + + + + + +
    +NNG_ENOENT +

    No header with the key key was present.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_add_header(3http), nng_http_res_del_header(3http), diff --git a/man/tip/nng_http_res_free.3http.html b/man/tip/nng_http_res_free.3http.html index 82651826..908fbf7e 100644 --- a/man/tip/nng_http_res_free.3http.html +++ b/man/tip/nng_http_res_free.3http.html @@ -561,7 +561,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_http_req_alloc(3http), nng(7)

    diff --git a/man/tip/nng_http_res_get_header.3http.html b/man/tip/nng_http_res_get_header.3http.html index 5e5223c5..f1db35f6 100644 --- a/man/tip/nng_http_res_get_header.3http.html +++ b/man/tip/nng_http_res_get_header.3http.html @@ -568,7 +568,7 @@ equivalent, whereas the value Host: will not find anything.

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_add_header(3http), nng_http_res_set_header(3http), diff --git a/man/tip/nng_http_res_get_reason.3http.html b/man/tip/nng_http_res_get_reason.3http.html index 9ad43597..8d22042b 100644 --- a/man/tip/nng_http_res_get_reason.3http.html +++ b/man/tip/nng_http_res_get_reason.3http.html @@ -564,7 +564,7 @@ would be obtained from

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_get_status(3http), nng_http_res_set_reason(3http), diff --git a/man/tip/nng_http_res_get_status.3http.html b/man/tip/nng_http_res_get_status.3http.html index 49893956..bf02c788 100644 --- a/man/tip/nng_http_res_get_status.3http.html +++ b/man/tip/nng_http_res_get_status.3http.html @@ -644,7 +644,7 @@ consider also including the “reason phrase” obtained with

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_get_reason(3http), nng_http_res_set_status(3http), diff --git a/man/tip/nng_http_res_get_version.3http.html b/man/tip/nng_http_res_get_version.3http.html index eb5bea34..370cb5aa 100644 --- a/man/tip/nng_http_res_get_version.3http.html +++ b/man/tip/nng_http_res_get_version.3http.html @@ -561,7 +561,7 @@ protocol version associated with the request res, such as "HTTP/1.1".

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_set_version(3http), nng(7)

    diff --git a/man/tip/nng_http_res_set_data.3http.html b/man/tip/nng_http_res_set_data.3http.html index bcb4e7dd..5199126e 100644 --- a/man/tip/nng_http_res_set_data.3http.html +++ b/man/tip/nng_http_res_set_data.3http.html @@ -601,24 +601,32 @@ It is a good idea to also set the Content-Type header.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_conn_write_res(3http), nng_http_res_alloc(3http), nng_http_res_copy_data(3http), diff --git a/man/tip/nng_http_res_set_header.3http.html b/man/tip/nng_http_res_set_header.3http.html index 9c0f2156..d30364b1 100644 --- a/man/tip/nng_http_res_set_header.3http.html +++ b/man/tip/nng_http_res_set_header.3http.html @@ -575,24 +575,32 @@ equivalent, whereas the value Host: is not a legal header key.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_res_add_header(3http), nng_http_res_del_header(3http), diff --git a/man/tip/nng_http_res_set_reason.3http.html b/man/tip/nng_http_res_set_reason.3http.html index b94ddea6..87413f33 100644 --- a/man/tip/nng_http_res_set_reason.3http.html +++ b/man/tip/nng_http_res_set_reason.3http.html @@ -537,7 +537,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_http_res_set_reason() sets the human readable "reason phrase" +

    The nng_http_res_set_reason() sets the human readable “reason phrase” associated with the response res to reason.

    @@ -553,7 +553,7 @@ phrase is supplied based upon the value of the status code (see The reason is never parsed automatically, but it can be a hint for humans - to help them understand the nature of any erroroneous result. + to help them understand the nature of any erroneous result. @@ -574,24 +574,32 @@ The reason is never parsed automatically, but it can be a hint for huma

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_req_get_reason(3http), nng_http_req_set_status(3http), diff --git a/man/tip/nng_http_res_set_status.3http.html b/man/tip/nng_http_res_set_status.3http.html index aba3145d..08f112f3 100644 --- a/man/tip/nng_http_res_set_status.3http.html +++ b/man/tip/nng_http_res_set_status.3http.html @@ -610,7 +610,7 @@ that only a valid code is supplied.

    NNG_HTTP_STATUS_LOOP_DETECTED = 508, NNG_HTTP_STATUS_NOT_EXTENDED = 510, NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511, -} +};
    @@ -644,20 +644,24 @@ This will help any humans who may have to diagnose a failure.

    ERRORS

    -
    -
    -
    NNG_ENOTSUP
    -
    +
    + + + + + +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_req_get_status(3http), nng_http_req_set_reason(3http), diff --git a/man/tip/nng_http_res_set_version.3http.html b/man/tip/nng_http_res_set_version.3http.html index 4b647ef0..9f9d5dc9 100644 --- a/man/tip/nng_http_res_set_version.3http.html +++ b/man/tip/nng_http_res_set_version.3http.html @@ -585,24 +585,32 @@ Specifying any other version may result in unspecified behavior.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory to perform the operation.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    No support for HTTP in the library.

    - - +

    SEE ALSO

    -
    +

    nng_http_res_alloc(3http), nng_http_req_get_version(3http), nng(7)

    diff --git a/man/tip/nng_http_server_add_handler.3http.html b/man/tip/nng_http_server_add_handler.3http.html index 00886c98..2faf1e65 100644 --- a/man/tip/nng_http_server_add_handler.3http.html +++ b/man/tip/nng_http_server_add_handler.3http.html @@ -565,28 +565,40 @@ deallocated, the handler and any of its resources will also be deallocated.

    ERRORS

    -
    -
    -
    NNG_EADDRINUSE
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EADDRINUSE +

    Handler conflicts with another handler.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_alloc(3http), nng_http_server_del_handler(3http), nng_http_server_hold(3http), diff --git a/man/tip/nng_http_server_del_handler.3http.html b/man/tip/nng_http_server_del_handler.3http.html index 8b60bbd7..e0bb7409 100644 --- a/man/tip/nng_http_server_del_handler.3http.html +++ b/man/tip/nng_http_server_del_handler.3http.html @@ -557,24 +557,32 @@ of the caller to dispose of the handler, or add it to another server instance.

    ERRORS

    -
    -
    -
    NNG_ENOENT
    -
    +
    + + + + + + + + + +
    +NNG_ENOENT +

    Handler is not registered with server.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_handler_free(3http), nng_http_server_add_handler(3http), nng_strerror(3), diff --git a/man/tip/nng_http_server_get_tls.3http.html b/man/tip/nng_http_server_get_tls.3http.html index e03108c1..f506f99f 100644 --- a/man/tip/nng_http_server_get_tls.3http.html +++ b/man/tip/nng_http_server_get_tls.3http.html @@ -557,24 +557,32 @@ to use HTTPS.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    Either HTTP or TLS not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_server_hold(3http), nng_http_server_set_tls(3http), nng_http_server_start(3http), diff --git a/man/tip/nng_http_server_hold.3http.html b/man/tip/nng_http_server_hold.3http.html index 6930499b..f7010cb5 100644 --- a/man/tip/nng_http_server_hold.3http.html +++ b/man/tip/nng_http_server_hold.3http.html @@ -582,24 +582,32 @@ It is recommended to use canonical IP addresses or names in the

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_server_add_handler(3http), nng_http_server_release(3http), nng_http_server_stop(3http), diff --git a/man/tip/nng_http_server_release.3http.html b/man/tip/nng_http_server_release.3http.html index 810f881e..fc9e9641 100644 --- a/man/tip/nng_http_server_release.3http.html +++ b/man/tip/nng_http_server_release.3http.html @@ -582,7 +582,7 @@ times than it has been held.

    SEE ALSO

    -
    +

    nng_http_server_hold(3http), nng_http_server_stop(3http), nng(7)

    diff --git a/man/tip/nng_http_server_set_tls.3http.html b/man/tip/nng_http_server_set_tls.3http.html index 6e5ff139..7e3c8864 100644 --- a/man/tip/nng_http_server_set_tls.3http.html +++ b/man/tip/nng_http_server_set_tls.3http.html @@ -587,28 +587,40 @@ Generally, the cfg must have a configured private key, set with

    ERRORS

    -
    -
    -
    NNG_EBUSY
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EBUSY +

    Server instance is running.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    Either HTTP or TLS not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_server_get_tls(3http), nng_http_server_hold(3http), nng_http_server_start(3http), diff --git a/man/tip/nng_http_server_start.3http.html b/man/tip/nng_http_server_start.3http.html index 461405d5..cd018a91 100644 --- a/man/tip/nng_http_server_start.3http.html +++ b/man/tip/nng_http_server_start.3http.html @@ -554,32 +554,48 @@ connections and handling HTTP requests.

    ERRORS

    -
    -
    -
    NNG_EADDRINUSE
    -
    -

    The TCP port is unavaialble.

    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + + + + + +
    +NNG_EADDRINUSE + +

    The TCP port is unavailable.

    +
    +NNG_EADDRINVAL +

    The server is configured with an invalid address.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    HTTP not supported.

    - - +

    SEE ALSO

    -
    +

    nng_http_server_hold(3http), nng_http_server_release(3http), nng_http_server_stop(3http), diff --git a/man/tip/nng_http_server_stop.3http.html b/man/tip/nng_http_server_stop.3http.html index ea4ed2f6..ab07b63a 100644 --- a/man/tip/nng_http_server_stop.3http.html +++ b/man/tip/nng_http_server_stop.3http.html @@ -562,7 +562,7 @@ any HTTP connections associated with it.

    SEE ALSO

    -
    +

    nng_http_server_hold(3http), nng_http_server_start(3http), nng(7)

    diff --git a/man/tip/nng_inproc.7.html b/man/tip/nng_inproc.7.html index 4e15b3b5..4ae4faba 100644 --- a/man/tip/nng_inproc.7.html +++ b/man/tip/nng_inproc.7.html @@ -595,7 +595,7 @@ the actual structure is of type

    SEE ALSO

    -
    +

    nng_inproc_register(3), nng_sockaddr_inproc(5), nng(7)

    diff --git a/man/tip/nng_inproc_register.3.html b/man/tip/nng_inproc_register.3.html index c55f4183..9cb94481 100644 --- a/man/tip/nng_inproc_register.3.html +++ b/man/tip/nng_inproc_register.3.html @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_inproc(5), nng(7)

    diff --git a/man/tip/nng_iov.5.html b/man/tip/nng_iov.5.html index 498dfb67..a3f831f1 100644 --- a/man/tip/nng_iov.5.html +++ b/man/tip/nng_iov.5.html @@ -570,7 +570,7 @@ referenced by this scatter/gather element.

    SEE ALSO

    -
    +

    nng_aio_set_iov(3), nng_aio(5), nng(7)

    diff --git a/man/tip/nng_ipc.7.html b/man/tip/nng_ipc.7.html index 11f3e55f..fe582579 100644 --- a/man/tip/nng_ipc.7.html +++ b/man/tip/nng_ipc.7.html @@ -683,7 +683,7 @@ The best practice for limiting access is to place the socket in a directory writable only by the server, and only readable and searchable by clients. All mainstream POSIX systems will fail to permit a client to connect -to a socket located in a diretor for which the client lacks search (execute) +to a socket located in a directory for which the client lacks search (execute) permission. @@ -773,7 +773,7 @@ Zones (and this option) are only supported on Solaris and illumos systems.

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng(7)

    diff --git a/man/tip/nng_ipc_register.3.html b/man/tip/nng_ipc_register.3.html index aa0346e2..2caa153d 100644 --- a/man/tip/nng_ipc_register.3.html +++ b/man/tip/nng_ipc_register.3.html @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_ipc(5), nng(7)

    diff --git a/man/tip/nng_listen.3.html b/man/tip/nng_listen.3.html index c05cf312..b377b2f8 100644 --- a/man/tip/nng_listen.3.html +++ b/man/tip/nng_listen.3.html @@ -611,36 +611,56 @@ their pipes with the socket, until either it or the socket s is closed.

    ERRORS

    -
    -
    -
    NNG_EADDRINUSE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EADDRINUSE +

    The address specified by url is already in use.

    - -
    NNG_EADDRINVAL
    -
    +
    +NNG_EADDRINVAL +

    An invalid url was specified.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - - +

    SEE ALSO

    -
    +

    nng_dial(3), nng_listener_close(3), nng_listener_create(3) diff --git a/man/tip/nng_listener.5.html b/man/tip/nng_listener.5.html index 106837df..8d2f3b8d 100644 --- a/man/tip/nng_listener.5.html +++ b/man/tip/nng_listener.5.html @@ -613,7 +613,7 @@ before it is opened, to prevent confusion with valid open listener.

    SEE ALSO

    -
    +

    nng_listen(3), nng_listener_close(3), nng_listener_create(3), diff --git a/man/tip/nng_listener_close.3.html b/man/tip/nng_listener_close.3.html index 14a740c3..42452b8b 100644 --- a/man/tip/nng_listener_close.3.html +++ b/man/tip/nng_listener_close.3.html @@ -563,20 +563,24 @@ is closed.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + +
    +NNG_ECLOSED +

    Parameter l does not refer to an open listener.

    - - +

    SEE ALSO

    -
    +

    nng_close(3), nng_listen(3), nng_listener_create(3) diff --git a/man/tip/nng_listener_create.3.html b/man/tip/nng_listener_create.3.html index f69da444..9d0ff4cb 100644 --- a/man/tip/nng_listener_create.3.html +++ b/man/tip/nng_listener_create.3.html @@ -600,28 +600,40 @@ simpler nng_listen() function inste

    ERRORS

    -
    -
    -
    NNG_EADDRINVAL
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EADDRINVAL +

    An invalid url was specified.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_create(3) nng_listen(3), nng_listener_close(3), diff --git a/man/tip/nng_listener_getopt.3.html b/man/tip/nng_listener_getopt.3.html index af401fdc..790de10c 100644 --- a/man/tip/nng_listener_getopt.3.html +++ b/man/tip/nng_listener_getopt.3.html @@ -600,7 +600,7 @@ by valszp.

    When the function returns, the actual size of the data copied (or that would have been copied if sufficient space were present) is stored at -the location referened by valszp. +the location referenced by valszp. If the caller’s buffer is not large enough to hold the entire object, then the copy is truncated. Therefore the caller should validate that the returned size in valszp does not @@ -615,7 +615,7 @@ the object.

    nng_listener_getopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The value will be stored at bvalp.

    @@ -688,40 +688,64 @@ numbers, and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter l does not refer to an open listener.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    Size of destination val too small for object.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory exists.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EWRITEONLY
    -
    +
    +NNG_EWRITEONLY +

    The option opt is write-only.

    - - +

    SEE ALSO

    -
    +

    nng_listen(3), nng_listener_create(3) nng_listener_setopt(3) diff --git a/man/tip/nng_listener_id.3.html b/man/tip/nng_listener_id.3.html index 7141d14c..be2dfffc 100644 --- a/man/tip/nng_listener_id.3.html +++ b/man/tip/nng_listener_id.3.html @@ -580,7 +580,7 @@ they cannot be confused with a valid listener before they are created properly.

    SEE ALSO

    -
    +

    nng_listener(5), nng(7)

    diff --git a/man/tip/nng_listener_setopt.3.html b/man/tip/nng_listener_setopt.3.html index b3338089..8ad13282 100644 --- a/man/tip/nng_listener_setopt.3.html +++ b/man/tip/nng_listener_setopt.3.html @@ -608,7 +608,7 @@ size of the objected located at val.

    nng_listener_setopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The bval is passed to the option.

    @@ -678,40 +678,64 @@ and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter l does not refer to an open listener.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The value being passed is invalid.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EREADONLY
    -
    +
    +NNG_EREADONLY +

    The option opt is read-only.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The listener l is already started.

    - - +

    SEE ALSO

    -
    +

    nng_listen(3), nng_listener_create(3) nng_listener_getopt(3) diff --git a/man/tip/nng_listener_start.3.html b/man/tip/nng_listener_start.3.html index 7e2b5ae0..37d8b8d5 100644 --- a/man/tip/nng_listener_start.3.html +++ b/man/tip/nng_listener_start.3.html @@ -585,24 +585,32 @@ it’s configuration.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + + + + + +
    +NNG_ECLOSED +

    Parameter l does not refer to an open listener.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The listener l is already started.

    - - +

    SEE ALSO

    -
    +

    nng_listen(3), nng_listener_create(3) nng_listener(5), diff --git a/man/tip/nng_msg.5.html b/man/tip/nng_msg.5.html index 8f025a97..067d743d 100644 --- a/man/tip/nng_msg.5.html +++ b/man/tip/nng_msg.5.html @@ -538,7 +538,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_msg represents a single message sent between Scalability Protocols peers. -Messages internally have a body, containining the application supplied +Messages internally have a body, containing the application supplied payload, and a header, containing protocol specific routing and similar related information.

    @@ -581,20 +581,24 @@ by making use of scratch areas at the beginning and end of the message.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - - +

    SEE ALSO

    -
    +

    nng_aio_get_msg(3), nng_aio_set_msg(3), nng_msg_alloc(3), diff --git a/man/tip/nng_msg_alloc.3.html b/man/tip/nng_msg_alloc.3.html index e4964516..57375391 100644 --- a/man/tip/nng_msg_alloc.3.html +++ b/man/tip/nng_msg_alloc.3.html @@ -554,20 +554,24 @@ They are used with receive and transmit functions.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - - +

    SEE ALSO

    -
    +

    nng_msg_free(3), nng_msg_body(3), nng_msg_dup(3), diff --git a/man/tip/nng_msg_append.3.html b/man/tip/nng_msg_append.3.html index f4a977db..cdd5e9f9 100644 --- a/man/tip/nng_msg_append.3.html +++ b/man/tip/nng_msg_append.3.html @@ -556,20 +556,24 @@ second function appends the value val32 in network-byte order (big-endi

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_body(3), nng_msg_chop(3), diff --git a/man/tip/nng_msg_body.3.html b/man/tip/nng_msg_body.3.html index 0b6c9b69..c7e4382b 100644 --- a/man/tip/nng_msg_body.3.html +++ b/man/tip/nng_msg_body.3.html @@ -580,7 +580,7 @@ or nng_msg_insert() variants.

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_append(3), nng_msg_chop(3), diff --git a/man/tip/nng_msg_chop.3.html b/man/tip/nng_msg_chop.3.html index 75161ccb..43f31430 100644 --- a/man/tip/nng_msg_chop.3.html +++ b/man/tip/nng_msg_chop.3.html @@ -557,20 +557,24 @@ after converting them from network-byte order (big-endian) to native byte order.

    ERRORS

    -
    -
    -
    NNG_EINVAL
    -
    +
    + + + + + +
    +NNG_EINVAL +

    The message body is too short to remove the requested data.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_append(3), nng_msg_body(3), diff --git a/man/tip/nng_msg_clear.3.html b/man/tip/nng_msg_clear.3.html index f3775957..e769442c 100644 --- a/man/tip/nng_msg_clear.3.html +++ b/man/tip/nng_msg_clear.3.html @@ -559,7 +559,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_msg(5), nng(7)

    diff --git a/man/tip/nng_msg_dup.3.html b/man/tip/nng_msg_dup.3.html index 7b3d3de1..4feafb82 100644 --- a/man/tip/nng_msg_dup.3.html +++ b/man/tip/nng_msg_dup.3.html @@ -555,20 +555,24 @@ different amount of unused space than the original message.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to duplicate a message.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_free(3), nng_strerror(3), diff --git a/man/tip/nng_msg_free.3.html b/man/tip/nng_msg_free.3.html index 8eef5180..fa7af321 100644 --- a/man/tip/nng_msg_free.3.html +++ b/man/tip/nng_msg_free.3.html @@ -559,7 +559,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_realloc(3), nng_msg(5), diff --git a/man/tip/nng_msg_get_pipe.3.html b/man/tip/nng_msg_get_pipe.3.html index a53d75d6..4f844ace 100644 --- a/man/tip/nng_msg_get_pipe.3.html +++ b/man/tip/nng_msg_get_pipe.3.html @@ -571,7 +571,7 @@ is useful in this situation.

    This function returns the pipe associated with this message, which will be a positive value. If the pipe is non-positive, then that indicates that -no specific pipe is associated with the messsage.

    +no specific pipe is associated with the message.

    @@ -586,7 +586,7 @@ no specific pipe is associated with the messsage.

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_set_pipe(3), nng_pipe_getopt(3), diff --git a/man/tip/nng_msg_header.3.html b/man/tip/nng_msg_header.3.html index 9d27879a..36c2a5b6 100644 --- a/man/tip/nng_msg_header.3.html +++ b/man/tip/nng_msg_header.3.html @@ -588,7 +588,7 @@ functions that modify the message or the header content.

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_body(3), nng_msg_free(3), diff --git a/man/tip/nng_msg_header_append.3.html b/man/tip/nng_msg_header_append.3.html index a25f4726..e46ce42e 100644 --- a/man/tip/nng_msg_header_append.3.html +++ b/man/tip/nng_msg_header_append.3.html @@ -558,20 +558,24 @@ The second function appends the value val32 in network-byte order

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_header(3), nng_msg_header_chop(3), diff --git a/man/tip/nng_msg_header_chop.3.html b/man/tip/nng_msg_header_chop.3.html index a5e7aeda..0e8df6aa 100644 --- a/man/tip/nng_msg_header_chop.3.html +++ b/man/tip/nng_msg_header_chop.3.html @@ -558,20 +558,24 @@ byte order.

    ERRORS

    -
    -
    -
    NNG_EINVAL
    -
    +
    + + + + + +
    +NNG_EINVAL +

    The message header is too short to remove the requested data.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_header(3), nng_msg_header_append(3), diff --git a/man/tip/nng_msg_header_clear.3.html b/man/tip/nng_msg_header_clear.3.html index 9b33c856..4d259340 100644 --- a/man/tip/nng_msg_header_clear.3.html +++ b/man/tip/nng_msg_header_clear.3.html @@ -559,7 +559,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_free(3), nng(7)

    diff --git a/man/tip/nng_msg_header_insert.3.html b/man/tip/nng_msg_header_insert.3.html index af9436c5..41348dcc 100644 --- a/man/tip/nng_msg_header_insert.3.html +++ b/man/tip/nng_msg_header_insert.3.html @@ -557,20 +557,24 @@ second function prepends the value val32 in network-byte order (big-end

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_header(3), nng_msg_header_append(3), diff --git a/man/tip/nng_msg_header_len.3.html b/man/tip/nng_msg_header_len.3.html index 37af777d..a352d0ba 100644 --- a/man/tip/nng_msg_header_len.3.html +++ b/man/tip/nng_msg_header_len.3.html @@ -559,7 +559,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_header(3), nng_msg(5), diff --git a/man/tip/nng_msg_header_trim.3.html b/man/tip/nng_msg_header_trim.3.html index ac1778a0..207dadc0 100644 --- a/man/tip/nng_msg_header_trim.3.html +++ b/man/tip/nng_msg_header_trim.3.html @@ -558,20 +558,24 @@ byte order.

    ERRORS

    -
    -
    -
    NNG_EINVAL
    -
    +
    + + + + + +
    +NNG_EINVAL +

    The message header is too short to remove the requested data.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_header(3), nng_msg_header_append(3), diff --git a/man/tip/nng_msg_insert.3.html b/man/tip/nng_msg_insert.3.html index d291a2cb..a18e1181 100644 --- a/man/tip/nng_msg_insert.3.html +++ b/man/tip/nng_msg_insert.3.html @@ -554,7 +554,7 @@ The second function prepends the value val32 in network-byte order This function makes use of pre-allocated “headroom” in the message if available, so it can often avoid performing any reallocation. Applications should use this instead of reallocating and copying message -content themselves, in order to benefit from this capabilitiy. +content themselves, in order to benefit from this capability. @@ -572,20 +572,24 @@ content themselves, in order to benefit from this capabilitiy.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_append(3), nng_msg_body(3), diff --git a/man/tip/nng_msg_len.3.html b/man/tip/nng_msg_len.3.html index a9bc4fb8..17a5a43f 100644 --- a/man/tip/nng_msg_len.3.html +++ b/man/tip/nng_msg_len.3.html @@ -559,7 +559,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_body(3), nng_msg(5), diff --git a/man/tip/nng_msg_realloc.3.html b/man/tip/nng_msg_realloc.3.html index 6ca1c048..783cee40 100644 --- a/man/tip/nng_msg_realloc.3.html +++ b/man/tip/nng_msg_realloc.3.html @@ -587,20 +587,24 @@ may have changed, particularly if the message size is increasing.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to reallocate a message.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_append(3), nng_msg_body(3), diff --git a/man/tip/nng_msg_set_pipe.3.html b/man/tip/nng_msg_set_pipe.3.html index c6c677af..c643b3eb 100644 --- a/man/tip/nng_msg_set_pipe.3.html +++ b/man/tip/nng_msg_set_pipe.3.html @@ -575,7 +575,7 @@ Not all protocols support overriding the destination pipe.

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_get_pipe(3), nng_pipe_getopt(3), diff --git a/man/tip/nng_msg_trim.3.html b/man/tip/nng_msg_trim.3.html index 4cdd61ee..3a67da93 100644 --- a/man/tip/nng_msg_trim.3.html +++ b/man/tip/nng_msg_trim.3.html @@ -558,20 +558,24 @@ byte order.

    ERRORS

    -
    -
    -
    NNG_EINVAL
    -
    +
    + + + + + +
    +NNG_EINVAL +

    The message body is too short to remove the requested data.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_msg_append(3), nng_msg_body(3), diff --git a/man/tip/nng_msleep.3supp.html b/man/tip/nng_msleep.3supp.html index 8658c615..7bc6ffbc 100644 --- a/man/tip/nng_msleep.3supp.html +++ b/man/tip/nng_msleep.3supp.html @@ -574,7 +574,7 @@ underlying system.

    SEE ALSO

    -
    +

    nng_sleep_aio(3), nng_strerror(3), nng_clock(3supp), diff --git a/man/tip/nng_mtx_alloc.3supp.html b/man/tip/nng_mtx_alloc.3supp.html index 915fdcbf..10f0942a 100644 --- a/man/tip/nng_mtx_alloc.3supp.html +++ b/man/tip/nng_mtx_alloc.3supp.html @@ -566,20 +566,24 @@ where only a single thread of execution is permitted to “own” the se

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_mtx_free(3supp), nng_mtx_lock(3supp), diff --git a/man/tip/nng_mtx_free.3supp.html b/man/tip/nng_mtx_free.3supp.html index 1e6cda92..ac7c690f 100644 --- a/man/tip/nng_mtx_free.3supp.html +++ b/man/tip/nng_mtx_free.3supp.html @@ -561,7 +561,7 @@ The mutex must not be locked when this function is called.

    SEE ALSO

    -
    +

    nng_mtx_alloc(3supp), nng(7)

    diff --git a/man/tip/nng_mtx_lock.3supp.html b/man/tip/nng_mtx_lock.3supp.html index 2d176530..8ca07fb3 100644 --- a/man/tip/nng_mtx_lock.3supp.html +++ b/man/tip/nng_mtx_lock.3supp.html @@ -604,7 +604,7 @@ easily from mutexes and condition variables.

    SEE ALSO

    -
    +

    nng_cv_alloc(3supp), nng_mtx_alloc(3supp), nng_mtx_unlock(3supp), diff --git a/man/tip/nng_mtx_unlock.3supp.html b/man/tip/nng_mtx_unlock.3supp.html index 5d931903..5ba975d8 100644 --- a/man/tip/nng_mtx_unlock.3supp.html +++ b/man/tip/nng_mtx_unlock.3supp.html @@ -537,7 +537,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_mtx_unlock() reqlinquishes ownership of the mutex mtx that +

    The nng_mtx_unlock() relinquishes ownership of the mutex mtx that was previously acquired via nng_mtx_lock().

    @@ -575,7 +575,7 @@ in undefined behavior.

    SEE ALSO

    -
    +

    nng_mtx_alloc(3supp), nng_mtx_lock(3supp), nng(7)

    diff --git a/man/tip/nng_options.5.html b/man/tip/nng_options.5.html index 9cbc4686..08de92f3 100644 --- a/man/tip/nng_options.5.html +++ b/man/tip/nng_options.5.html @@ -549,7 +549,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b #define NNG_OPT_RECONNMINT "reconnect-time-min" #define NNG_OPT_RECONNMAXT "reconnect-time-max" #define NNG_OPT_TCP_NODELAY "tcp-nodelay" -#define NNG_OPT_TCP_KEEPALIVE "tcp-nodelay" +#define NNG_OPT_TCP_KEEPALIVE "tcp-keepalive"
    @@ -657,7 +657,7 @@ If this is non-zero, then the time between successive connection attempts will start at the value of NNG_OPT_RECONNMINT, and grow exponentially, until it reaches this value. If this value is zero, then no exponential -backoff between connection attempts is done, and each attempt will wait +back-off between connection attempts is done, and each attempt will wait the time specified by NNG_OPT_RECONNMINT. This can be set on a socket, but it can also be overridden on an individual dialer. @@ -707,7 +707,7 @@ be readable.

    -Appplications should never attempt to read or write to the +Applications should never attempt to read or write to the returned file descriptor. @@ -839,7 +839,7 @@ the descriptor will not be readable.

    -Appplications should never attempt to read or write to the +Applications should never attempt to read or write to the returned file descriptor. @@ -1071,7 +1071,7 @@ middleware from being expiring due to lack of activity.

    SEE ALSO

    -
    +

    nng_dialer_getopt(3), nng_dialer_setopt(3), nng_getopt(3), diff --git a/man/tip/nng_opts_parse.3supp.html b/man/tip/nng_opts_parse.3supp.html index e1ad7861..7b29437c 100644 --- a/man/tip/nng_opts_parse.3supp.html +++ b/man/tip/nng_opts_parse.3supp.html @@ -552,7 +552,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_opts_parse() is function is a supplemental funtion intened to +

    The nng_opts_parse() is function is a supplemental function intended to facilitate parsing command line arguments. This function exists largely to stand in for getopt() from POSIX systems, but it is available everywhere that NNG is, and it includes @@ -740,28 +740,40 @@ no more options are available to be parsed, or an error number otherwise.

    ERRORS

    -
    -
    -
    NNG_EAMBIGUOUS
    -
    +
    + + + + + + + + + + + + + +
    +NNG_EAMBIGUOUS +

    Parsed option matches more than one specification.

    - -
    NNG_ENOARG
    -
    +
    +NNG_ENOARG +

    Option requires an argument, but one is not present.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid (unknown) argument is present.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng(7)

    diff --git a/man/tip/nng_pair.7.html b/man/tip/nng_pair.7.html index 4f2262fe..a3435d57 100644 --- a/man/tip/nng_pair.7.html +++ b/man/tip/nng_pair.7.html @@ -553,8 +553,8 @@ relationships between peers are one-to-one.

    Version 1 of this protocol supports an optional polyamorous mode where a -peer can maintain multiple partnerships. Using this mode requires -some additional sophistication in the application.

    +peer can maintain multiple partnerships. +Using this mode requires some additional sophistication in the application.

    Socket Operations

    @@ -579,7 +579,7 @@ prevents discarding messages most of the time, there are topologies involving messages may be discarded. Applications that require reliable delivery semantics should consider using req sockets, or -implement their own acknowledgement layer on top of pair sockets. +implement their own acknowledgment layer on top of pair sockets. @@ -641,7 +641,7 @@ peer.

    In polyamorous mode, which is only available with version 1, a socket can support many one-to-one connections. In this mode, the application must -choose the remote peer to receive an ougoing message by setting the +choose the remote peer to receive an outgoing message by setting the nng_pipe to use for the outgoing message with the nng_msg_set_pipe() function.

    @@ -667,7 +667,7 @@ to the sender.

    NNG_OPT_PAIR1_POLY

    (bool, version 1 only) This option enables the use of polyamorous mode. -The value is read-write, and takes an integer boolean value. The default +The value is read-write, and takes an integer Boolean value. The default false value (0) indicates that legacy monogamous mode should be used.

    NNG_OPT_MAXTTL
    @@ -685,7 +685,7 @@ false value (0) indicates that legacy monogamous mode should be used.

    Version 1 of the pair protocol uses a single 32-bit unsigned value. The low-order (big-endian) byte of this value contains a "hop" count, and is -used in conjuction with the +used in conjunction with the NNG_OPT_MAXTTL option to guard against device forwarding loops. This value is initialized to 1, and incremented each time the message is @@ -697,7 +697,7 @@ received by a new node.

    SEE ALSO

    -
    +

    nng_pair_open(3), nng_options(5), nng(7)

    diff --git a/man/tip/nng_pair_open.3.html b/man/tip/nng_pair_open.3.html index 0eb51508..1d3d6b35 100644 --- a/man/tip/nng_pair_open.3.html +++ b/man/tip/nng_pair_open.3.html @@ -572,24 +572,32 @@ create a pair version 0 or version 1

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_pair(7), nng(7)

    diff --git a/man/tip/nng_pipe.5.html b/man/tip/nng_pipe.5.html index 83d6fbcc..90c26c71 100644 --- a/man/tip/nng_pipe.5.html +++ b/man/tip/nng_pipe.5.html @@ -607,7 +607,7 @@ before it is opened, to prevent confusion with valid open pipes.

    SEE ALSO

    -
    +

    nng_msg_get_pipe(3), nng_pipe_close(3), nng_pipe_getopt(3), diff --git a/man/tip/nng_pipe_close.3.html b/man/tip/nng_pipe_close.3.html index 0f167618..8dcabab8 100644 --- a/man/tip/nng_pipe_close.3.html +++ b/man/tip/nng_pipe_close.3.html @@ -571,20 +571,24 @@ remote peer closes the underlying connection.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + +
    +NNG_ECLOSED +

    The pipe p is already closed or was never opened.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_options(5), nng_pipe(5), diff --git a/man/tip/nng_pipe_dialer.3.html b/man/tip/nng_pipe_dialer.3.html index 66dc1902..0133e4ac 100644 --- a/man/tip/nng_pipe_dialer.3.html +++ b/man/tip/nng_pipe_dialer.3.html @@ -564,7 +564,7 @@ not created by a dialer, in which case a value initialized with

    SEE ALSO

    -
    +

    nng_pipe(5), nng_dialer(5), nng(7)

    diff --git a/man/tip/nng_pipe_getopt.3.html b/man/tip/nng_pipe_getopt.3.html index cc1e6183..d0fe38c1 100644 --- a/man/tip/nng_pipe_getopt.3.html +++ b/man/tip/nng_pipe_getopt.3.html @@ -562,7 +562,7 @@ the pipe p. The actual options that may be retrieved in this way vary, and many are documented in nng_options(5). Additionally some transport-specific options and protocol-specific options are -documented with the transports andp protocols themselves.

    +documented with the transports and protocols themselves.

    @@ -603,10 +603,10 @@ buffer shall be stored at the location referenced by valszp.

    When the function returns, the actual size of the data copied (or that would have been copied if sufficient space were present) is stored at -the location referened by valszp. +the location referenced by valszp. If the caller’s buffer is not large enough to hold the entire object, then the copy is truncated. -Therefore the caller should check for trncation by verifying that the +Therefore the caller should check for truncation by verifying that the size returned in valszp does not exceed the original buffer size.

    @@ -630,16 +630,15 @@ Generally, it will be easier to use one of the typed forms instead.

    nng_pipe_getopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The value will be stored at bvalp.

    nng_pipe_getopt_int()

    -

    This function is for options which take an integer (int) or boolean (bool). -The value will be stored at ivalp. For booleans the value will be eiher 0 -(false) or 1 (true).

    +

    This function is for options which take an integer (int). +The value will be stored at ivalp.

    @@ -685,7 +684,7 @@ and consequently must be freed by the caller using

    nng_pipe_getopt_uint64()

    -

    This function is used to retriev a 64-bit unsigned value into the value +

    This function is used to retrieve a 64-bit unsigned value into the value referenced by u64p. This is typically used for options related to identifiers, network numbers, and similar.

    @@ -705,40 +704,64 @@ related to identifiers, network numbers, and similar.

    ERRORS

    -
    -
    -
    NNG_EBADTYPE
    -
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EBADTYPE +

    Incorrect type for option.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    Parameter p does not refer to an open pipe.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory exists.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    Size of destination val too small for object.

    - -
    NNG_EWRITEONLY
    -
    +
    +NNG_EWRITEONLY +

    The option opt is write-only.

    - - +

    SEE ALSO

    -
    +

    nng_dialer_setopt(3) nng_getopt(3), nng_listener_setopt(3) diff --git a/man/tip/nng_pipe_id.3.html b/man/tip/nng_pipe_id.3.html index 54150ff3..3432c70b 100644 --- a/man/tip/nng_pipe_id.3.html +++ b/man/tip/nng_pipe_id.3.html @@ -578,7 +578,7 @@ they cannot be confused with a valid pipe.

    SEE ALSO

    -
    +

    nng_pipe(5), nng(7)

    diff --git a/man/tip/nng_pipe_listener.3.html b/man/tip/nng_pipe_listener.3.html index 0dd4dbfe..a6241e43 100644 --- a/man/tip/nng_pipe_listener.3.html +++ b/man/tip/nng_pipe_listener.3.html @@ -536,7 +536,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pipe_listener() function returns the nng_lisener +

    The nng_pipe_listener() function returns the nng_listener that created the pipe p. If the pipe was not created by a listener, then the returned value will have an identifier (nng_listener_id()) of -1.

    @@ -564,7 +564,7 @@ not created by a listener, in which case a value initialized with

    SEE ALSO

    -
    +

    nng_pipe(5), nng_listener(5), nng(7)

    diff --git a/man/tip/nng_pipe_notify.3.html b/man/tip/nng_pipe_notify.3.html index 443b7ed9..8153eb04 100644 --- a/man/tip/nng_pipe_notify.3.html +++ b/man/tip/nng_pipe_notify.3.html @@ -636,20 +636,24 @@ This function ignores invalid values for ev.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + +
    +NNG_ECLOSED +

    The socket s does not refer to an open socket.

    - - +

    SEE ALSO

    -
    +

    nng_pipe_close(3), nng_pipe_getopt(3), nng_pipe(5), diff --git a/man/tip/nng_pipe_socket.3.html b/man/tip/nng_pipe_socket.3.html index de4f64f1..13861c70 100644 --- a/man/tip/nng_pipe_socket.3.html +++ b/man/tip/nng_pipe_socket.3.html @@ -573,7 +573,7 @@ which case it will not be usable with other functions.

    SEE ALSO

    -
    +

    nng_pipe(5), nng_socket(5), nng(7)

    diff --git a/man/tip/nng_pub.7.html b/man/tip/nng_pub.7.html index f3e9e1dc..c4a54c5c 100644 --- a/man/tip/nng_pub.7.html +++ b/man/tip/nng_pub.7.html @@ -603,7 +603,7 @@ Attempts to receive messages will result in NNG_ENOTSUP.

    SEE ALSO

    -
    +

    nng_pub_open(3), nng_sub(7), nng(7)

    diff --git a/man/tip/nng_pub_open.3.html b/man/tip/nng_pub_open.3.html index 29d40cf0..f734be52 100644 --- a/man/tip/nng_pub_open.3.html +++ b/man/tip/nng_pub_open.3.html @@ -560,24 +560,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_pub(7), nng_sub(7), diff --git a/man/tip/nng_pull.7.html b/man/tip/nng_pull.7.html index de455ada..9b1dc72e 100644 --- a/man/tip/nng_pull.7.html +++ b/man/tip/nng_pull.7.html @@ -589,7 +589,7 @@ order in which messages are handled is undefined.

    SEE ALSO

    -
    +

    nng_pull_open(3), nng_push(7), nng(7),

    diff --git a/man/tip/nng_pull_open.3.html b/man/tip/nng_pull_open.3.html index 50f2b7bf..dbec6a1b 100644 --- a/man/tip/nng_pull_open.3.html +++ b/man/tip/nng_pull_open.3.html @@ -560,24 +560,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_pull(7), nng_push(7), diff --git a/man/tip/nng_push.7.html b/man/tip/nng_push.7.html index 9bce8313..5492fc9d 100644 --- a/man/tip/nng_push.7.html +++ b/man/tip/nng_push.7.html @@ -572,7 +572,7 @@ wait until one is available, or the operation times out.

    Although the pipeline protocol honors flow control, and attempts to avoid dropping messages, no guarantee of delivery is made. -Furthermore, as there is no capability for message acknowledgement, +Furthermore, as there is no capability for message acknowledgment, applications that need reliable delivery are encouraged to consider the req protocol instead. @@ -604,7 +604,7 @@ applications that need reliable delivery are encouraged to consider the

    SEE ALSO

    -
    +

    nng_push(3), nng_pull(7), nng_req(7), diff --git a/man/tip/nng_push_open.3.html b/man/tip/nng_push_open.3.html index a4089068..2b321eba 100644 --- a/man/tip/nng_push_open.3.html +++ b/man/tip/nng_push_open.3.html @@ -560,24 +560,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_pull(7), nng_push(7), diff --git a/man/tip/nng_random.3supp.html b/man/tip/nng_random.3supp.html index 8397d80f..aef6dd65 100644 --- a/man/tip/nng_random.3supp.html +++ b/man/tip/nng_random.3supp.html @@ -564,7 +564,7 @@ number facilities when available.

    SEE ALSO

    -
    +

    nng(7)

    diff --git a/man/tip/nng_recv.3.html b/man/tip/nng_recv.3.html index 66bf9ab5..487257cf 100644 --- a/man/tip/nng_recv.3.html +++ b/man/tip/nng_recv.3.html @@ -605,44 +605,72 @@ a response using the same flag.

    ERRORS

    -
    -
    -
    NNG_EAGAIN
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN +

    The socket s cannot accept data for sending.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_EMSGSIZE
    -
    +
    +NNG_EMSGSIZE +

    The received message did not fit in the size provided.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support receiving.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot receive data in this state.

    - - +

    SEE ALSO

    -
    +

    nng_alloc(3), nng_free(3), nng_recvmsg(3), diff --git a/man/tip/nng_recv_aio.3.html b/man/tip/nng_recv_aio.3.html index e9dd66c5..388e78ae 100644 --- a/man/tip/nng_recv_aio.3.html +++ b/man/tip/nng_recv_aio.3.html @@ -601,40 +601,64 @@ are replies to requests, until they have first sent a request.)

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was aborted.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support receiving.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot receive data in this state.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    The receive timeout expired.

    - - +

    SEE ALSO

    -
    +

    nng_aio_get_msg(3), nng_aio_set_msg(3), nng_msg_alloc(3), diff --git a/man/tip/nng_recvmsg.3.html b/man/tip/nng_recvmsg.3.html index b0432071..47b1278f 100644 --- a/man/tip/nng_recvmsg.3.html +++ b/man/tip/nng_recvmsg.3.html @@ -596,40 +596,64 @@ Furthermore, some protocols may not support receiving data at all, such as

    ERRORS

    -
    -
    -
    NNG_EAGAIN
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN +

    The socket s cannot accept data for sending.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support receiving.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot receive data in this state.

    - - +

    SEE ALSO

    -
    +

    nng_msg_free(3), nng_recv(3), nng_sendmsg(3), diff --git a/man/tip/nng_rep.7.html b/man/tip/nng_rep.7.html index fe8d55ad..c9edd5ef 100644 --- a/man/tip/nng_rep.7.html +++ b/man/tip/nng_rep.7.html @@ -625,7 +625,7 @@ This is more fully documented in the req m

    SEE ALSO

    -
    +

    nng_rep_open(3), nng(7), nng_req(7)

    diff --git a/man/tip/nng_rep_open.3.html b/man/tip/nng_rep_open.3.html index 84c36b63..7e081172 100644 --- a/man/tip/nng_rep_open.3.html +++ b/man/tip/nng_rep_open.3.html @@ -558,24 +558,32 @@ in raw mode and returns it at the location pointed to b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_rep(7), nng_req(7), diff --git a/man/tip/nng_req.7.html b/man/tip/nng_req.7.html index 429343c3..e32cc0b6 100644 --- a/man/tip/nng_req.7.html +++ b/man/tip/nng_req.7.html @@ -685,7 +685,7 @@ There must be at least one identifier, the request ID, last element in the array, and must have the most significant bit set.

    -

    There may be additional peer IDs preceeding the request ID. +

    There may be additional peer IDs preceding the request ID. These will be distinguishable from the request ID by having their most significant bit clear.

    @@ -714,7 +714,7 @@ that the request contained.

    message, stripping it from the front of the message as it does so.

    -

    When the reply finally arrives back at the initiating requestor, it +

    When the reply finally arrives back at the initiating requester, it should have only a single element in the message, which will be the request ID it originally used for the request.

    @@ -724,7 +724,7 @@ request ID it originally used for the request.

    SEE ALSO

    -
    +

    nng_ctx_open(3), nng_device(3), nng_req_open(3), diff --git a/man/tip/nng_req_open.3.html b/man/tip/nng_req_open.3.html index b9989eec..6b213e66 100644 --- a/man/tip/nng_req_open.3.html +++ b/man/tip/nng_req_open.3.html @@ -561,24 +561,32 @@ and returns it at the location pointed to by s.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_options(5), nng_socket(5), nng_rep(7), diff --git a/man/tip/nng_respondent.7.html b/man/tip/nng_respondent.7.html index 173f0752..2b1f2d94 100644 --- a/man/tip/nng_respondent.7.html +++ b/man/tip/nng_respondent.7.html @@ -628,7 +628,7 @@ This is more fully documented in the surveyor<

    SEE ALSO

    -
    +

    nng_respondent_open(3), nng_surveyor(7), nng(7)

    diff --git a/man/tip/nng_respondent_open.3.html b/man/tip/nng_respondent_open.3.html index 86c25a56..123871aa 100644 --- a/man/tip/nng_respondent_open.3.html +++ b/man/tip/nng_respondent_open.3.html @@ -563,24 +563,32 @@ version 0 socket in

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_respondent(7), nng_surveyor(7), diff --git a/man/tip/nng_send.3.html b/man/tip/nng_send.3.html index bca655ff..1b1bafee 100644 --- a/man/tip/nng_send.3.html +++ b/man/tip/nng_send.3.html @@ -609,7 +609,7 @@ increasing performance. Regardless of the presence or absence of NNG_FLAG_NONBLOCK, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. -Finally, with some protocols, the semantic is implictly NNG_FLAG_NONBLOCK, +Finally, with some protocols, the semantic is implicitly NNG_FLAG_NONBLOCK, such as with pub sockets, which are best-effort delivery only. @@ -626,7 +626,7 @@ When using NNG_FLAG_ALLOC, it is important that the value of si match the actual allocated size of the data. Using an incorrect size results in unspecified behavior, which may include heap corruption, program crashes, -or transdimensional mutation of the program’s author. +or trans-dimensional mutation of the program’s author. @@ -644,44 +644,72 @@ or transdimensional mutation of the program’s author.

    ERRORS

    -
    -
    -
    NNG_EAGAIN
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN +

    The socket s cannot accept data for sending.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_EMSGSIZE
    -
    +
    +NNG_EMSGSIZE +

    The value of size is too large.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support sending.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot send data in this state.

    - - +

    SEE ALSO

    -
    +

    nng_alloc(3), nng_free(3), nng_recv(3), diff --git a/man/tip/nng_send_aio.3.html b/man/tip/nng_send_aio.3.html index 303c3896..351e085a 100644 --- a/man/tip/nng_send_aio.3.html +++ b/man/tip/nng_send_aio.3.html @@ -572,7 +572,7 @@ socket, or in flight over physical media. then the aio callback will be executed and nng_aio_result() will return a non-zero error status. -In this case, the callback has a responsibity to retrieve the message from +In this case, the callback has a responsibility to retrieve the message from the aio with nng_aio_get_msg() and dispose of it appropriately. (This may include retrying the send operation on the same or a different @@ -611,44 +611,72 @@ are responses to requests, until they have first received a request.)

    ERRORS

    -
    -
    -
    NNG_ECANCELED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECANCELED +

    The operation was aborted.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EMSGSIZE
    -
    +
    +NNG_EMSGSIZE +

    The message is too large.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support sending.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot send data in this state.

    - -
    NNG_ETIMEDOUT
    -
    +
    +NNG_ETIMEDOUT +

    The send timeout expired.

    - - +

    SEE ALSO

    -
    +

    nng_aio_get_msg(3), nng_aio_set_msg(3), nng_msg_alloc(3), diff --git a/man/tip/nng_sendmsg.3.html b/man/tip/nng_sendmsg.3.html index 05ab0a8c..d9c57e00 100644 --- a/man/tip/nng_sendmsg.3.html +++ b/man/tip/nng_sendmsg.3.html @@ -609,7 +609,7 @@ condition exists.

    Regardless of the presence or absence of NNG_FLAG_NONBLOCK, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. -Finally, with some protocols, the semantic is implictly NNG_FLAG_NONBLOCK, +Finally, with some protocols, the semantic is implicitly NNG_FLAG_NONBLOCK, such as with pub sockets, which are best-effort delivery only. @@ -628,44 +628,72 @@ such as with pub sockets, which are best-e

    ERRORS

    -
    -
    -
    NNG_EAGAIN
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN +

    The socket s cannot accept data for sending.

    - -
    NNG_ECLOSED
    -
    +
    +NNG_ECLOSED +

    The socket s is not open.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid set of flags was specified.

    - -
    NNG_EMSGSIZE
    -
    +
    +NNG_EMSGSIZE +

    The value of size is too large.

    - -
    NNG_ENOMEM
    -
    +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol for socket s does not support sending.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket s cannot send data in this state.

    - - +

    SEE ALSO

    -
    +

    nng_msg_alloc(3), nng_recvmsg(3), nng_send(3), diff --git a/man/tip/nng_setopt.3.html b/man/tip/nng_setopt.3.html index 2cdf9e7e..cb2fc9ab 100644 --- a/man/tip/nng_setopt.3.html +++ b/man/tip/nng_setopt.3.html @@ -595,7 +595,7 @@ size of the objected located at val.

    nng_setopt_bool()

    -

    This function is for options which take a boolean (bool). +

    This function is for options which take a Boolean (bool). The bval is passed to the option.

    @@ -665,36 +665,56 @@ and similar.

    ERRORS

    -
    -
    -
    NNG_ECLOSED
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ECLOSED +

    Parameter s does not refer to an open socket.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The value being passed is invalid.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The option opt is not supported.

    - -
    NNG_EREADONLY
    -
    +
    +NNG_EREADONLY +

    The option opt is read-only.

    - -
    NNG_ESTATE
    -
    +
    +NNG_ESTATE +

    The socket is in an inappropriate state for setting this option.

    - - +

    SEE ALSO

    -
    +

    nng_getopt(3), nng_dialer_setopt(3), nng_listener_setopt(3), diff --git a/man/tip/nng_sleep_aio.3.html b/man/tip/nng_sleep_aio.3.html index 53bc6a9d..84ce3d5d 100644 --- a/man/tip/nng_sleep_aio.3.html +++ b/man/tip/nng_sleep_aio.3.html @@ -576,7 +576,7 @@ then the sleep will wake up early, with a result code of NNG_ETIMEDOUT

    SEE ALSO

    -
    +

    nng_aio_abort(3), nng_aio_alloc(3), nng_aio_set_timeout(3), diff --git a/man/tip/nng_sockaddr.5.html b/man/tip/nng_sockaddr.5.html index 50a61dfb..d5e069a9 100644 --- a/man/tip/nng_sockaddr.5.html +++ b/man/tip/nng_sockaddr.5.html @@ -559,7 +559,7 @@ addresses, IPC paths, and so forth.

    The name sockaddr is based on it’s similarity with POSIX struct sockaddr, -but in the nng library, these addreses are more closely affiliated with +but in the nng library, these addresses are more closely affiliated with instances of nng_pipe than of nng_socket. The naming confusion is unfortunate.

    @@ -568,7 +568,7 @@ The naming confusion is unfortunate.

    This structure is actually a union, with different members for different -types of addreses.

    +types of addresses.

    Every member structure has as its first element a uint16_t field @@ -579,38 +579,57 @@ specific member should be used.

    The values of s_family are as follows:

    -
    -
    -
    NNG_AF_UNSPEC
    -
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_AF_UNSPEC +

    Invalid address, no other valid fields.

    - -
    NNG_AF_INPROC
    -
    -

    Address for intraprocess communication (nng_inproc(7)). -The s_inproc member is valid.

    -
    -
    NNG_AF_IPC
    -
    -

    Address for interprocess communication (nng_ipc(7)). -The s_path member is valid.

    -
    -
    NNG_AF_INET
    -
    -

    Address for TCP/IP (v4) communication. -The s_in member is valid.

    -
    -
    NNG_AF_INET6
    -
    -

    Address for TCP/IP (v6) communication. -The s_in6 member is valid.

    -
    -
    NNG_AF_ZT
    -
    -

    Address for ZeroTier transport (nng_zerotier(7)). -The s_zt member is valid.

    -
    - +
    +NNG_AF_INPROC + +

    Address for intraprocess communication (nng_inproc(7)). The s_inproc member is valid.

    +
    +NNG_AF_IPC + +

    Address for interprocess communication (nng_ipc(7)). The s_path member is valid.

    +
    +NNG_AF_INET + +

    Address for TCP/IP (v4) communication. The s_in member is valid.

    +
    +NNG_AF_INET6 + +

    Address for TCP/IP (v6) communication. The s_in6 member is valid.

    +
    +NNG_AF_ZT + +

    Address for ZeroTier transport (nng_zerotier(7)). The s_zt member is valid.

    +

    Please see the manual pages for each individual type for more information.

    @@ -620,7 +639,7 @@ The s_zt member is valid.

    SEE ALSO

    -
    +

    nng_sockaddr_in(5), nng_sockaddr_in6(5), nng_sockaddr_inproc(5), diff --git a/man/tip/nng_sockaddr_in.5.html b/man/tip/nng_sockaddr_in.5.html index d99f25de..1029e8ab 100644 --- a/man/tip/nng_sockaddr_in.5.html +++ b/man/tip/nng_sockaddr_in.5.html @@ -568,7 +568,7 @@ A zero value here is used when no specific port number is indicated.

    sa_addr
    -

    This field holds the IP addresss in +

    This field holds the IP address in network-byte order.

    @@ -583,7 +583,7 @@ network-byte order.

    The sa_port and sa_addr fields are in network-byte order to facilitate their use with system APIs such as inet_ntop(). Most platforms use some form of BSD-derived network API, which uses -network-byte order in the various structurs (such as sockaddr_in). +network-byte order in the various structures (such as sockaddr_in). @@ -596,7 +596,7 @@ network-byte order in the various structurs (such as sockaddr_in). This field appears similar to BSD sockaddr_in, but it is -not the same, and they may not be used interchangeabley. +not the same, and they may not be used interchangeably. @@ -606,7 +606,7 @@ This field appears similar to BSD sockaddr_in, but it is

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_sockaddr_in6(5), nng_tcp(7), diff --git a/man/tip/nng_sockaddr_in6.5.html b/man/tip/nng_sockaddr_in6.5.html index d7ca0dd7..c2d19594 100644 --- a/man/tip/nng_sockaddr_in6.5.html +++ b/man/tip/nng_sockaddr_in6.5.html @@ -568,7 +568,7 @@ A zero value here is used when no specific port number is indicated.

    sa_addr
    -

    This field holds the IP addresss in +

    This field holds the IP address in network-byte order.

    @@ -583,7 +583,7 @@ network-byte order.

    The sa_port and sa_addr fields are in network-byte order to facilitate their use with system APIs such as inet_ntop(). Most platforms use some form of BSD-derived network API, which uses -network-byte order in the various structurs (such as sockaddr_in6). +network-byte order in the various structures (such as sockaddr_in6). @@ -596,7 +596,7 @@ network-byte order in the various structurs (such as sockaddr_in6). This field appears similar to BSD sockaddr_in6, but it is -not the same, and they may not be used interchangeabley. +not the same, and they may not be used interchangeably. @@ -606,7 +606,7 @@ This field appears similar to BSD sockaddr_in6, but it is

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_sockaddr_in(5), nng_tcp(7), diff --git a/man/tip/nng_sockaddr_inproc.5.html b/man/tip/nng_sockaddr_inproc.5.html index f34d5b8f..9ce936b0 100644 --- a/man/tip/nng_sockaddr_inproc.5.html +++ b/man/tip/nng_sockaddr_inproc.5.html @@ -571,7 +571,7 @@ The string must be NUL terminated, but no other restrictions exist. In order to ensure maximum compatibility, applications should avoid -hard coding the sizeof the sa_name member explicitly, but use the +hard coding the size of the sa_name member explicitly, but use the sizeof operator to determine its actual size at compile time. Furthermore, the size is guaranteed to be at least 128. @@ -583,7 +583,7 @@ Furthermore, the size is guaranteed to be at least 128.

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_inproc(7) nng(7)

    diff --git a/man/tip/nng_sockaddr_ipc.5.html b/man/tip/nng_sockaddr_ipc.5.html index 230b3e5f..3017bedc 100644 --- a/man/tip/nng_sockaddr_ipc.5.html +++ b/man/tip/nng_sockaddr_ipc.5.html @@ -557,11 +557,11 @@ using the ipc transport.

    sa_path
    -

    This field holds the C string corresponding to pathname where the +

    This field holds the C string corresponding to path name where the IPC socket is located. For systems using UNIX domain sockets, this will be an absolute -pathname in the filesystem, where the UNIX domain socket is located. -For Windows systems, this is the pathname of the Named Pipe, without +path name in the file system, where the UNIX domain socket is located. +For Windows systems, this is the path name of the Named Pipe, without the leading \\.pipe\ portion, which will be automatically added.

    @@ -586,7 +586,7 @@ At this time, there is no support for Linux “abstract sockets”. In order to ensure maximum compatibility, applications should avoid -hard coding the sizeof the sa_path member explicitly, but use the +hard coding the size of the sa_path member explicitly, but use the sizeof operator to determine its actual size at compile time. Furthermore, the size is guaranteed to be at least 128, but paths of this length may not be supported on all systems. @@ -615,7 +615,7 @@ longer than 128 bytes, including the ipc:// prefix.

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_ipc(7) nng(7)

    diff --git a/man/tip/nng_sockaddr_zt.5.html b/man/tip/nng_sockaddr_zt.5.html index 8df68768..d3780507 100644 --- a/man/tip/nng_sockaddr_zt.5.html +++ b/man/tip/nng_sockaddr_zt.5.html @@ -574,7 +574,7 @@ are still considered experimental, and subject to change.
    sa_nwid

    -This field holds the ZeroTiero network number (or ID). +This field holds the ZeroTier network number (or ID). This value is in native byte order.

    sa_nodeid
    @@ -618,7 +618,7 @@ the Scalability Protocols binding for them.

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_zerotier(7), nng(7)

    diff --git a/man/tip/nng_socket.5.html b/man/tip/nng_socket.5.html index bae1d018..ee532e96 100644 --- a/man/tip/nng_socket.5.html +++ b/man/tip/nng_socket.5.html @@ -589,7 +589,7 @@ before it is opened, to prevent confusion with valid open sockets.

    SEE ALSO

    -
    +

    libnng(3), nng_close(3), nng_getopt(3), diff --git a/man/tip/nng_socket_id.3.html b/man/tip/nng_socket_id.3.html index 5663994f..46cc3bf4 100644 --- a/man/tip/nng_socket_id.3.html +++ b/man/tip/nng_socket_id.3.html @@ -548,7 +548,7 @@ Otherwise it returns -1.

    A socket is considered valid if it was ever opened with a protocol -constructor, such as the nng_req0_open() function. +constructor, such as the nng_req0_open() function. Sockets that are allocated on the stack or statically should be initialized with the macro NNG_SOCKET_INITIALIZER to ensure that @@ -579,7 +579,7 @@ they cannot be confused with a valid socket before they are opened.

    SEE ALSO

    -
    +

    nng_socket(5), nng(7)

    diff --git a/man/tip/nng_strdup.3.html b/man/tip/nng_strdup.3.html index 8bee2b6d..2b2116c9 100644 --- a/man/tip/nng_strdup.3.html +++ b/man/tip/nng_strdup.3.html @@ -539,7 +539,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_strdup() duplicates the string src and returns it.

    -

    This is logically equiavlent to using nng_alloc() +

    This is logically equivalent to using nng_alloc() to allocate a region of memory of strlen(s) + 1 bytes, and then using strcpy() to copy the string into the destination before returning it.

    @@ -585,7 +585,7 @@ treated the same as NNG_ENOMEM.

    SEE ALSO

    -
    +

    nng_alloc(3), nng_free(3), nng(7)

    diff --git a/man/tip/nng_strerror.3.html b/man/tip/nng_strerror.3.html index df5f1491..15d6ad74 100644 --- a/man/tip/nng_strerror.3.html +++ b/man/tip/nng_strerror.3.html @@ -581,7 +581,7 @@ by a NUL byte.

    SEE ALSO

    -
    +

    libnng(3), nng(7)

    diff --git a/man/tip/nng_strfree.3.html b/man/tip/nng_strfree.3.html index 0036b139..aa74e40f 100644 --- a/man/tip/nng_strfree.3.html +++ b/man/tip/nng_strfree.3.html @@ -594,7 +594,7 @@ case, using the length of the original string plus one for the size.)

    SEE ALSO

    -
    +

    nng_alloc(3), nng_free(3), nng_strdup(3), diff --git a/man/tip/nng_sub.7.html b/man/tip/nng_sub.7.html index c302c10c..709aac57 100644 --- a/man/tip/nng_sub.7.html +++ b/man/tip/nng_sub.7.html @@ -633,7 +633,7 @@ Note that if the topic was not previously subscribed to with

    SEE ALSO

    -
    +

    nng_sub_open(3), nng_pub(7), nng(7)

    diff --git a/man/tip/nng_sub_open.3.html b/man/tip/nng_sub_open.3.html index 036c3444..f8adb985 100644 --- a/man/tip/nng_sub_open.3.html +++ b/man/tip/nng_sub_open.3.html @@ -560,24 +560,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_pub(7), nng_sub(7), diff --git a/man/tip/nng_surveyor.7.html b/man/tip/nng_surveyor.7.html index e31070fc..b92e62c5 100644 --- a/man/tip/nng_surveyor.7.html +++ b/man/tip/nng_surveyor.7.html @@ -649,7 +649,7 @@ version.)

    NNG_OPT_SURVEYOR_SURVEYTIME

    This read/write option is an nng_duration -representing a postive number of milliseconds that following surveys +representing a positive number of milliseconds that following surveys will last. When a new survey is started, a timer of this duration is also started. Any responses arriving this time will be discarded. @@ -670,7 +670,7 @@ There must be at least one identifier, the survey ID, last element in the array, and must have the most significant bit set.

    -

    There may be additional peer IDs preceeding the survey ID. +

    There may be additional peer IDs preceding the survey ID. These will be distinguishable from the survey ID by having their most significant bit clear.

    @@ -709,7 +709,7 @@ survey ID it originally used for the request.

    SEE ALSO

    -
    +

    nng_surveyor_open(3), nng_respondent(7), nng(7)

    diff --git a/man/tip/nng_surveyor_open.3.html b/man/tip/nng_surveyor_open.3.html index ad84842d..1206b17e 100644 --- a/man/tip/nng_surveyor_open.3.html +++ b/man/tip/nng_surveyor_open.3.html @@ -561,24 +561,32 @@ version 0 socket in

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The protocol is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_socket(5), nng_respondent(7), nng_surveyor(7), diff --git a/man/tip/nng_tcp.7.html b/man/tip/nng_tcp.7.html index ee7185fc..5ac7fe68 100644 --- a/man/tip/nng_tcp.7.html +++ b/man/tip/nng_tcp.7.html @@ -696,7 +696,7 @@ The value is of type bool and defaults to true.

    SEE ALSO

    -
    +

    nng_sockaddr(5), nng_sockaddr_in(5), nng_sockaddr_in6(5), diff --git a/man/tip/nng_tcp_register.3.html b/man/tip/nng_tcp_register.3.html index aa7e2ab0..004274bf 100644 --- a/man/tip/nng_tcp_register.3.html +++ b/man/tip/nng_tcp_register.3.html @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_tcp(7), nng(7)

    diff --git a/man/tip/nng_thread_create.3supp.html b/man/tip/nng_thread_create.3supp.html index dbb29b08..1614f73b 100644 --- a/man/tip/nng_thread_create.3supp.html +++ b/man/tip/nng_thread_create.3supp.html @@ -635,20 +635,24 @@ Threads can be synchronized using

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_cv_alloc(3supp), nng_mtx_alloc(3supp), diff --git a/man/tip/nng_thread_destroy.3supp.html b/man/tip/nng_thread_destroy.3supp.html index 08890e40..6f66a349 100644 --- a/man/tip/nng_thread_destroy.3supp.html +++ b/man/tip/nng_thread_destroy.3supp.html @@ -575,7 +575,7 @@ or a deadlock will occur.

    SEE ALSO

    -
    +

    nng_thread_create(3supp), nng(7)

    diff --git a/man/tip/nng_tls.7.html b/man/tip/nng_tls.7.html index 70669dd0..9ba38340 100644 --- a/man/tip/nng_tls.7.html +++ b/man/tip/nng_tls.7.html @@ -802,7 +802,7 @@ more details.

    NNG_OPT_TLS_VERIFIED
    -

    This is a read-only option which returns a boolean value (integer 0 or 1). +

    This is a read-only option which returns a Boolean value (integer 0 or 1). It will true (1) if the remote peer has been properly verified using TLS authentication, or false (0) otherwise. This option may return incorrect @@ -816,7 +816,7 @@ results if peer authentication is disabled with NNG_TLS_AUTH_MODE_NONE

    SEE ALSO

    -
    +

    nng_tls_config_alloc(3tls) nng_sockaddr_in(5), nng_sockaddr_in6(5), diff --git a/man/tip/nng_tls_config_alloc.3tls.html b/man/tip/nng_tls_config_alloc.3tls.html index 2eb7cf64..397465f9 100644 --- a/man/tip/nng_tls_config_alloc.3tls.html +++ b/man/tip/nng_tls_config_alloc.3tls.html @@ -529,8 +529,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b #include <nng/supplemental/tls/tls.h> typedef enum nng_tls_mode { - NNG_TLS_MODE_CLIENT, - NNG_TLS_MODE_SERVER + NNG_TLS_MODE_CLIENT, + NNG_TLS_MODE_SERVER } nng_tls_mode; int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); @@ -554,7 +554,7 @@ depending on the value of mode.

    A TLS object can be further modified by functions that set the security -keys used, peeer certificates, protocol policies, and so forth.

    +keys used, peer certificates, protocol policies, and so forth.

    A single TLS configuration object can be used with multiple TLS streams @@ -581,24 +581,32 @@ further changes to the configuration will result in NNG_EBUSY.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid mode was specified.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_auth_mode(3tls), nng_tls_config_ca_chain(3tls), diff --git a/man/tip/nng_tls_config_auth_mode.3tls.html b/man/tip/nng_tls_config_auth_mode.3tls.html index 0a334897..f7244049 100644 --- a/man/tip/nng_tls_config_auth_mode.3tls.html +++ b/man/tip/nng_tls_config_auth_mode.3tls.html @@ -561,7 +561,7 @@ TLS servers, which most typically do not authenticate their clients.

    If a certificate is presented by the peer, then it is validated. However, if the peer does not present a valid certificate, -then the sesssion is allowed to proceed without authentication.

    +then the session is allowed to proceed without authentication.

    NNG_TLS_AUTH_MODE_REQUIRED
    @@ -585,28 +585,40 @@ This is the default for clients.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid mode was specified.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(3tls), nng_tls_config_ca_chain(3tls), diff --git a/man/tip/nng_tls_config_ca_chain.3tls.html b/man/tip/nng_tls_config_ca_chain.3tls.html index 85709fd8..6fbfb530 100644 --- a/man/tip/nng_tls_config_ca_chain.3tls.html +++ b/man/tip/nng_tls_config_ca_chain.3tls.html @@ -591,28 +591,40 @@ certificate revocation list for the associated authority.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid chain or crl was supplied.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(.3tls), nng_tls_config_auth_mode(.3tls), diff --git a/man/tip/nng_tls_config_ca_file.3tls.html b/man/tip/nng_tls_config_ca_file.3tls.html index 024aa4e7..ec00a725 100644 --- a/man/tip/nng_tls_config_ca_file.3tls.html +++ b/man/tip/nng_tls_config_ca_file.3tls.html @@ -586,36 +586,56 @@ to a configuration, without affecting those added previously.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The contents of path are invalid or do not contain a valid PEM certificate.

    - -
    NNG_ENOENT
    -
    +
    +NNG_ENOENT +

    The file path does not exist.

    - -
    NNG_EPERM
    -
    +
    +NNG_EPERM +

    The file path is not readable.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(3tls), nng_tls_config_auth_mode(3tls), diff --git a/man/tip/nng_tls_config_cert_key_file.3tls.html b/man/tip/nng_tls_config_cert_key_file.3tls.html index e965dff7..dd08454a 100644 --- a/man/tip/nng_tls_config_cert_key_file.3tls.html +++ b/man/tip/nng_tls_config_cert_key_file.3tls.html @@ -574,36 +574,56 @@ to be used for different cryptographic algorithms.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    The contents of path are invalid.

    - -
    NNG_ENOENT
    -
    +
    +NNG_ENOENT +

    The file named by path does not exist.

    - -
    NNG_EPERM
    -
    +
    +NNG_EPERM +

    The file named by path cannot be opened.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(3tls), nng_tls_config_own_cert(3tls), diff --git a/man/tip/nng_tls_config_free.3tls.html b/man/tip/nng_tls_config_free.3tls.html index 0b4eefe1..477a8a83 100644 --- a/man/tip/nng_tls_config_free.3tls.html +++ b/man/tip/nng_tls_config_free.3tls.html @@ -562,7 +562,7 @@ reference count is zero, then deallocates the configuration object.

    SEE ALSO

    -
    +

    nng_tls_config_alloc(3tls), nng(7)

    diff --git a/man/tip/nng_tls_config_own_cert.3tls.html b/man/tip/nng_tls_config_own_cert.3tls.html index 988691f9..1fe4cc79 100644 --- a/man/tip/nng_tls_config_own_cert.3tls.html +++ b/man/tip/nng_tls_config_own_cert.3tls.html @@ -575,28 +575,40 @@ strings containing

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid cert or key was supplied.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(3tls), nng_tls_config_cert_key_file(3tls), diff --git a/man/tip/nng_tls_config_server_name.3tls.html b/man/tip/nng_tls_config_server_name.3tls.html index 3f55b9d8..8dc8ca8d 100644 --- a/man/tip/nng_tls_config_server_name.3tls.html +++ b/man/tip/nng_tls_config_server_name.3tls.html @@ -570,24 +570,32 @@ This function is only useful in configuring client behavior.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_EBUSY
    -
    +
    +NNG_EBUSY +

    The configuration cfg is already in use, and cannot be modified.

    - - +

    SEE ALSO

    -
    +

    nng_strerror(3), nng_tls_config_alloc(3tls), nng_tls_config_auth_mode(3tls), diff --git a/man/tip/nng_tls_register.3.html b/man/tip/nng_tls_register.3.html index 4bf75e36..ce7096d1 100644 --- a/man/tip/nng_tls_register.3.html +++ b/man/tip/nng_tls_register.3.html @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_tls(5), nng(7)

    diff --git a/man/tip/nng_url_clone.3.html b/man/tip/nng_url_clone.3.html index 3df76198..7bcddcc2 100644 --- a/man/tip/nng_url_clone.3.html +++ b/man/tip/nng_url_clone.3.html @@ -553,20 +553,24 @@ This clone includes fully duplicating each of the member fields.

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to duplicate a message.

    - - +

    SEE ALSO

    -
    +

    nng_url_free(3), nng_url_parse(3), nng_strerror(3), diff --git a/man/tip/nng_url_free.3.html b/man/tip/nng_url_free.3.html index 79b1a7ef..8be65ba8 100644 --- a/man/tip/nng_url_free.3.html +++ b/man/tip/nng_url_free.3.html @@ -560,7 +560,7 @@ any of its members.

    SEE ALSO

    -
    +

    nng_url_clone(3), nng_url_parse(3), nng(7)

    diff --git a/man/tip/nng_url_parse.3.html b/man/tip/nng_url_parse.3.html index 9b8849d7..49a4b2f6 100644 --- a/man/tip/nng_url_parse.3.html +++ b/man/tip/nng_url_parse.3.html @@ -555,7 +555,7 @@ is stored in urlp.

    char *u_rawurl; // Unparsed URL, with minimal canonicalization. char *u_userinfo; // Userinfo component, or NULL. char *u_host; // Full host, including port if present. - char *u_hostname; // Hostname only (or address), or empy string. + char *u_hostname; // Hostname only (or address), or empty string. char *u_port; // Port number, may be default or empty string. char *u_path; // Path if present, empty string otherwise. char *u_query; // Query info if present, NULL otherwise. @@ -636,24 +636,32 @@ Only the u_userinfo, u_query, and u_fragment

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient free memory exists to allocate a message.

    - -
    NNG_EINVAL
    -
    +
    +NNG_EINVAL +

    An invalid URL was supplied.

    - - +

    SEE ALSO

    -
    +

    nng_url_clone(3), nng_url_free(3), nng_strerror(3), diff --git a/man/tip/nng_version.3.html b/man/tip/nng_version.3.html index 0c17bdb0..52bdc2db 100644 --- a/man/tip/nng_version.3.html +++ b/man/tip/nng_version.3.html @@ -590,7 +590,7 @@ manner depending upon the link options and how the library is built.)

    SEE ALSO

    -
    +

    libnng(3), nng(7)

    diff --git a/man/tip/nng_ws.7.html b/man/tip/nng_ws.7.html index ce84b417..e1891869 100644 --- a/man/tip/nng_ws.7.html +++ b/man/tip/nng_ws.7.html @@ -762,7 +762,7 @@ results if peer authentication is disabled with NNG_TLS_AUTH_MODE_NONE

    SEE ALSO

    -
    +

    nng_tls_config_alloc(3tls), nng_sockaddr(5), nng_sockaddr_in(5), diff --git a/man/tip/nng_ws_register.3.html b/man/tip/nng_ws_register.3.html index 9b1ec9ba..0a97e66c 100644 --- a/man/tip/nng_ws_register.3.html +++ b/man/tip/nng_ws_register.3.html @@ -516,7 +516,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    NAME

    -

    nng_ws_register - register websocket transport

    +

    nng_ws_register - register WebSocket transport

    @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_ws(7), nng(7)

    diff --git a/man/tip/nng_wss_register.3.html b/man/tip/nng_wss_register.3.html index ac4890a6..cbd170b4 100644 --- a/man/tip/nng_wss_register.3.html +++ b/man/tip/nng_wss_register.3.html @@ -516,7 +516,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    NAME

    -

    nng_ws_register - register websocket secure transport

    +

    nng_ws_register - register WebSocket secure transport

    @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    + + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_ws(7), nng(7)

    diff --git a/man/tip/nng_zerotier.7.html b/man/tip/nng_zerotier.7.html index 918cc071..c458c513 100644 --- a/man/tip/nng_zerotier.7.html +++ b/man/tip/nng_zerotier.7.html @@ -731,7 +731,7 @@ can store (and reuse) persistent state, such as key materials, node identity, and federation membership. This option must be set before the ZeroTier transport is first used. If this value is empty, then an ephemeral ZeroTier node is created, -nd no persistent state is used. +and no persistent state is used. The default is to use an ephemeral node.

    @@ -867,7 +867,7 @@ this has no effect.

    SEE ALSO

    -
    +

    nng_sockaddr_zt(5), nng(7)

    diff --git a/man/tip/nng_zt_register.3.html b/man/tip/nng_zt_register.3.html index 4dbce020..3614c7f4 100644 --- a/man/tip/nng_zt_register.3.html +++ b/man/tip/nng_zt_register.3.html @@ -552,24 +552,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    ERRORS

    -
    -
    -
    NNG_ENOMEM
    -
    +
    +
    + + + + + + + + +
    +NNG_ENOMEM +

    Insufficient memory is available.

    - -
    NNG_ENOTSUP
    -
    +
    +NNG_ENOTSUP +

    The transport is not supported.

    - - +

    SEE ALSO

    -
    +

    nng_zerotier(7), nng(7)

    diff --git a/man/tip/nngcat.1.html b/man/tip/nngcat.1.html index e6dc7946..e4874d10 100644 --- a/man/tip/nngcat.1.html +++ b/man/tip/nngcat.1.html @@ -526,7 +526,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    NAME

    -

    nngcat - command line access to Scalabity Protocols

    +

    nngcat - command line access to Scalability Protocols

    @@ -706,7 +706,7 @@ messages from push version 0 peers.

    --pair0
    -

    Select the pair veresion 0 protocol. +

    Select the pair version 0 protocol. This protocol can send and receive messages with one connected pair version 0 peer.

    @@ -733,7 +733,7 @@ version 0 peers, and then receives replies from them.

    --respondent, --respondent0

    Select the respondent version 0 protocol. -This protocol receives survey requests from <nng_surveyor.7#,surveyor>> +This protocol receives survey requests from surveyor version 0 peers, and can send a reply to them.

    @@ -802,48 +802,12 @@ as --connect=tcp://127.0.0.1:PORT.

    Receive Options

    -

    Data messages received can be formatted in different ways. These -options can only be specified when using a protocol that receives messages.

    +

    Data messages received can be formatted in different ways. +These options can only be specified when using a protocol that +receives messages.

    -
    --format=FORMAT
    -
    -

    Format data as indicated. The FORMAT can be any of:

    -
    -
    -
    no
    -
    -

    No output at all.

    -
    -
    raw
    -
    -

    Raw output, every byte received is sent to standard output.

    -
    -
    ascii
    -
    -

    ASCII safe, printable ASCII is emitted verbatim, with other bytes -substituted with . (period).

    -
    -
    quoted
    -
    -

    Messages are printed as quoted strings, using C language conventions.

    -
    -
    hex
    -
    -

    Messages are printed as quoted strings, with every byte appearing -as an escaped hexadecimal value, such as \x2E.

    -
    -
    msgpack
    -
    -

    - -Messages are emitted as MessagePack "bin format" -(byte arrays).

    -
    -
    -
    -
    -A, --ascii

    The same as specifying --format=ascii.

    @@ -876,6 +840,42 @@ Messages larger than this will be discarded. The default is 1048576 (1 MB). To eliminate any restriction, use 0.

    +
    --format=FORMAT
    +
    +

    Format data as indicated. The FORMAT can be any of:

    +
    +
    +
    no
    +
    +

    No output at all.

    +
    +
    raw
    +
    +

    Raw output, every byte received is sent to standard output.

    +
    +
    ascii
    +
    +

    ASCII safe, printable ASCII is emitted verbatim, with other +bytes substituted with . (period).

    +
    +
    quoted
    +
    +

    Messages are printed as quoted strings, using C language +conventions.

    +
    +
    hex
    +
    +

    Messages are printed as quoted strings, with every byte appearing as an escaped hexadecimal value, such as \x2E.

    +
    +
    msgpack
    +
    +

    +Messages are emitted as MessagePack "bin format" +(byte arrays).

    +
    +
    +
    +
    @@ -932,7 +932,7 @@ when using addresses that are not secured with TLS.

    --key=FILE

    Load own key from FILE. -Should be used in conjuction with --cert. +Should be used in conjunction with --cert. If not specified, and --cert is specified, then a single file containing both the private key and the associated certificate is assumed.

    @@ -992,7 +992,7 @@ $ nngcat --sub --dial=${<

    SEE ALSO

    -
    +

    libnng(3), nng(7), nng_bus(7), -- cgit v1.2.3-70-g09d2