From bff4599ecd97ea28e1e2016fedf6cc1d53beda5c Mon Sep 17 00:00:00 2001 From: "Staysail Systems, Inc." Date: Thu, 14 Sep 2023 00:24:50 -0700 Subject: Manual page updates for tip --- man/tip/_toc.html | 6 + man/tip/index.html | 30 ++- man/tip/libnng.3.html | 31 ++- man/tip/nn_allocmsg.3compat.html | 7 +- man/tip/nn_bind.3compat.html | 7 +- man/tip/nn_close.3compat.html | 5 +- man/tip/nn_cmsg.3compat.html | 7 +- man/tip/nn_connect.3compat.html | 7 +- man/tip/nn_device.3compat.html | 5 +- man/tip/nn_errno.3compat.html | 5 +- man/tip/nn_freemsg.3compat.html | 5 +- man/tip/nn_get_statistic.3compat.html | 7 +- man/tip/nn_getsockopt.3compat.html | 7 +- man/tip/nn_poll.3compat.html | 15 +- man/tip/nn_reallocmsg.3compat.html | 7 +- man/tip/nn_recv.3compat.html | 7 +- man/tip/nn_recvmsg.3compat.html | 9 +- man/tip/nn_send.3compat.html | 9 +- man/tip/nn_sendmsg.3compat.html | 9 +- man/tip/nn_setsockopt.3compat.html | 7 +- man/tip/nn_shutdown.3compat.html | 7 +- man/tip/nn_socket.3compat.html | 5 +- man/tip/nn_strerror.3compat.html | 5 +- man/tip/nn_term.3compat.html | 5 +- man/tip/nng.7.html | 20 +- man/tip/nng_aio.5.html | 5 +- man/tip/nng_aio_abort.3.html | 5 +- man/tip/nng_aio_alloc.3.html | 23 ++- man/tip/nng_aio_begin.3.html | 5 +- man/tip/nng_aio_busy.3.html | 87 ++++++++ man/tip/nng_aio_cancel.3.html | 5 +- man/tip/nng_aio_count.3.html | 9 +- man/tip/nng_aio_defer.3.html | 5 +- man/tip/nng_aio_finish.3.html | 5 +- man/tip/nng_aio_free.3.html | 25 ++- man/tip/nng_aio_get_input.3.html | 5 +- man/tip/nng_aio_get_msg.3.html | 5 +- man/tip/nng_aio_get_output.3.html | 5 +- man/tip/nng_aio_result.3.html | 5 +- man/tip/nng_aio_set_input.3.html | 5 +- man/tip/nng_aio_set_iov.3.html | 9 +- man/tip/nng_aio_set_msg.3.html | 5 +- man/tip/nng_aio_set_output.3.html | 5 +- man/tip/nng_aio_set_timeout.3.html | 9 +- man/tip/nng_aio_stop.3.html | 5 +- man/tip/nng_aio_wait.3.html | 8 +- man/tip/nng_alloc.3.html | 7 +- man/tip/nng_bus.7.html | 1 + man/tip/nng_bus_open.3.html | 7 +- man/tip/nng_clock.3supp.html | 9 +- man/tip/nng_close.3.html | 5 +- man/tip/nng_compat.3compat.html | 241 +++++++--------------- man/tip/nng_ctx.5.html | 47 +++-- man/tip/nng_ctx_close.3.html | 5 +- man/tip/nng_ctx_get.3.html | 11 +- man/tip/nng_ctx_getopt.3.html | 16 +- man/tip/nng_ctx_id.3.html | 5 +- man/tip/nng_ctx_open.3.html | 5 +- man/tip/nng_ctx_recv.3.html | 5 +- man/tip/nng_ctx_recvmsg.3.html | 148 +++++++++++++ man/tip/nng_ctx_send.3.html | 5 +- man/tip/nng_ctx_sendmsg.3.html | 187 +++++++++++++++++ man/tip/nng_ctx_set.3.html | 11 +- man/tip/nng_ctx_setopt.3.html | 16 +- man/tip/nng_cv_alloc.3supp.html | 7 +- man/tip/nng_cv_free.3supp.html | 7 +- man/tip/nng_cv_until.3supp.html | 28 +-- man/tip/nng_cv_wait.3supp.html | 24 ++- man/tip/nng_cv_wake.3supp.html | 7 +- man/tip/nng_cv_wake1.3supp.html | 7 +- man/tip/nng_device.3.html | 25 ++- man/tip/nng_dial.3.html | 5 +- man/tip/nng_dialer.5.html | 5 +- man/tip/nng_dialer_close.3.html | 5 +- man/tip/nng_dialer_create.3.html | 5 +- man/tip/nng_dialer_get.3.html | 14 +- man/tip/nng_dialer_getopt.3.html | 19 +- man/tip/nng_dialer_id.3.html | 5 +- man/tip/nng_dialer_set.3.html | 16 +- man/tip/nng_dialer_setopt.3.html | 16 +- man/tip/nng_dialer_start.3.html | 5 +- man/tip/nng_duration.5.html | 19 +- man/tip/nng_free.3.html | 9 +- man/tip/nng_getopt.3.html | 16 +- man/tip/nng_http_client_alloc.3http.html | 7 +- man/tip/nng_http_client_connect.3http.html | 32 +-- man/tip/nng_http_client_free.3http.html | 7 +- man/tip/nng_http_client_get_tls.3http.html | 7 +- man/tip/nng_http_client_set_tls.3http.html | 7 +- man/tip/nng_http_client_transact.3http.html | 7 +- man/tip/nng_http_conn_close.3http.html | 7 +- man/tip/nng_http_conn_read.3http.html | 7 +- man/tip/nng_http_conn_read_all.3http.html | 7 +- man/tip/nng_http_conn_read_req.3http.html | 7 +- man/tip/nng_http_conn_read_res.3http.html | 7 +- man/tip/nng_http_conn_transact.3http.html | 7 +- man/tip/nng_http_conn_write.3http.html | 7 +- man/tip/nng_http_conn_write_all.3http.html | 7 +- man/tip/nng_http_conn_write_req.3http.html | 7 +- man/tip/nng_http_conn_write_res.3http.html | 7 +- man/tip/nng_http_handler_alloc.3http.html | 13 +- man/tip/nng_http_handler_collect_body.3http.html | 9 +- man/tip/nng_http_handler_free.3http.html | 7 +- man/tip/nng_http_handler_get_data.3http.html | 7 +- man/tip/nng_http_handler_set_data.3http.html | 7 +- man/tip/nng_http_handler_set_host.3http.html | 7 +- man/tip/nng_http_handler_set_method.3http.html | 15 +- man/tip/nng_http_handler_set_tree.3http.html | 7 +- man/tip/nng_http_hijack.3http.html | 7 +- man/tip/nng_http_req_add_header.3http.html | 7 +- man/tip/nng_http_req_alloc.3http.html | 7 +- man/tip/nng_http_req_copy_data.3http.html | 9 +- man/tip/nng_http_req_del_header.3http.html | 7 +- man/tip/nng_http_req_free.3http.html | 7 +- man/tip/nng_http_req_get_data.3http.html | 9 +- man/tip/nng_http_req_get_header.3http.html | 7 +- man/tip/nng_http_req_get_method.3http.html | 9 +- man/tip/nng_http_req_get_uri.3http.html | 7 +- man/tip/nng_http_req_get_version.3http.html | 9 +- man/tip/nng_http_req_reset.3http.html | 7 +- man/tip/nng_http_req_set_data.3http.html | 9 +- man/tip/nng_http_req_set_header.3http.html | 7 +- man/tip/nng_http_req_set_method.3http.html | 11 +- man/tip/nng_http_req_set_uri.3http.html | 7 +- man/tip/nng_http_req_set_version.3http.html | 13 +- man/tip/nng_http_res_add_header.3http.html | 7 +- man/tip/nng_http_res_alloc.3http.html | 7 +- man/tip/nng_http_res_alloc_error.3http.html | 11 +- man/tip/nng_http_res_copy_data.3http.html | 9 +- man/tip/nng_http_res_del_header.3http.html | 7 +- man/tip/nng_http_res_free.3http.html | 7 +- man/tip/nng_http_res_get_data.3http.html | 9 +- man/tip/nng_http_res_get_header.3http.html | 7 +- man/tip/nng_http_res_get_reason.3http.html | 7 +- man/tip/nng_http_res_get_status.3http.html | 9 +- man/tip/nng_http_res_get_version.3http.html | 9 +- man/tip/nng_http_res_reset.3http.html | 7 +- man/tip/nng_http_res_set_data.3http.html | 9 +- man/tip/nng_http_res_set_header.3http.html | 7 +- man/tip/nng_http_res_set_reason.3http.html | 7 +- man/tip/nng_http_res_set_status.3http.html | 9 +- man/tip/nng_http_res_set_version.3http.html | 13 +- man/tip/nng_http_server_add_handler.3http.html | 7 +- man/tip/nng_http_server_del_handler.3http.html | 7 +- man/tip/nng_http_server_get_addr.3http.html | 7 +- man/tip/nng_http_server_get_tls.3http.html | 7 +- man/tip/nng_http_server_hold.3http.html | 7 +- man/tip/nng_http_server_release.3http.html | 9 +- man/tip/nng_http_server_res_error.3http.html | 11 +- man/tip/nng_http_server_set_error_file.3http.html | 9 +- man/tip/nng_http_server_set_error_page.3http.html | 9 +- man/tip/nng_http_server_set_tls.3http.html | 7 +- man/tip/nng_http_server_start.3http.html | 7 +- man/tip/nng_http_server_stop.3http.html | 7 +- man/tip/nng_inproc.7.html | 5 +- man/tip/nng_inproc_register.3.html | 18 +- man/tip/nng_iov.5.html | 9 +- man/tip/nng_ipc.7.html | 7 +- man/tip/nng_ipc_options.5.html | 29 +-- man/tip/nng_ipc_register.3.html | 18 +- man/tip/nng_listen.3.html | 7 +- man/tip/nng_listener.5.html | 5 +- man/tip/nng_listener_close.3.html | 5 +- man/tip/nng_listener_create.3.html | 5 +- man/tip/nng_listener_get.3.html | 14 +- man/tip/nng_listener_getopt.3.html | 20 +- man/tip/nng_listener_id.3.html | 5 +- man/tip/nng_listener_set.3.html | 16 +- man/tip/nng_listener_setopt.3.html | 22 +- man/tip/nng_listener_start.3.html | 5 +- man/tip/nng_msg.5.html | 7 +- man/tip/nng_msg_alloc.3.html | 9 +- man/tip/nng_msg_append.3.html | 13 +- man/tip/nng_msg_body.3.html | 7 +- man/tip/nng_msg_capacity.3.html | 64 ++++++ man/tip/nng_msg_chop.3.html | 15 +- man/tip/nng_msg_clear.3.html | 5 +- man/tip/nng_msg_dup.3.html | 7 +- man/tip/nng_msg_free.3.html | 5 +- man/tip/nng_msg_get_pipe.3.html | 5 +- man/tip/nng_msg_header.3.html | 5 +- man/tip/nng_msg_header_append.3.html | 13 +- man/tip/nng_msg_header_chop.3.html | 13 +- man/tip/nng_msg_header_clear.3.html | 5 +- man/tip/nng_msg_header_insert.3.html | 15 +- man/tip/nng_msg_header_len.3.html | 7 +- man/tip/nng_msg_header_trim.3.html | 13 +- man/tip/nng_msg_insert.3.html | 13 +- man/tip/nng_msg_len.3.html | 7 +- man/tip/nng_msg_realloc.3.html | 24 +-- man/tip/nng_msg_reserve.3.html | 109 ++++++++++ man/tip/nng_msg_set_pipe.3.html | 5 +- man/tip/nng_msg_trim.3.html | 13 +- man/tip/nng_msleep.3supp.html | 7 +- man/tip/nng_mtx_alloc.3supp.html | 7 +- man/tip/nng_mtx_free.3supp.html | 7 +- man/tip/nng_mtx_lock.3supp.html | 7 +- man/tip/nng_mtx_unlock.3supp.html | 7 +- man/tip/nng_options.5.html | 113 ++++++---- man/tip/nng_opts_parse.3supp.html | 59 +++--- man/tip/nng_pair.7.html | 9 +- man/tip/nng_pair_open.3.html | 9 +- man/tip/nng_pipe.5.html | 7 +- man/tip/nng_pipe_close.3.html | 5 +- man/tip/nng_pipe_dialer.3.html | 5 +- man/tip/nng_pipe_get.3.html | 11 +- man/tip/nng_pipe_getopt.3.html | 11 +- man/tip/nng_pipe_id.3.html | 5 +- man/tip/nng_pipe_listener.3.html | 5 +- man/tip/nng_pipe_notify.3.html | 5 +- man/tip/nng_pipe_socket.3.html | 5 +- man/tip/nng_pub.7.html | 1 + man/tip/nng_pub_open.3.html | 7 +- man/tip/nng_pull.7.html | 1 + man/tip/nng_pull_open.3.html | 7 +- man/tip/nng_push.7.html | 27 ++- man/tip/nng_push_open.3.html | 7 +- man/tip/nng_random.3supp.html | 9 +- man/tip/nng_recv.3.html | 31 +-- man/tip/nng_recv_aio.3.html | 5 +- man/tip/nng_recvmsg.3.html | 12 +- man/tip/nng_rep.7.html | 1 + man/tip/nng_rep_open.3.html | 7 +- man/tip/nng_req.7.html | 15 +- man/tip/nng_req_open.3.html | 7 +- man/tip/nng_respondent.7.html | 1 + man/tip/nng_respondent_open.3.html | 7 +- man/tip/nng_send.3.html | 31 +-- man/tip/nng_send_aio.3.html | 5 +- man/tip/nng_sendmsg.3.html | 17 +- man/tip/nng_setopt.3.html | 16 +- man/tip/nng_sleep_aio.3.html | 5 +- man/tip/nng_sockaddr.5.html | 7 +- man/tip/nng_sockaddr_abstract.5.html | 9 +- man/tip/nng_sockaddr_in.5.html | 15 +- man/tip/nng_sockaddr_in6.5.html | 25 +-- man/tip/nng_sockaddr_inproc.5.html | 11 +- man/tip/nng_sockaddr_ipc.5.html | 7 +- man/tip/nng_sockaddr_zt.5.html | 40 ++-- man/tip/nng_socket.5.html | 5 +- man/tip/nng_socket_get.3.html | 29 ++- man/tip/nng_socket_id.3.html | 5 +- man/tip/nng_socket_set.3.html | 31 ++- man/tip/nng_stat.5.html | 5 +- man/tip/nng_stat_bool.3.html | 68 ++++++ man/tip/nng_stat_child.3.html | 5 +- man/tip/nng_stat_desc.3.html | 5 +- man/tip/nng_stat_find.3.html | 5 +- man/tip/nng_stat_find_dialer.3.html | 5 +- man/tip/nng_stat_find_listener.3.html | 5 +- man/tip/nng_stat_find_socket.3.html | 5 +- man/tip/nng_stat_name.3.html | 7 +- man/tip/nng_stat_next.3.html | 5 +- man/tip/nng_stat_string.3.html | 18 +- man/tip/nng_stat_timestamp.3.html | 7 +- man/tip/nng_stat_type.3.html | 5 +- man/tip/nng_stat_unit.3.html | 5 +- man/tip/nng_stat_value.3.html | 16 +- man/tip/nng_stats_free.3.html | 5 +- man/tip/nng_stats_get.3.html | 7 +- man/tip/nng_strdup.3.html | 7 +- man/tip/nng_stream.5.html | 5 +- man/tip/nng_stream_close.3str.html | 5 +- man/tip/nng_stream_dialer.5.html | 5 +- man/tip/nng_stream_dialer_alloc.3str.html | 7 +- man/tip/nng_stream_dialer_close.3str.html | 5 +- man/tip/nng_stream_dialer_dial.3str.html | 5 +- man/tip/nng_stream_dialer_free.3str.html | 5 +- man/tip/nng_stream_dialer_get.3str.html | 13 +- man/tip/nng_stream_dialer_set.3str.html | 11 +- man/tip/nng_stream_free.3str.html | 5 +- man/tip/nng_stream_get.3str.html | 13 +- man/tip/nng_stream_listener.5.html | 5 +- man/tip/nng_stream_listener_accept.3str.html | 5 +- man/tip/nng_stream_listener_alloc.3str.html | 7 +- man/tip/nng_stream_listener_close.3str.html | 5 +- man/tip/nng_stream_listener_free.3str.html | 5 +- man/tip/nng_stream_listener_get.3str.html | 13 +- man/tip/nng_stream_listener_listen.3str.html | 5 +- man/tip/nng_stream_listener_set.3str.html | 11 +- man/tip/nng_stream_recv.3str.html | 5 +- man/tip/nng_stream_send.3str.html | 5 +- man/tip/nng_stream_set.3str.html | 11 +- man/tip/nng_strerror.3.html | 5 +- man/tip/nng_strfree.3.html | 7 +- man/tip/nng_sub.7.html | 25 +-- man/tip/nng_sub_open.3.html | 7 +- man/tip/nng_surveyor.7.html | 17 +- man/tip/nng_surveyor_open.3.html | 7 +- man/tip/nng_tcp.7.html | 5 +- man/tip/nng_tcp_options.5.html | 13 +- man/tip/nng_tcp_register.3.html | 18 +- man/tip/nng_thread_create.3supp.html | 7 +- man/tip/nng_thread_destroy.3supp.html | 7 +- man/tip/nng_thread_set_name.3supp.html | 9 +- man/tip/nng_tls.7.html | 37 ++-- man/tip/nng_tls_config.5.html | 5 +- man/tip/nng_tls_config_alloc.3tls.html | 7 +- man/tip/nng_tls_config_auth_mode.3tls.html | 7 +- man/tip/nng_tls_config_ca_chain.3tls.html | 7 +- man/tip/nng_tls_config_ca_file.3tls.html | 7 +- man/tip/nng_tls_config_cert_key_file.3tls.html | 7 +- man/tip/nng_tls_config_free.3tls.html | 7 +- man/tip/nng_tls_config_hold.3tls.html | 7 +- man/tip/nng_tls_config_own_cert.3tls.html | 7 +- man/tip/nng_tls_config_server_name.3tls.html | 7 +- man/tip/nng_tls_config_version.3tls.html | 7 +- man/tip/nng_tls_engine.5.html | 7 +- man/tip/nng_tls_engine_description.3tls.html | 7 +- man/tip/nng_tls_engine_fips_mode.3tls.html | 5 +- man/tip/nng_tls_engine_name.3tls.html | 7 +- man/tip/nng_tls_options.5.html | 43 ++-- man/tip/nng_tls_register.3.html | 5 +- man/tip/nng_url.5.html | 7 +- man/tip/nng_url_clone.3.html | 5 +- man/tip/nng_url_free.3.html | 5 +- man/tip/nng_url_parse.3.html | 25 +-- man/tip/nng_version.3.html | 7 +- man/tip/nng_ws.7.html | 18 +- man/tip/nng_ws_register.3.html | 18 +- man/tip/nng_wss_register.3.html | 18 +- man/tip/nng_zerotier.7.html | 71 ++++--- man/tip/nng_zt_register.3.html | 18 +- man/tip/nngcat.1.html | 134 ++++++------ 324 files changed, 2747 insertions(+), 1521 deletions(-) create mode 100644 man/tip/nng_aio_busy.3.html create mode 100644 man/tip/nng_ctx_recvmsg.3.html create mode 100644 man/tip/nng_ctx_sendmsg.3.html create mode 100644 man/tip/nng_msg_capacity.3.html create mode 100644 man/tip/nng_msg_reserve.3.html create mode 100644 man/tip/nng_stat_bool.3.html diff --git a/man/tip/_toc.html b/man/tip/_toc.html index c2135fc8..c788149d 100644 --- a/man/tip/_toc.html +++ b/man/tip/_toc.html @@ -14,6 +14,7 @@
  • nng_aio_abort
  • nng_aio_alloc
  • nng_aio_begin
  • +
  • nng_aio_busy
  • nng_aio_cancel
  • nng_aio_count
  • nng_aio_defer
  • @@ -39,7 +40,9 @@
  • nng_ctx_id
  • nng_ctx_open
  • nng_ctx_recv
  • +
  • nng_ctx_recvmsg
  • nng_ctx_send
  • +
  • nng_ctx_sendmsg
  • nng_ctx_set
  • nng_ctx_setopt
  • nng_device
  • @@ -68,6 +71,7 @@
  • nng_msg_alloc
  • nng_msg_append
  • nng_msg_body
  • +
  • nng_msg_capacity
  • nng_msg_chop
  • nng_msg_clear
  • nng_msg_dup
  • @@ -83,6 +87,7 @@
  • nng_msg_insert
  • nng_msg_len
  • nng_msg_realloc
  • +
  • nng_msg_reserve
  • nng_msg_set_pipe
  • nng_msg_trim
  • nng_pair_open
  • @@ -111,6 +116,7 @@
  • nng_socket_get
  • nng_socket_id
  • nng_socket_set
  • +
  • nng_stat_bool
  • nng_stat_child
  • nng_stat_desc
  • nng_stat_find
  • diff --git a/man/tip/index.html b/man/tip/index.html index 5829d252..5492cbae 100644 --- a/man/tip/index.html +++ b/man/tip/index.html @@ -59,6 +59,10 @@ primary API for building such applications.

    begin asynchronous I/O operation

    +

    nng_aio_busy(3)

    +

    test if asynchronous I/O is busy

    + +

    nng_aio_cancel(3)

    cancel asynchronous I/O operation

    @@ -159,10 +163,18 @@ primary API for building such applications.

    receive message using context asynchronously

    +

    nng_ctx_recvmsg(3)

    +

    receive message using socket

    + +

    nng_ctx_send(3)

    send message using context asynchronously

    +

    nng_ctx_sendmsg(3)

    +

    send message using context

    + +

    nng_ctx_set(3)

    set context option

    @@ -275,6 +287,10 @@ primary API for building such applications.

    return message body

    +

    nng_msg_capacity(3)

    +

    return message body length

    + +

    nng_msg_chop(3)

    remove data from end of message body

    @@ -335,6 +351,10 @@ primary API for building such applications.

    reallocate a message

    +

    nng_msg_reserve(3)

    +

    reserve storage for a message

    + +

    nng_msg_set_pipe(3)

    set pipe for message

    @@ -400,7 +420,7 @@ primary API for building such applications.

    nng_recvmsg(3)

    -

    recv message

    +

    receive a message

    nng_rep_open(3)

    @@ -447,6 +467,10 @@ primary API for building such applications.

    set socket option

    +

    nng_stat_bool(3)

    +

    get statistic Boolean value

    + +

    nng_stat_child(3)

    get child statistic

    @@ -496,7 +520,7 @@ primary API for building such applications.

    nng_stat_value(3)

    -

    get statistic value

    +

    get statistic numeric value

    nng_stats_free(3)

    @@ -1230,7 +1254,7 @@ additional support was present and enabled with libnng was built.

    -Contact Staysail Systems, Inc. for +Contact Staysail Systems for details about commercially available options, including support for FIPS 140-2 validated cryptography and TLS v1.3. diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index 99c4ec95..c5c31fae 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: libnng(3) ---

    libnng(3)

    @@ -271,6 +272,10 @@ Most applications will only interact with the body.

    return message body

    +

    nng_msg_capacity()

    +

    return capacity allocated for message body

    + +

    nng_msg_chop()

    remove data from end of message body

    @@ -303,6 +308,10 @@ Most applications will only interact with the body.

    reallocate a message

    +

    nng_msg_reserve()

    +

    reserve storage for message body

    + +

    nng_msg_set_pipe()

    set pipe for message

    @@ -431,6 +440,10 @@ Only a single asynchronous operation may be associated with an

    begin asynchronous I/O operation

    +

    nng_aio_busy()

    +

    test if asynchronous I/O is busy

    + +

    nng_aio_cancel()

    cancel asynchronous I/O operation

    @@ -463,6 +476,10 @@ Only a single asynchronous operation may be associated with an

    return output result

    +

    nng_aio_reap()

    +

    reap asynchronous I/O handle

    + +

    nng_aio_result()

    return result of asynchronous operation

    @@ -644,10 +661,18 @@ concurrent applications.

    receive message using context asynchronously

    +

    nng_ctx_recvmsg()

    +

    receive a message using context

    + +

    nng_ctx_send()

    send message using context asynchronously

    +

    nng_ctx_sendmsg()

    +

    send a message using context

    + +

    nng_ctx_set()

    set context option

    @@ -671,6 +696,10 @@ to observe program behaviors and as an aid in troubleshooting.

    +

    nng_stat_bool()

    +

    get statistic Boolean value

    + +

    nng_stat_child()

    get child statistic

    @@ -720,7 +749,7 @@ to observe program behaviors and as an aid in troubleshooting.

    nng_stat_value()

    -

    get statistic value

    +

    get statistic numeric value

    nng_stats_free()

    diff --git a/man/tip/nn_allocmsg.3compat.html b/man/tip/nn_allocmsg.3compat.html index b0d09673..4f388ac3 100644 --- a/man/tip/nn_allocmsg.3compat.html +++ b/man/tip/nn_allocmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_allocmsg(3compat) ---

    nn_allocmsg(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -void *nn_allocmsg(size_t size, int type);
    +
    #include <nanomsg/nn.h>
    +
    +void *nn_allocmsg(size_t size, int type);
    diff --git a/man/tip/nn_bind.3compat.html b/man/tip/nn_bind.3compat.html index 12e82146..65215ba4 100644 --- a/man/tip/nn_bind.3compat.html +++ b/man/tip/nn_bind.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_bind(3compat) ---

    nn_bind(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_bind(int sock, const char *url)
    +
    #include <nanomsg/nn.h>
    +
    +int nn_bind(int sock, const char *url)
    diff --git a/man/tip/nn_close.3compat.html b/man/tip/nn_close.3compat.html index 6070a7c4..5d0abc92 100644 --- a/man/tip/nn_close.3compat.html +++ b/man/tip/nn_close.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_close(3compat) ---

    nn_close(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_close(int sock);
    diff --git a/man/tip/nn_cmsg.3compat.html b/man/tip/nn_cmsg.3compat.html index 7527aeba..d2073382 100644 --- a/man/tip/nn_cmsg.3compat.html +++ b/man/tip/nn_cmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_cmsg(3compat) ---

    nn_cmsg(3compat)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     struct nn_cmsghdr {
    -    size_t cmsg_len;
    +    size_t cmsg_len;
         int    cmsg_level;
         int    cmsg_type;
     };
    diff --git a/man/tip/nn_connect.3compat.html b/man/tip/nn_connect.3compat.html index f26f22ea..673affaf 100644 --- a/man/tip/nn_connect.3compat.html +++ b/man/tip/nn_connect.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_connect(3compat) ---

    nn_connect(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_connect(int sock, const char *url)
    +
    #include <nanomsg/nn.h>
    +
    +int nn_connect(int sock, const char *url)
    diff --git a/man/tip/nn_device.3compat.html b/man/tip/nn_device.3compat.html index 9e760c05..0f333eb5 100644 --- a/man/tip/nn_device.3compat.html +++ b/man/tip/nn_device.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_device(3compat) ---

    nn_device(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_device(int sock1, int sock2);
    diff --git a/man/tip/nn_errno.3compat.html b/man/tip/nn_errno.3compat.html index 98d38740..cb13b3e8 100644 --- a/man/tip/nn_errno.3compat.html +++ b/man/tip/nn_errno.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_errno(3compat) ---

    nn_errno(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_errno(void);
    diff --git a/man/tip/nn_freemsg.3compat.html b/man/tip/nn_freemsg.3compat.html index 7692fd38..11a3b7a4 100644 --- a/man/tip/nn_freemsg.3compat.html +++ b/man/tip/nn_freemsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_freemsg(3compat) ---

    nn_freemsg(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_freemsg(void *msg);
    diff --git a/man/tip/nn_get_statistic.3compat.html b/man/tip/nn_get_statistic.3compat.html index e9479612..7cca59ba 100644 --- a/man/tip/nn_get_statistic.3compat.html +++ b/man/tip/nn_get_statistic.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_get_statistic(3compat) ---

    nn_get_statistic(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -uint64_t nn_get_statistic(int sock, int stat);
    +
    #include <nanomsg/nn.h>
    +
    +uint64_t nn_get_statistic(int sock, int stat);
    diff --git a/man/tip/nn_getsockopt.3compat.html b/man/tip/nn_getsockopt.3compat.html index ffa090d8..09e40919 100644 --- a/man/tip/nn_getsockopt.3compat.html +++ b/man/tip/nn_getsockopt.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_getsockopt(3compat) ---

    nn_getsockopt(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_getsockopt(int sock, int level, int option, void *val, size_t *szp);
    +
    #include <nanomsg/nn.h>
    +
    +int nn_getsockopt(int sock, int level, int option, void *val, size_t *szp);
    diff --git a/man/tip/nn_poll.3compat.html b/man/tip/nn_poll.3compat.html index bbe2873c..c420c6e2 100644 --- a/man/tip/nn_poll.3compat.html +++ b/man/tip/nn_poll.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_poll(3compat) ---

    nn_poll(3compat)

    @@ -16,15 +17,15 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -#define NN_POLLIN  1
    -#define NN_POLLOUT 2
    -
    +
    #include <nanomsg/nn.h>
    +
    +#define NN_POLLIN  1
    +#define NN_POLLOUT 2
    +
     struct nn_pollfd {
         int      fd;
    -    uint16_t events;
    -    uint16_t revents;
    +    uint16_t events;
    +    uint16_t revents;
     };
     
     int nn_poll(struct nn_pollfd *pfds, int npfd, int timeout);
    diff --git a/man/tip/nn_reallocmsg.3compat.html b/man/tip/nn_reallocmsg.3compat.html index f7dad297..15f8c63c 100644 --- a/man/tip/nn_reallocmsg.3compat.html +++ b/man/tip/nn_reallocmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_reallocmsg(3compat) ---

    nn_reallocmsg(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -void *nn_reallocmsg(void *old, size_t size);
    +
    #include <nanomsg/nn.h>
    +
    +void *nn_reallocmsg(void *old, size_t size);
    diff --git a/man/tip/nn_recv.3compat.html b/man/tip/nn_recv.3compat.html index a1b20555..2bf6c3c3 100644 --- a/man/tip/nn_recv.3compat.html +++ b/man/tip/nn_recv.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_recv(3compat) ---

    nn_recv(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_recv(int sock, void *data, size_t size, int flags)
    +
    #include <nanomsg/nn.h>
    +
    +int nn_recv(int sock, void *data, size_t size, int flags)
    diff --git a/man/tip/nn_recvmsg.3compat.html b/man/tip/nn_recvmsg.3compat.html index 307ef831..f0123069 100644 --- a/man/tip/nn_recvmsg.3compat.html +++ b/man/tip/nn_recvmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_recvmsg(3compat) ---

    nn_recvmsg(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_recvmsg(int sock, struct nn_msghdr *hdr, int flags);
    @@ -57,14 +58,14 @@ following definition:

    struct nn_iovec {
         void * iov_base;
    -    size_t iov_len;
    +    size_t iov_len;
     };
     
     struct nn_msghdr {
         struct nn_iovec *msg_iov;
         int              msg_iovlen;
         void *           msg_control;
    -    size_t           msg_controllen;
    +    size_t           msg_controllen;
     };
    diff --git a/man/tip/nn_send.3compat.html b/man/tip/nn_send.3compat.html index a8168423..d5318029 100644 --- a/man/tip/nn_send.3compat.html +++ b/man/tip/nn_send.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_send(3compat) ---

    nn_send(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_send(int sock, const void *data, size_t size, int flags)
    +
    #include <nanomsg/nn.h>
    +
    +int nn_send(int sock, const void *data, size_t size, int flags)
    @@ -51,7 +52,7 @@ In this case, data points not to the message content itself, but instea is a pointer to the pointer, an extra level of pointer indirection. The message must have been previously allocated by nn_allocmsg() or -nn_recvmsg(), using the same `NN_MSG size. +nn_recvmsg()`, using the same NN_MSG size. In this case, the ownership of the message shall remain with the caller, unless the function returns 0, indicating that the function has taken responsibility for delivering or disposing of the diff --git a/man/tip/nn_sendmsg.3compat.html b/man/tip/nn_sendmsg.3compat.html index a8491da2..9e4e540a 100644 --- a/man/tip/nn_sendmsg.3compat.html +++ b/man/tip/nn_sendmsg.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_sendmsg(3compat) ---

    nn_sendmsg(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_sendmsg(int sock, const struct nn_msghdr *hdr, int flags);
    @@ -57,14 +58,14 @@ following definition:

    struct nn_iovec {
         void * iov_base;
    -    size_t iov_len;
    +    size_t iov_len;
     };
     
     struct nn_msghdr {
         struct nn_iovec *msg_iov;
         int              msg_iovlen;
         void *           msg_control;
    -    size_t           msg_controllen;
    +    size_t           msg_controllen;
     };
    diff --git a/man/tip/nn_setsockopt.3compat.html b/man/tip/nn_setsockopt.3compat.html index 4825187a..30856eb5 100644 --- a/man/tip/nn_setsockopt.3compat.html +++ b/man/tip/nn_setsockopt.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_setsockopt(3compat) ---

    nn_setsockopt(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_setsockopt(int sock, int level, int option, const void *val, size_t sz);
    +
    #include <nanomsg/nn.h>
    +
    +int nn_setsockopt(int sock, int level, int option, const void *val, size_t sz);
    diff --git a/man/tip/nn_shutdown.3compat.html b/man/tip/nn_shutdown.3compat.html index 19c7ed7b..961b2ffe 100644 --- a/man/tip/nn_shutdown.3compat.html +++ b/man/tip/nn_shutdown.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_shutdown(3compat) ---

    nn_shutdown(3compat)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    -int nn_shutdown(int sock, int ep)
    +
    #include <nanomsg/nn.h>
    +
    +int nn_shutdown(int sock, int ep)
    diff --git a/man/tip/nn_socket.3compat.html b/man/tip/nn_socket.3compat.html index f00c962f..a3fcff69 100644 --- a/man/tip/nn_socket.3compat.html +++ b/man/tip/nn_socket.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_socket(3compat) ---

    nn_socket(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     int nn_socket(int af, int proto);
    diff --git a/man/tip/nn_strerror.3compat.html b/man/tip/nn_strerror.3compat.html index 0bc21fb8..9839ede2 100644 --- a/man/tip/nn_strerror.3compat.html +++ b/man/tip/nn_strerror.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_strerror(3compat) ---

    nn_strerror(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     const char *nn_strerror(int err);
    diff --git a/man/tip/nn_term.3compat.html b/man/tip/nn_term.3compat.html index 8309a440..f1249b81 100644 --- a/man/tip/nn_term.3compat.html +++ b/man/tip/nn_term.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nn_term(3compat) ---

    nn_term(3compat)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nanomsg/nn.h>
    -
    +
    #include <nanomsg/nn.h>
    +
     void nn_term(void);
    diff --git a/man/tip/nng.7.html b/man/tip/nng.7.html index b5d31283..310a85e2 100644 --- a/man/tip/nng.7.html +++ b/man/tip/nng.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng(7) ---

    nng(7)

    @@ -15,7 +16,7 @@ layout: manpage_v2

    SYNOPSIS

    -

    cc ['flags'] 'files' -lnng ['libraries']

    +

    cc ['flags'] 'files' -lnng ['libraries']

    @@ -299,6 +300,7 @@ following the format specified in RFC 3986, including some schemes that are unique to SP. + The URLs used in NNG are canonicalized as follows, mostly in accordance with RFC 3986 6.2.2:

    @@ -307,32 +309,32 @@ accordance with
    1. The URL is parsed into scheme, userinfo, host, port, path, query and - fragment components. (Not all of these members are necessarily present.)

      +fragment components. (Not all of these members are necessarily present.)

    2. The scheme, hostname, and port if present, are converted to lower case.

    3. Percent-encoded values for - unreserved characters - converted to their unencoded forms.

      +unreserved characters +converted to their unencoded forms.

    4. Additionally URL percent-encoded values for characters in the path - and with numeric values larger than 127 (i.e. not ASCII) are decoded.

      +and with numeric values larger than 127 (i.e. not ASCII) are decoded.

    5. The resulting path is checked for invalid UTF-8 sequences, consisting - of surrogate pairs, illegal byte sequences, or overlong encodings. - If this check fails, then the entire URL is considered invalid.

      +of surrogate pairs, illegal byte sequences, or overlong encodings. +If this check fails, then the entire URL is considered invalid.

    6. Path segments consisting of . and .. are resolved as per - RFC 3986 6.2.2.3.

      +RFC 3986 6.2.2.3.

    7. Further, empty path segments are removed, meaning that duplicate - slash (/) separators are removed from the path.

      +slash (/) separators are removed from the path.

    diff --git a/man/tip/nng_aio.5.html b/man/tip/nng_aio.5.html index 97d52a25..8b6be6e8 100644 --- a/man/tip/nng_aio.5.html +++ b/man/tip/nng_aio.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio(5) ---

    nng_aio(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_aio nng_aio;
    diff --git a/man/tip/nng_aio_abort.3.html b/man/tip/nng_aio_abort.3.html index 9cc3defd..3a2e1bb7 100644 --- a/man/tip/nng_aio_abort.3.html +++ b/man/tip/nng_aio_abort.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_abort(3) ---

    nng_aio_abort(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_abort(nng_aio *aio, int err);
    diff --git a/man/tip/nng_aio_alloc.3.html b/man/tip/nng_aio_alloc.3.html index b6bb44d4..7de57ec3 100644 --- a/man/tip/nng_aio_alloc.3.html +++ b/man/tip/nng_aio_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_alloc(3) ---

    nng_aio_alloc(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_aio_alloc(nng_aio **aiop, void (*callb)(void *), void *arg);
    @@ -42,7 +43,23 @@ It will be called with the argument arg.

    The callback callb must not perform any blocking operations, and must complete its execution quickly. If callb does block, this can -lead ultimately to an apparent "hang" or deadlock in the application. +lead ultimately to an apparent "hang" or deadlock in the application. +This also means you should avoid operations such as allocating new objects, +which also means opening or closing sockets, dialers, and so forth. + + + +
    +
    + + + +
    + + +If more complex or blocking work needs to be performed by callb, a separate +thread can be used, along with a condition variable +which can be signaled by the callback.
    diff --git a/man/tip/nng_aio_begin.3.html b/man/tip/nng_aio_begin.3.html index e016d13a..b929bc1a 100644 --- a/man/tip/nng_aio_begin.3.html +++ b/man/tip/nng_aio_begin.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_begin(3) ---

    nng_aio_begin(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     bool nng_aio_begin(nng_aio *aio);
    diff --git a/man/tip/nng_aio_busy.3.html b/man/tip/nng_aio_busy.3.html new file mode 100644 index 00000000..e8f59f9a --- /dev/null +++ b/man/tip/nng_aio_busy.3.html @@ -0,0 +1,87 @@ +--- +version: tip +layout: manpage_v2 +title: nng_aio_busy(3) +--- +

    nng_aio_busy(3)

    +
    +

    NAME

    +
    +
    +

    nng_aio_busy - test if asynchronous I/O is busy

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +bool nng_aio_busy(nng_aio *aio);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_aio_busy() function returns true if the +aio is currently busy performing an asynchronous I/O +operation or is executing a completion callback.

    +
    +
    +

    If no operation has been started, or the operation has +been completed or canceled, and any callback has been +executed, then it returns false.

    +
    +
    +

    This is the same test used internally by +nng_aio_wait()

    +
    +
    + + + + + +
    + + +Care should be taken to ensure that the aio object is not +freed when using this function. The caller is responsible for +coordinating any use of this with any reuse of the aio. +
    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    True if the aio is busy, false otherwise.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    +

    None.

    +
    +
    +
    + diff --git a/man/tip/nng_aio_cancel.3.html b/man/tip/nng_aio_cancel.3.html index 6b45e968..1acb3223 100644 --- a/man/tip/nng_aio_cancel.3.html +++ b/man/tip/nng_aio_cancel.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_cancel(3) ---

    nng_aio_cancel(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_cancel(nng_aio *aio);
    diff --git a/man/tip/nng_aio_count.3.html b/man/tip/nng_aio_count.3.html index 9d0bd202..e4fa137f 100644 --- a/man/tip/nng_aio_count.3.html +++ b/man/tip/nng_aio_count.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_count(3) ---

    nng_aio_count(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -size_t nng_aio_count(nng_aio *aio);
    +
    #include <nng/nng.h>
    +
    +size_t nng_aio_count(nng_aio *aio);
    @@ -33,7 +34,7 @@ asynchronous operation associated with the handle aio.

    Some asynchronous operations do not provide meaningful data for this function; for example operations that establish connections do not -transfer user data (they may transfer protocol data though) -- in this case +transfer user data (they may transfer protocol data though) — in this case this function will generally return zero.

    diff --git a/man/tip/nng_aio_defer.3.html b/man/tip/nng_aio_defer.3.html index 7d97f2fb..9926d83e 100644 --- a/man/tip/nng_aio_defer.3.html +++ b/man/tip/nng_aio_defer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_defer(3) ---

    nng_aio_defer(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef void (*nng_aio_cancelfn)(nng_aio *aio, void *arg, int err);
     
     void nng_aio_defer(nng_aio *aio, nng_aio_cancelfn fn, void *arg);
    diff --git a/man/tip/nng_aio_finish.3.html b/man/tip/nng_aio_finish.3.html index ed6cc091..06ebe9ac 100644 --- a/man/tip/nng_aio_finish.3.html +++ b/man/tip/nng_aio_finish.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_finish(3) ---

    nng_aio_finish(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_finish(nng_aio *aio, int err);
    diff --git a/man/tip/nng_aio_free.3.html b/man/tip/nng_aio_free.3.html index a0efceb5..f7731383 100644 --- a/man/tip/nng_aio_free.3.html +++ b/man/tip/nng_aio_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_free(3) ---

    nng_aio_free(3)

    @@ -16,9 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -void nng_aio_free(nng_aio *aio);
    +
    #include <nng/nng.h>
    +
    +void nng_aio_free(nng_aio *aio);
    +void nng_aio_reap(nng_aio *aio);
    @@ -33,6 +35,23 @@ caller is blocked until the operation is completely canceled, to ensure that it is safe to deallocate the handle and any associated resources. (This is done by implicitly calling nng_aio_stop().)

    +
    +

    The nng_aio_reap() function is the same as nng_aio_free(), but does +it’s work in a background thread. +This can be useful to discard the aio object from within the callback for the aio.

    +
    +
    + + + + + +
    + + +Once either of these functions are called, the aio object is invalid and must not be used again. +
    +
    diff --git a/man/tip/nng_aio_get_input.3.html b/man/tip/nng_aio_get_input.3.html index e75c3554..170b269b 100644 --- a/man/tip/nng_aio_get_input.3.html +++ b/man/tip/nng_aio_get_input.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_input(3) ---

    nng_aio_get_input(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void *nng_aio_get_input(nng_aio *aio, unsigned int index);
    diff --git a/man/tip/nng_aio_get_msg.3.html b/man/tip/nng_aio_get_msg.3.html index 21ad688e..bbfa67a3 100644 --- a/man/tip/nng_aio_get_msg.3.html +++ b/man/tip/nng_aio_get_msg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_msg(3) ---

    nng_aio_get_msg(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     nng_msg *nng_aio_get_msg(nng_aio *aio);
    diff --git a/man/tip/nng_aio_get_output.3.html b/man/tip/nng_aio_get_output.3.html index b473e967..9c0aa219 100644 --- a/man/tip/nng_aio_get_output.3.html +++ b/man/tip/nng_aio_get_output.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_get_output(3) ---

    nng_aio_get_output(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void *nng_aio_get_output(nng_aio *aio, unsigned int index);
    diff --git a/man/tip/nng_aio_result.3.html b/man/tip/nng_aio_result.3.html index fb93f13f..03a024d9 100644 --- a/man/tip/nng_aio_result.3.html +++ b/man/tip/nng_aio_result.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_result(3) ---

    nng_aio_result(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_aio_result(nng_aio *aio);
    diff --git a/man/tip/nng_aio_set_input.3.html b/man/tip/nng_aio_set_input.3.html index 027b6bc2..12c82f08 100644 --- a/man/tip/nng_aio_set_input.3.html +++ b/man/tip/nng_aio_set_input.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_input(3) ---

    nng_aio_set_input(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_set_input(nng_aio *aio, unsigned int index, void *param);
    diff --git a/man/tip/nng_aio_set_iov.3.html b/man/tip/nng_aio_set_iov.3.html index ba739b89..1185844d 100644 --- a/man/tip/nng_aio_set_iov.3.html +++ b/man/tip/nng_aio_set_iov.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_iov(3) ---

    nng_aio_set_iov(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_aio_set_iov(nng_aio *aio, unsigned int niov, nng_iov *iov);
    @@ -37,7 +38,7 @@ structures, which have the following definition:

        typedef struct nng_iov {
             void * iov_buf;
    -        size_t iov_len;
    +        size_t iov_len;
         };
    @@ -46,7 +47,7 @@ structures, which have the following definition:

    The values pointed to by the iov_buf members are not copied by this function though.

    -

    A maximum of eight (8) nng_iov members may be supplied.

    +

    A maximum of four (4) nng_iov members may be supplied.

    diff --git a/man/tip/nng_aio_set_msg.3.html b/man/tip/nng_aio_set_msg.3.html index 3b4a02e2..08e5a1ff 100644 --- a/man/tip/nng_aio_set_msg.3.html +++ b/man/tip/nng_aio_set_msg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_msg(3) ---

    nng_aio_set_msg(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_set_msg(nng_aio *aio, nng_msg *msg);
    diff --git a/man/tip/nng_aio_set_output.3.html b/man/tip/nng_aio_set_output.3.html index 5b532394..57785005 100644 --- a/man/tip/nng_aio_set_output.3.html +++ b/man/tip/nng_aio_set_output.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_output(3) ---

    nng_aio_set_output(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result);
    diff --git a/man/tip/nng_aio_set_timeout.3.html b/man/tip/nng_aio_set_timeout.3.html index b237177b..00cd8cbb 100644 --- a/man/tip/nng_aio_set_timeout.3.html +++ b/man/tip/nng_aio_set_timeout.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_set_timeout(3) ---

    nng_aio_set_timeout(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef int nng_duration;
     void nng_aio_set_timeout(nng_aio *aio, nng_duration timeout);
    @@ -37,7 +38,7 @@ The timeout is specified as a relative number of milliseconds.

    If the timeout is NNG_DURATION_INFINITE, then no timeout is used. -If the timeout is NNG_DURATION_DEFAULT, then a "default" or socket-specific +If the timeout is NNG_DURATION_DEFAULT, then a "default" or socket-specific timeout is used. (This is frequently the same as NNG_DURATION_INFINITE.)

    @@ -49,7 +50,7 @@ timeout is used.
    diff --git a/man/tip/nng_aio_stop.3.html b/man/tip/nng_aio_stop.3.html index de8df3c4..10af9899 100644 --- a/man/tip/nng_aio_stop.3.html +++ b/man/tip/nng_aio_stop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_stop(3) ---

    nng_aio_stop(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_stop(nng_aio *aio);
    diff --git a/man/tip/nng_aio_wait.3.html b/man/tip/nng_aio_wait.3.html index 3759d4d6..ed547232 100644 --- a/man/tip/nng_aio_wait.3.html +++ b/man/tip/nng_aio_wait.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_aio_wait(3) ---

    nng_aio_wait(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_aio_wait(nng_aio *aio);
    @@ -33,7 +34,7 @@ If the operation has not been started, or has already completed, then it returns immediately.

    -

    If the a callback was set with aio when it was allocated, then this +

    If a callback was set with aio when it was allocated, then this function will not be called until the callback has completed.

    @@ -60,6 +61,7 @@ function will not be called until the callback has completed.

    diff --git a/man/tip/nng_alloc.3.html b/man/tip/nng_alloc.3.html index 67decfe3..d8657651 100644 --- a/man/tip/nng_alloc.3.html +++ b/man/tip/nng_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_alloc(3) ---

    nng_alloc(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -void *nng_alloc(size_t size);
    +
    #include <nng/nng.h>
    +
    +void *nng_alloc(size_t size);
    diff --git a/man/tip/nng_bus.7.html b/man/tip/nng_bus.7.html index 78797a6f..2d1caaf5 100644 --- a/man/tip/nng_bus.7.html +++ b/man/tip/nng_bus.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_bus(7) ---

    nng_bus(7)

    diff --git a/man/tip/nng_bus_open.3.html b/man/tip/nng_bus_open.3.html index f66ba632..8d91cdf5 100644 --- a/man/tip/nng_bus_open.3.html +++ b/man/tip/nng_bus_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_bus_open(3) ---

    nng_bus_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/bus0/bus.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/bus0/bus.h>
    +
     int nng_bus0_open(nng_socket *s);
     
     int nng_bus0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_clock.3supp.html b/man/tip/nng_clock.3supp.html index b7351f56..cac058e3 100644 --- a/man/tip/nng_clock.3supp.html +++ b/man/tip/nng_clock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_clock(3supp) ---

    nng_clock(3supp)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    -typedef uint64_t nng_time;
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
    +typedef uint64_t nng_time;
     
     nng_time nng_clock(void);
    diff --git a/man/tip/nng_close.3.html b/man/tip/nng_close.3.html index 81901d70..a0bf7ecf 100644 --- a/man/tip/nng_close.3.html +++ b/man/tip/nng_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_close(3) ---

    nng_close(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_close(nng_socket s);
    diff --git a/man/tip/nng_compat.3compat.html b/man/tip/nng_compat.3compat.html index 7e7c7112..6e4b8764 100644 --- a/man/tip/nng_compat.3compat.html +++ b/man/tip/nng_compat.3compat.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_compat(3compat) ---

    nng_compat(3compat)

    @@ -16,19 +17,19 @@ layout: manpage_v2
    -
    #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>
    +
    #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>
    @@ -98,7 +99,7 @@ While reasonable efforts have been made to provide for compatibility, some things may behave differently, and some less common parts of the libnanomsg 1.0 API are not supported at this time, including certain options and the statistics API. -See the [Caveats] section below. +See the Caveats section below.
    As most operations involve some context switching, it is usually a good -idea to allow at least a few tens of milliseconds before timing them out -- +idea to allow at least a few tens of milliseconds before timing them out —  a too small timeout might not allow the operation to properly begin before giving up!
    @@ -121,8 +122,8 @@ For example, instead of:

    -
    #include <nanomsg/nn.h>
    -#include <nanomsg/reqrep.h>
    +
    #include <nanomsg/nn.h>
    +#include <nanomsg/reqrep.h>
    @@ -130,8 +131,8 @@ For example, instead of:

    -
    #include <nng/compat/nanomsg/nn.h>
    -#include <nng/compat/nanomsg/reqrep.h>
    +
    #include <nng/compat/nanomsg/nn.h>
    +#include <nng/compat/nanomsg/reqrep.h>
    @@ -144,14 +145,11 @@ instead of libnn, just like any other NNG application.

    The following functions are provided:

    -
    -

    ifndef::backend-pdf[]

    -
    -nn_socket() +`nn_socket()`

    create socket

    @@ -159,7 +157,7 @@ instead of libnn, just like any other NNG application.

    -nn_getsockopt() +`nn_getsockopt()`

    get socket option

    @@ -167,7 +165,7 @@ instead of libnn, just like any other NNG application.

    -nn_setsockopt() +`nn_setsockopt()`

    set socket option

    @@ -175,7 +173,7 @@ instead of libnn, just like any other NNG application.

    -nn_bind() +`nn_bind()`

    accept connections from remote peers

    @@ -183,7 +181,7 @@ instead of libnn, just like any other NNG application.

    -nn_connect() +`nn_connect()`

    connect to remote peer

    @@ -191,7 +189,7 @@ instead of libnn, just like any other NNG application.

    -nn_send() +`nn_send()`

    send data

    @@ -199,7 +197,7 @@ instead of libnn, just like any other NNG application.

    -nn_recv() +`nn_recv()`

    receive data

    @@ -207,7 +205,7 @@ instead of libnn, just like any other NNG application.

    -nn_shutdown() +`nn_shutdown()`

    shut down endpoint

    @@ -215,7 +213,7 @@ instead of libnn, just like any other NNG application.

    -nn_close() +`nn_close()`

    close socket

    @@ -223,7 +221,7 @@ instead of libnn, just like any other NNG application.

    -nn_poll() +`nn_poll()`

    poll sockets

    @@ -231,7 +229,7 @@ instead of libnn, just like any other NNG application.

    -nn_device() +`nn_device()`

    create forwarding device

    @@ -239,7 +237,7 @@ instead of libnn, just like any other NNG application.

    -nn_recvmsg() +`nn_recvmsg()`

    receive message

    @@ -247,7 +245,7 @@ instead of libnn, just like any other NNG application.

    -nn_sendmsg() +`nn_sendmsg()`

    send message

    @@ -255,7 +253,7 @@ instead of libnn, just like any other NNG application.

    -nn_cmsg() +`nn_cmsg()`

    message control data

    @@ -263,7 +261,7 @@ instead of libnn, just like any other NNG application.

    -nn_get_statistic() +`nn_get_statistic()`

    get statistic (stub)

    @@ -271,7 +269,7 @@ instead of libnn, just like any other NNG application.

    -nn_allocmsg() +`nn_allocmsg()`

    allocate message

    @@ -279,7 +277,7 @@ instead of libnn, just like any other NNG application.

    -nn_reallocmsg() +`nn_reallocmsg()`

    reallocate message

    @@ -287,7 +285,7 @@ instead of libnn, just like any other NNG application.

    -nn_freemsg() +`nn_freemsg()`

    free message

    @@ -295,7 +293,7 @@ instead of libnn, just like any other NNG application.

    -nn_errno() +`nn_errno()`

    return most recent error

    @@ -303,7 +301,7 @@ instead of libnn, just like any other NNG application.

    -nn_strerror() +`nn_strerror()`

    return message for error

    @@ -311,111 +309,14 @@ instead of libnn, just like any other NNG application.

    -nn_term() +`nn_term()` -

    terminate library -endif::[] -ifdef::backend-pdf[]

    +

    terminate library

    - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    nn_socket()

    create socket

    nn_getsockopt()

    get socket option

    nn_setsockopt()

    set socket option

    nn_bind()

    accept connections from remote peers

    nn_connect()

    connect to remote peer

    nn_send()

    send data

    nn_recv()

    receive data

    nn_shutdown()

    shut down endpoint

    nn_close()

    close socket

    nn_poll()

    poll sockets

    nn_device()

    create forwarding device

    nn_recvmsg()

    receive message

    nn_sendmsg()

    send message

    nn_cmsg()

    message control data

    nn_get_statistic()

    get statistic (stub)

    nn_allocmsg()

    allocate message

    nn_reallocmsg()

    reallocate message

    nn_freemsg()

    free message

    nn_errno()

    return most recent error

    nn_strerror()

    return message for error

    nn_term()

    terminate library

    -
    -

    endif::[]

    -

    Caveats

    @@ -426,69 +327,69 @@ ifdef::backend-pdf[]

    • Socket numbers can be quite large. - The legacy libnanomsg attempted to reuse socket numbers, like - file descriptors in UNIX systems. - NNG 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 legacy libnanomsg attempted to reuse socket numbers, like +file descriptors in UNIX systems. +NNG 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: - NN_SNDPRIO, NN_RCVPRIO, NN_IPV4ONLY. - The priority options may be supported in the future, when - the underlying capability is present in NNG.

      +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.

      +(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.

      +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.

      +For example, ipc:///tmp/mysocket is acceptable, but ipc://mysocket is not.

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

      +only supports BINARY frames.

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

      +In particular, this legacy API offers no way to configure +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.

      +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.)

      +Specifically, there is no nn_symbol() function yet. +(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.)

      +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.)

      +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.

      +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.

    diff --git a/man/tip/nng_ctx.5.html b/man/tip/nng_ctx.5.html index e601c848..a006c34b 100644 --- a/man/tip/nng_ctx.5.html +++ b/man/tip/nng_ctx.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx(5) ---

    nng_ctx(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_ctx_s nng_ctx
    @@ -156,8 +157,7 @@ to the sender.

    -
    
    -struct echo_context {
    +
    struct echo_context {
         nng_ctx ctx;
         nng_aio *aio;
         enum { INIT, RECV, SEND } state;
    @@ -171,22 +171,25 @@ to the sender.

    switch (ec->state) { case INIT: ec->state = RECV; - nng_ctx_recv(ec->ctx, ec->aio); + nng_ctx_recv(ec->ctx, ec->aio); return; case RECV: - if (nng_aio_result(ec->aio) != 0) { + if (nng_aio_result(ec->aio) != 0) { // ... handle error - } + + } // We reuse the message on the ec->aio - ec->state = SEND; - nng_ctx_send(ec->ctx, ec->aio); + + ec->state = SEND; + nng_ctx_send(ec->ctx, ec->aio); return; case SEND: - if (nng_aio_result(ec->aio) != 0) { + if (nng_aio_result(ec->aio) != 0) { // ... handle error - } + + } ec->state = RECV; - nng_ctx_recv(ec->ctx, ec->aio); + nng_ctx_recv(ec->ctx, ec->aio); return; } }
    @@ -201,8 +204,8 @@ or nng_listen().

    -
    #define CONCURRENCY 1024
    -
    +
    #define CONCURRENCY 1024
    +
     echo_context ecs[CONCURRENCY];
     
     void
    @@ -210,11 +213,13 @@ or nng_listen().

    { for (int i = 0; i < CONCURRENCY; i++) { // error checks elided for clarity - nng_ctx_open(ec[i].ctx, rep_socket) - nng_aio_alloc(ec[i].aio, echo, &e[i]); + + nng_ctx_open(ec[i].ctx, rep_socket) + nng_aio_alloc(ec[i].aio, echo, &e[i]); ec[i].state = INIT; - echo(&ec[i]); // start it running - } + echo(&ec[i]); // start it running + + } }
    @@ -227,11 +232,13 @@ or nng_listen().

    libnng(3), nng_ctx_close(3), nng_ctx_open(3), -nng_ctx_getopt(3), +nng_ctx_get(3), nng_ctx_id(3), nng_ctx_recv(3), +nng_ctx_recvmsg(3), nng_ctx_send(3), -nng_ctx_setopt(3), +nng_ctx_sendmsg(3), +nng_ctx_set(3), nng_dialer(5), nng_listener(5), nng_socket(5), diff --git a/man/tip/nng_ctx_close.3.html b/man/tip/nng_ctx_close.3.html index f024ed61..90637944 100644 --- a/man/tip/nng_ctx_close.3.html +++ b/man/tip/nng_ctx_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_close(3) ---

    nng_ctx_close(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_ctx_close(nng_ctx ctx);
    diff --git a/man/tip/nng_ctx_get.3.html b/man/tip/nng_ctx_get.3.html index e0575644..3ff491a9 100644 --- a/man/tip/nng_ctx_get.3.html +++ b/man/tip/nng_ctx_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_get(3) ---

    nng_ctx_get(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_ctx_get(nng_ctx ctx, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_get(nng_ctx ctx, const char *opt, void *val, size_t *valszp);
     
     int nng_ctx_get_bool(nng_ctx ctx, const char *opt, bool *bvalp);
     
    @@ -26,11 +27,11 @@ layout: manpage_v2
     
     int nng_ctx_get_ms(nng_ctx ctx, const char *opt, nng_duration *durp);
     
    -int nng_ctx_get_size(nng_ctx ctx, const char *opt, size_t *zp);
    +int nng_ctx_get_size(nng_ctx ctx, const char *opt, size_t *zp);
     
     int nng_ctx_get_string(nng_ctx ctx, const char *opt, char **strp);
     
    -int nng_ctx_get_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
    +int nng_ctx_get_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
    diff --git a/man/tip/nng_ctx_getopt.3.html b/man/tip/nng_ctx_getopt.3.html index 8cfe15e6..f721aa45 100644 --- a/man/tip/nng_ctx_getopt.3.html +++ b/man/tip/nng_ctx_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_getopt(3) ---

    nng_ctx_getopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_ctx_getopt(nng_ctx ctx, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_getopt(nng_ctx ctx, const char *opt, void *val, size_t *valszp);
     
     int nng_ctx_getopt_bool(nng_ctx ctx, const char *opt, bool *bvalp);
     
    @@ -26,11 +27,11 @@ layout: manpage_v2
     
     int nng_ctx_getopt_ms(nng_ctx ctx, const char *opt, nng_duration *durp);
     
    -int nng_ctx_getopt_size(nng_ctx ctx, const char *opt, size_t *zp);
    +int nng_ctx_getopt_size(nng_ctx ctx, const char *opt, size_t *zp);
     
     int nng_ctx_getopt_string(nng_ctx ctx, const char *opt, char **strp);
     
    -int nng_ctx_getopt_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
    +int nng_ctx_getopt_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
    @@ -38,14 +39,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_ctx_get. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    diff --git a/man/tip/nng_ctx_id.3.html b/man/tip/nng_ctx_id.3.html index f6948f57..ecf1f58c 100644 --- a/man/tip/nng_ctx_id.3.html +++ b/man/tip/nng_ctx_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_id(3) ---

    nng_ctx_id(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_ctx_id(nng_ctx c);
    diff --git a/man/tip/nng_ctx_open.3.html b/man/tip/nng_ctx_open.3.html index 8a81e32d..5b3e8cc4 100644 --- a/man/tip/nng_ctx_open.3.html +++ b/man/tip/nng_ctx_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_open(3) ---

    nng_ctx_open(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_ctx_open(nng_ctx *ctxp, nng_socket s);
    diff --git a/man/tip/nng_ctx_recv.3.html b/man/tip/nng_ctx_recv.3.html index 3e01d810..79ff4855 100644 --- a/man/tip/nng_ctx_recv.3.html +++ b/man/tip/nng_ctx_recv.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_recv(3) ---

    nng_ctx_recv(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_ctx_recv(nng_ctx ctx, nng_aio *aio);
    diff --git a/man/tip/nng_ctx_recvmsg.3.html b/man/tip/nng_ctx_recvmsg.3.html new file mode 100644 index 00000000..1a86f10f --- /dev/null +++ b/man/tip/nng_ctx_recvmsg.3.html @@ -0,0 +1,148 @@ +--- +version: tip +layout: manpage_v2 +title: nng_ctx_recvmsg(3) +--- +

    nng_ctx_recvmsg(3)

    +
    +

    NAME

    +
    +
    +

    nng_ctx_recvmsg - receive message using socket

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_recvmsg(nng_ctx ctx, nng_msg **msgp, int flags);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_ctx_recvmsg() receives a message on context ctx, storing the +received message at the location pointed to by msgp.

    +
    +
    +

    The flags may contain the following value:

    +
    +
    +
    +
    NNG_FLAG_NONBLOCK
    +
    +

    The function returns immediately, even if no message is available. +Without this flag, the function will wait until a message is receivable +on the context ctx, or any configured timer expires.

    +
    +
    +
    +
    + + + + + +
    + + +The semantics of what receiving a message means vary from protocol to +protocol, so examination of the protocol documentation is encouraged. +
    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    This function returns 0 on success, and non-zero otherwise.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN + +

    The operation would block, but NNG_FLAG_NONBLOCK was specified.

    +
    +NNG_ECLOSED + +

    The context or socket is not open.

    +
    +NNG_EINVAL + +

    An invalid set of flags was specified.

    +
    +NNG_ENOMEM + +

    Insufficient memory is available.

    +
    +NNG_ENOTSUP + +

    The protocol does not support receiving.

    +
    +NNG_ESTATE + +

    The context cannot receive data in this state.

    +
    +NNG_ETIMEDOUT + +

    The operation timed out.

    +
    +
    +
    +
    + diff --git a/man/tip/nng_ctx_send.3.html b/man/tip/nng_ctx_send.3.html index 5b64e811..647eec6c 100644 --- a/man/tip/nng_ctx_send.3.html +++ b/man/tip/nng_ctx_send.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_send(3) ---

    nng_ctx_send(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_ctx_send(nng_ctx ctx, nng_aio *aio);
    diff --git a/man/tip/nng_ctx_sendmsg.3.html b/man/tip/nng_ctx_sendmsg.3.html new file mode 100644 index 00000000..fad9ad25 --- /dev/null +++ b/man/tip/nng_ctx_sendmsg.3.html @@ -0,0 +1,187 @@ +--- +version: tip +layout: manpage_v2 +title: nng_ctx_sendmsg(3) +--- +

    nng_ctx_sendmsg(3)

    +
    +

    NAME

    +
    +
    +

    nng_ctx_sendmsg - send message using context

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_sendmsg(nng_ctx c, nng_msg *msg, int flags);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_ctx_sendmsg() sends message msg using the context ctx.

    +
    +
    +

    If the function returns zero, indicating it has accepted the message for +delivery, then the msg is owned by the socket s, and the caller +must not make any further use of it. +The socket will free the message when it is finished.

    +
    +
    +

    If the function returns non-zero, then it is the caller’s responsibility +to dispose of the msg, which may include freeing it, sending it to +another socket, or simply trying again later.

    +
    +
    + + + + + +
    + + +The semantics of what sending a message means vary from protocol to +protocol, so examination of the protocol documentation is encouraged. +
    +
    +
    +

    The flags may contain the following value:

    +
    +
    +
    +
    NNG_FLAG_NONBLOCK
    +
    +

    The function returns immediately, regardless of whether +the context is able to accept the data or not. +If the context is unable to accept the data (such as if backpressure exists +because the peers are consuming messages too slowly, or no peer is present), +then the function will return with NNG_EAGAIN. +If this flag is not specified, then the function will block if such a +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 implicitly NNG_FLAG_NONBLOCK. +
    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    This function returns 0 on success, and non-zero otherwise.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +NNG_EAGAIN + +

    The operation would block, but NNG_FLAG_NONBLOCK was specified.

    +
    +NNG_ECLOSED + +

    The context or socket is not open.

    +
    +NNG_EINVAL + +

    An invalid set of flags was specified.

    +
    +NNG_EMSGSIZE + +

    The value of size is too large.

    +
    +NNG_ENOMEM + +

    Insufficient memory is available.

    +
    +NNG_ENOTSUP + +

    The protocol does not support sending.

    +
    +NNG_ESTATE + +

    The context cannot send data in this state.

    +
    +NNG_ETIMEDOUT + +

    The operation timed out.

    +
    +
    +
    +
    + diff --git a/man/tip/nng_ctx_set.3.html b/man/tip/nng_ctx_set.3.html index 3f1adae7..98db4b3b 100644 --- a/man/tip/nng_ctx_set.3.html +++ b/man/tip/nng_ctx_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_set(3) ---

    nng_ctx_set(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_ctx_set(nng_ctx ctx, const char *opt, const void *val, size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_set(nng_ctx ctx, const char *opt, const void *val, size_t valsz);
     
     int nng_ctx_set_bool(nng_ctx ctx, const char *opt, int bval);
     
    @@ -26,11 +27,11 @@ layout: manpage_v2
     
     int nng_ctx_set_ms(nng_ctx ctx, const char *opt, nng_duration dur);
     
    -int nng_ctx_set_size(nng_ctx ctx, const char *opt, size_t z);
    +int nng_ctx_set_size(nng_ctx ctx, const char *opt, size_t z);
     
     int nng_ctx_set_string(nng_ctx ctx, const char *opt, const char *str);
     
    -int nng_ctx_set_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
    +int nng_ctx_set_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
    diff --git a/man/tip/nng_ctx_setopt.3.html b/man/tip/nng_ctx_setopt.3.html index 04d1163f..bbe7e3b2 100644 --- a/man/tip/nng_ctx_setopt.3.html +++ b/man/tip/nng_ctx_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ctx_setopt(3) ---

    nng_ctx_setopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_ctx_setopt(nng_ctx ctx, const char *opt, const void *val, size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_ctx_setopt(nng_ctx ctx, const char *opt, const void *val, size_t valsz);
     
     int nng_ctx_setopt_bool(nng_ctx ctx, const char *opt, int bval);
     
    @@ -26,11 +27,11 @@ layout: manpage_v2
     
     int nng_ctx_setopt_ms(nng_ctx ctx, const char *opt, nng_duration dur);
     
    -int nng_ctx_setopt_size(nng_ctx ctx, const char *opt, size_t z);
    +int nng_ctx_setopt_size(nng_ctx ctx, const char *opt, size_t z);
     
     int nng_ctx_setopt_string(nng_ctx ctx, const char *opt, const char *str);
     
    -int nng_ctx_setopt_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
    +int nng_ctx_setopt_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
    @@ -38,14 +39,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_ctx_set. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    diff --git a/man/tip/nng_cv_alloc.3supp.html b/man/tip/nng_cv_alloc.3supp.html index 69f608a5..c30305d4 100644 --- a/man/tip/nng_cv_alloc.3supp.html +++ b/man/tip/nng_cv_alloc.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_alloc(3supp) ---

    nng_cv_alloc(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     typedef struct nng_cv nng_cv;
     
     int nng_cv_alloc(nng_cv **cvp, nng_mtx *mtx);
    diff --git a/man/tip/nng_cv_free.3supp.html b/man/tip/nng_cv_free.3supp.html index aca2ce03..16df21de 100644 --- a/man/tip/nng_cv_free.3supp.html +++ b/man/tip/nng_cv_free.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_free(3supp) ---

    nng_cv_free(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_cv_free(nng_cv *cv);
    diff --git a/man/tip/nng_cv_until.3supp.html b/man/tip/nng_cv_until.3supp.html index 1c3848ea..547fa523 100644 --- a/man/tip/nng_cv_until.3supp.html +++ b/man/tip/nng_cv_until.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_until(3supp) ---

    nng_cv_until(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     int nng_cv_until(nng_cv *cv, nng_time when);
    @@ -66,25 +67,28 @@ tests for true.
    Example 1: Waiting for the condition
    -
    
    -    nng_mtx_lock(m);  // assume cv was allocated using m
    -    while (!condition_true) {
    -        if (nng_cv_wait(cv) == NNG_ETIMEDOUT) {
    -            printf("Time out reached!\n");
    +
        expire = nng_clock() + 1000; // 1 second in the future
    +
    +    nng_mtx_lock(m);  // assume cv was allocated using m
    +
    +    while (!condition_true) {
    +        if (nng_cv_until(cv, expire) == NNG_ETIMEDOUT) {
    +            printf("Time out reached!\n");
                 break;
             }
         }
         // condition_true is true
    -    nng_mtx_unlock(m);
    + + nng_mtx_unlock(m);
    Example 2: Signaling the condition
    -
        nng_mtx_lock(m);
    +
        nng_mtx_lock(m);
         condition_true = true;
    -    nng_cv_wake(cv);
    -    nng_mtx_unlock(m);
    + nng_cv_wake(cv); + nng_mtx_unlock(m);
    diff --git a/man/tip/nng_cv_wait.3supp.html b/man/tip/nng_cv_wait.3supp.html index 3692861d..3370395c 100644 --- a/man/tip/nng_cv_wait.3supp.html +++ b/man/tip/nng_cv_wait.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wait(3supp) ---

    nng_cv_wait(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_cv_wait(nng_cv *cv);
    @@ -65,22 +66,23 @@ tests for true.
    Example 1: Waiting for the condition
    -
    
    -    nng_mtx_lock(m);  // assume cv was allocated using m
    -    while (!condition_true) {
    -        nng_cv_wait(cv);
    +
        nng_mtx_lock(m);  // assume cv was allocated using m
    +
    +    while (!condition_true) {
    +        nng_cv_wait(cv);
         }
         // condition_true is true
    -    nng_mtx_unlock(m);
    + + nng_mtx_unlock(m);
    Example 2: Signaling the condition
    -
        nng_mtx_lock(m);
    +
        nng_mtx_lock(m);
         condition_true = true;
    -    nng_cv_wake(cv);
    -    nng_mtx_unlock(m);
    + nng_cv_wake(cv); + nng_mtx_unlock(m);
    diff --git a/man/tip/nng_cv_wake.3supp.html b/man/tip/nng_cv_wake.3supp.html index 97d04f8a..bd84f71b 100644 --- a/man/tip/nng_cv_wake.3supp.html +++ b/man/tip/nng_cv_wake.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wake(3supp) ---

    nng_cv_wake(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_cv_wake(nng_cv *cv);
    diff --git a/man/tip/nng_cv_wake1.3supp.html b/man/tip/nng_cv_wake1.3supp.html index 5178d8da..b94dff5a 100644 --- a/man/tip/nng_cv_wake1.3supp.html +++ b/man/tip/nng_cv_wake1.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_cv_wake1(3supp) ---

    nng_cv_wake1(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_cv_wake1(nng_cv *cv);
    diff --git a/man/tip/nng_device.3.html b/man/tip/nng_device.3.html index d74722be..5b10e2ad 100644 --- a/man/tip/nng_device.3.html +++ b/man/tip/nng_device.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_device(3) ---

    nng_device(3)

    @@ -16,9 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_device(nng_socket s1, nng_socket s2);
    +
    #include <nng/nng.h>
    +
    +int nng_device(nng_socket s1, nng_socket s2);
    +
    +void nng_device_aio(nng_aio *aio, nng_socket s1, nng_socket s2);
    @@ -27,11 +30,11 @@ layout: manpage_v2

    DESCRIPTION

    -

    The nng_device() function forwards messages received from one +

    The nng_device() and nng_device_aio() functions forward messages received from one socket s1 to another socket s2, and vice versa.

    -

    This function is used to create forwarders, which can be used to create +

    These functions are used to create forwarders, which can be used to create complex network topologies to provide for improved horizontal scalability, reliability, and isolation.

    @@ -43,7 +46,9 @@ such as nng_req0_open_raw().

    The nng_device() function does not return until one of the sockets -is closed.

    +is closed. +The nng_device_aio() function returns immediately, and operates completely in +the background.

    Reflectors

    @@ -56,7 +61,7 @@ a protocol that is bidirectional and can peer with itself (such as bus.) In this case the device acts as a reflector or loop-back device, where messages received from the valid socket are merely returned -back to the sender.

    +to the sender.

    @@ -88,6 +93,10 @@ This allows replies to be returned to requesters, and responses to be routed back to surveyors.

    +

    The caller of these functions is required to close the sockets when the +device is stopped.

    +
    +

    Additionally, some protocols have a maximum time-to-live to protect against forwarding loops and especially amplification loops. In these cases, the default limit (usually 8), ensures that messages will @@ -118,7 +127,7 @@ to network performance. -Devices (forwarders and reflectors) act in best effort delivery mode only. +Devices (forwarders and reflectors) act in best-effort delivery mode only. If a message is received from one socket that cannot be accepted by the other (due to backpressure or other issues), then the message is discarded. diff --git a/man/tip/nng_dial.3.html b/man/tip/nng_dial.3.html index 9ec1eb1c..7e0a7efe 100644 --- a/man/tip/nng_dial.3.html +++ b/man/tip/nng_dial.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dial(3) ---

    nng_dial(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dial(nng_socket s, const char *url, nng_dialer *dp, int flags);
    diff --git a/man/tip/nng_dialer.5.html b/man/tip/nng_dialer.5.html index 3947fd2a..ee62d7a2 100644 --- a/man/tip/nng_dialer.5.html +++ b/man/tip/nng_dialer.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer(5) ---

    nng_dialer(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_dialer_s nng_dialer;
    diff --git a/man/tip/nng_dialer_close.3.html b/man/tip/nng_dialer_close.3.html index d14adc99..858dac60 100644 --- a/man/tip/nng_dialer_close.3.html +++ b/man/tip/nng_dialer_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_close(3) ---

    nng_dialer_close(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dialer_close(nng_dialer d);
    diff --git a/man/tip/nng_dialer_create.3.html b/man/tip/nng_dialer_create.3.html index 5a7e3daa..d3a43ec5 100644 --- a/man/tip/nng_dialer_create.3.html +++ b/man/tip/nng_dialer_create.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_create(3) ---

    nng_dialer_create(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dialer_create(nng_dialer *dialerp, nng_socket s, const char *url);
    diff --git a/man/tip/nng_dialer_get.3.html b/man/tip/nng_dialer_get.3.html index a8ab0ab1..e89c43a7 100644 --- a/man/tip/nng_dialer_get.3.html +++ b/man/tip/nng_dialer_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_get(3) ---

    nng_dialer_get(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_dialer_get(nng_dialer d, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_dialer_get(nng_dialer d, const char *opt, void *val, size_t *valszp);
     
     int nng_dialer_get_bool(nng_dialer d, const char *opt, bool *bvalp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_dialer_get_ptr(nng_dialer d, const char *opt, void **ptr);
     
    -int nng_dialer_get_size(nng_dialer d, const char *opt, size_t *zp);
    +int nng_dialer_get_size(nng_dialer d, const char *opt, size_t *zp);
     
     int nng_dialer_get_addr(nng_dialer d, const char *opt, nng_sockaddr *sap);
     
     int nng_dialer_get_string(nng_dialer d, const char *opt, char **strp);
     
    -int nng_dialer_get_uint64(nng_dialer d, const char *opt, uint64_t *u64p);
    +int nng_dialer_get_uint64(nng_dialer d, const char *opt, uint64_t *u64p);
    @@ -49,8 +50,7 @@ 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 and protocols themselves.

    +

    Additionally some transport-specific options are documented with the transports themselves.

    Forms

    diff --git a/man/tip/nng_dialer_getopt.3.html b/man/tip/nng_dialer_getopt.3.html index 7b4e573c..18ec4fb9 100644 --- a/man/tip/nng_dialer_getopt.3.html +++ b/man/tip/nng_dialer_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_getopt(3) ---

    nng_dialer_getopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_dialer_getopt(nng_dialer d, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_dialer_getopt(nng_dialer d, const char *opt, void *val, size_t *valszp);
     
     int nng_dialer_getopt_bool(nng_dialer d, const char *opt, bool *bvalp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_dialer_getopt_ptr(nng_dialer d, const char *opt, void **ptr);
     
    -int nng_dialer_getopt_size(nng_dialer d, const char *opt, size_t *zp);
    +int nng_dialer_getopt_size(nng_dialer d, const char *opt, size_t *zp);
     
     int nng_dialer_getopt_sockaddr(nng_dialer d, const char *opt, nng_sockaddr *sap);
     
     int nng_dialer_getopt_string(nng_dialer d, const char *opt, char **strp);
     
    -int nng_dialer_getopt_uint64(nng_dialer d, const char *opt, uint64_t *u64p);
    +int nng_dialer_getopt_uint64(nng_dialer d, const char *opt, uint64_t *u64p);
    @@ -42,14 +43,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_dialer_get. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    @@ -61,8 +63,7 @@ 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 and protocols themselves.

    +

    Additionally some transport-specific options are documented with the transports themselves.

    Forms

    diff --git a/man/tip/nng_dialer_id.3.html b/man/tip/nng_dialer_id.3.html index ce0ec568..1b44db8b 100644 --- a/man/tip/nng_dialer_id.3.html +++ b/man/tip/nng_dialer_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_id(3) ---

    nng_dialer_id(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dialer_id(nng_dialer d);
    diff --git a/man/tip/nng_dialer_set.3.html b/man/tip/nng_dialer_set.3.html index c2b80327..5d57aaab 100644 --- a/man/tip/nng_dialer_set.3.html +++ b/man/tip/nng_dialer_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_set(3) ---

    nng_dialer_set(3)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_dialer_set(nng_dialer d, const char *opt, const void *val, 
    -    size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_dialer_set(nng_dialer d, const char *opt, const void *val,
    +    size_t valsz);
     
     int nng_dialer_set_bool(nng_dialer d, const char *opt, bool bval);
     
    @@ -29,11 +30,11 @@ layout: manpage_v2
     
     int nng_dialer_set_ptr(nng_dialer d, const char *opt, void *ptr);
     
    -int nng_dialer_set_size(nng_dialer d, const char *opt, size_t z);
    +int nng_dialer_set_size(nng_dialer d, const char *opt, size_t z);
     
     int nng_dialer_set_string(nng_dialer d, const char *opt, const char *str);
     
    -int nng_dialer_set_uint64(nng_dialer d, const char *opt, uint64_t u64);
    +int nng_dialer_set_uint64(nng_dialer d, const char *opt, uint64_t u64);
    @@ -48,8 +49,7 @@ The actual options that may be configured in this way vary, and many are documented in nng_options(5).

    -

    Additionally some transport-specific options are documented with the -transports themselves.

    +

    Additionally some transport-specific options are documented with the transports themselves.

    diff --git a/man/tip/nng_dialer_setopt.3.html b/man/tip/nng_dialer_setopt.3.html index cd0d677c..ac60db70 100644 --- a/man/tip/nng_dialer_setopt.3.html +++ b/man/tip/nng_dialer_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_setopt(3) ---

    nng_dialer_setopt(3)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dialer_setopt(nng_dialer d, const char *opt, const void *val,
    -    size_t valsz);
    +    size_t valsz);
     
     int nng_dialer_setopt_bool(nng_dialer d, const char *opt, bool bval);
     
    @@ -29,11 +30,11 @@ layout: manpage_v2
     
     int nng_dialer_setopt_ptr(nng_dialer d, const char *opt, void *ptr);
     
    -int nng_dialer_setopt_size(nng_dialer d, const char *opt, size_t z);
    +int nng_dialer_setopt_size(nng_dialer d, const char *opt, size_t z);
     
     int nng_dialer_setopt_string(nng_dialer d, const char *opt, const char *str);
     
    -int nng_dialer_setopt_uint64(nng_dialer d, const char *opt, uint64_t u64);
    +int nng_dialer_setopt_uint64(nng_dialer d, const char *opt, uint64_t u64);
    @@ -41,14 +42,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_dialer_set. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    diff --git a/man/tip/nng_dialer_start.3.html b/man/tip/nng_dialer_start.3.html index 6adfd846..68ff2b65 100644 --- a/man/tip/nng_dialer_start.3.html +++ b/man/tip/nng_dialer_start.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_dialer_start(3) ---

    nng_dialer_start(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_dialer_start(nng_dialer d, int flags);
    diff --git a/man/tip/nng_duration.5.html b/man/tip/nng_duration.5.html index fc812b04..31100ea7 100644 --- a/man/tip/nng_duration.5.html +++ b/man/tip/nng_duration.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_duration(5) ---

    nng_duration(5)

    @@ -16,13 +17,13 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -typedef int32_t nng_duration;
    +
    #include <nng/nng.h>
     
    -#define NNG_DURATION_INFINITE (-1)
    -#define NNG_DURATION_DEFAULT  (-2)
    -#define NNG_DURATION_ZERO     (0)
    +typedef int32_t nng_duration; + +#define NNG_DURATION_INFINITE (-1) +#define NNG_DURATION_DEFAULT (-2) +#define NNG_DURATION_ZERO (0)
    @@ -43,8 +44,7 @@ This type is most often used in conjunction with timers and timeouts.

    NNG_DURATION_DEFAULT

    Indicates a context-specific default value should be used.

    -
    -
    +
    NNG_DURATION_INFINITE

    Effectively an infinite duration; used most often to disable timeouts.

    @@ -55,9 +55,6 @@ This type is most often used in conjunction with timers and timeouts.

    - - -
    diff --git a/man/tip/nng_free.3.html b/man/tip/nng_free.3.html index ad0390ef..e5b94cbf 100644 --- a/man/tip/nng_free.3.html +++ b/man/tip/nng_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_free(3) ---

    nng_free(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -void nng_free(void *ptr, size_t size);
    +
    #include <nng/nng.h>
    +
    +void nng_free(void *ptr, size_t size);
    @@ -53,7 +54,7 @@ used to allocate the memory. Do not attempt to use this function to deallocate memory obtained by a call to the system malloc() or calloc() functions, -or the C++ new operator. +or the C++ new operator. Doing so may result in unpredictable behavior, including corruption of application memory. diff --git a/man/tip/nng_getopt.3.html b/man/tip/nng_getopt.3.html index 9bd3aefa..84cfbcde 100644 --- a/man/tip/nng_getopt.3.html +++ b/man/tip/nng_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_getopt(3) ---

    nng_getopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_getopt(nng_socket s, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_getopt(nng_socket s, const char *opt, void *val, size_t *valszp);
     
     int nng_getopt_bool(nng_socket s, const char *opt, bool *bvalp);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_getopt_ptr(nng_socket s, const char *opt, void **ptr);
     
    -int nng_getopt_size(nng_socket s, const char *opt, size_t *zp);
    +int nng_getopt_size(nng_socket s, const char *opt, size_t *zp);
     
     int nng_getopt_string(nng_socket s, const char *opt, char **strp);
     
    -int nng_getopt_uint64(nng_socket s, const char *opt, uint64_t *u64p);
    +int nng_getopt_uint64(nng_socket s, const char *opt, uint64_t *u64p);
    @@ -40,14 +41,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_socket_get. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    diff --git a/man/tip/nng_http_client_alloc.3http.html b/man/tip/nng_http_client_alloc.3http.html index 9cba3ebf..d11ae1bc 100644 --- a/man/tip/nng_http_client_alloc.3http.html +++ b/man/tip/nng_http_client_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_alloc(3http) ---

    nng_http_client_alloc(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_client_alloc(nng_http_client *clientp, const nng_url *url);
    diff --git a/man/tip/nng_http_client_connect.3http.html b/man/tip/nng_http_client_connect.3http.html index 13a9d27e..e44009e5 100644 --- a/man/tip/nng_http_client_connect.3http.html +++ b/man/tip/nng_http_client_connect.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_connect(3http) ---

    nng_http_client_connect(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_client_connect(nng_http_client *client, nng_aio *aio);
    @@ -114,25 +115,30 @@ obtained by int rv; // Error checks elided for clarity. - nng_url_parse(&url, "http://www.google.com"); - nng_aio_alloc(&aio, NULL, NULL); - nng_http_client_alloc(&client, url); + + nng_url_parse(&url, "http://www.google.com"); + nng_aio_alloc(&aio, NULL, NULL); + nng_http_client_alloc(&client, url); - nng_http_client_connect(client, aio); + nng_http_client_connect(client, aio); // Wait for connection to establish (or attempt to fail). - nng_aio_wait(aio); + + nng_aio_wait(aio); - if ((rv = nng_aio_result(aio)) != 0) { - printf("Connection failed: %s\n", nng_strerror(rv)); + if ((rv = nng_aio_result(aio)) != 0) { + printf("Connection failed: %s\n", nng_strerror(rv)); } else { // Connection established, get it. - conn = nng_aio_get_output(aio, 0); + + conn = nng_aio_get_output(aio, 0); // ... do something with it here - + + // Close the connection when done to avoid leaking it. - nng_http_conn_close(conn); + + nng_http_conn_close(conn); }
    diff --git a/man/tip/nng_http_client_free.3http.html b/man/tip/nng_http_client_free.3http.html index a61ff119..64abfb6d 100644 --- a/man/tip/nng_http_client_free.3http.html +++ b/man/tip/nng_http_client_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_free(3http) ---

    nng_http_client_free(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_client_free(nng_http_client *client);
    diff --git a/man/tip/nng_http_client_get_tls.3http.html b/man/tip/nng_http_client_get_tls.3http.html index 83e5a1f5..8b3d545b 100644 --- a/man/tip/nng_http_client_get_tls.3http.html +++ b/man/tip/nng_http_client_get_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_get_tls(3http) ---

    nng_http_client_get_tls(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_client_get_tls(nng_http_client *client, nng_tls_config **cfgp);
    diff --git a/man/tip/nng_http_client_set_tls.3http.html b/man/tip/nng_http_client_set_tls.3http.html index 3fa775b2..1a587ef2 100644 --- a/man/tip/nng_http_client_set_tls.3http.html +++ b/man/tip/nng_http_client_set_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_set_tls(3http) ---

    nng_http_client_set_tls(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_client_set_tls(nng_http_client *client, nng_tls_config *cfg);
    diff --git a/man/tip/nng_http_client_transact.3http.html b/man/tip/nng_http_client_transact.3http.html index f1985ab3..3b883472 100644 --- a/man/tip/nng_http_client_transact.3http.html +++ b/man/tip/nng_http_client_transact.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_client_transact(3http) ---

    nng_http_client_transact(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_client_transact(nng_http_client *client, nng_http_req *req,
         nng_http_res *res, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_close.3http.html b/man/tip/nng_http_conn_close.3http.html index fd995599..05b75d82 100644 --- a/man/tip/nng_http_conn_close.3http.html +++ b/man/tip/nng_http_conn_close.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_close(3http) ---

    nng_http_conn_close(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_close(nng_http_conn *conn);
    diff --git a/man/tip/nng_http_conn_read.3http.html b/man/tip/nng_http_conn_read.3http.html index b1bd0d53..9e618d8b 100644 --- a/man/tip/nng_http_conn_read.3http.html +++ b/man/tip/nng_http_conn_read.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read(3http) ---

    nng_http_conn_read(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_read(nng_http_conn *conn, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_read_all.3http.html b/man/tip/nng_http_conn_read_all.3http.html index 00246474..c101bdf1 100644 --- a/man/tip/nng_http_conn_read_all.3http.html +++ b/man/tip/nng_http_conn_read_all.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_all(3http) ---

    nng_http_conn_read_all(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_read_all(nng_http_conn *conn, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_read_req.3http.html b/man/tip/nng_http_conn_read_req.3http.html index 220dedbb..fa4f959d 100644 --- a/man/tip/nng_http_conn_read_req.3http.html +++ b/man/tip/nng_http_conn_read_req.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_req(3http) ---

    nng_http_conn_read_req(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_read_req(nng_http_conn *conn, nng_http_req *req,
         nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_read_res.3http.html b/man/tip/nng_http_conn_read_res.3http.html index 472f7656..9132169f 100644 --- a/man/tip/nng_http_conn_read_res.3http.html +++ b/man/tip/nng_http_conn_read_res.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_read_res(3http) ---

    nng_http_conn_read_res(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_read_res(nng_http_conn *conn, nng_http_res *res,
         nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_transact.3http.html b/man/tip/nng_http_conn_transact.3http.html index e8cd4b00..5f72c8cc 100644 --- a/man/tip/nng_http_conn_transact.3http.html +++ b/man/tip/nng_http_conn_transact.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_transact(3http) ---

    nng_http_conn_transact(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_transact(nng_http_conn *conn, nng_http_req *req,
         nng_http_res *res, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_write.3http.html b/man/tip/nng_http_conn_write.3http.html index b4465ae6..06069e00 100644 --- a/man/tip/nng_http_conn_write.3http.html +++ b/man/tip/nng_http_conn_write.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write(3http) ---

    nng_http_conn_write(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_write(nng_http_conn *conn, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_write_all.3http.html b/man/tip/nng_http_conn_write_all.3http.html index 3ff311aa..f1e7d663 100644 --- a/man/tip/nng_http_conn_write_all.3http.html +++ b/man/tip/nng_http_conn_write_all.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_all(3http) ---

    nng_http_conn_write_all(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_write_all(nng_http_conn *conn, nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_write_req.3http.html b/man/tip/nng_http_conn_write_req.3http.html index e9bdad4a..455770f8 100644 --- a/man/tip/nng_http_conn_write_req.3http.html +++ b/man/tip/nng_http_conn_write_req.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_req(3http) ---

    nng_http_conn_write_req(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_write_req(nng_http_conn *conn, nng_http_req *req,
         nng_aio *aio);
    diff --git a/man/tip/nng_http_conn_write_res.3http.html b/man/tip/nng_http_conn_write_res.3http.html index b0946a06..3ae9c946 100644 --- a/man/tip/nng_http_conn_write_res.3http.html +++ b/man/tip/nng_http_conn_write_res.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_conn_write_res(3http) ---

    nng_http_conn_write_res(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_conn_write_res(nng_http_conn *conn, nng_http_res *res,
         nng_aio *aio);
    diff --git a/man/tip/nng_http_handler_alloc.3http.html b/man/tip/nng_http_handler_alloc.3http.html index 9b68cc64..89cd6e76 100644 --- a/man/tip/nng_http_handler_alloc.3http.html +++ b/man/tip/nng_http_handler_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_alloc(3http) ---

    nng_http_handler_alloc(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     typedef struct nng_http_handler nng_http_handler;
     
     int nng_http_handler_alloc(nng_http_handler **hp, const char *path,
    @@ -31,10 +32,10 @@ layout: manpage_v2
         const char *filename);
     
     int nng_http_handler_alloc_redirect(nng_http_handler **hp, const char *path,
    -    uint16_t status, const char *location);
    +    uint16_t status, const char *location);
     
     int nng_http_handler_alloc_static(nng_http_handler **hp, const char *path,
    -    const void *data, size_t size, const char *content_type);
    + const void *data, size_t size, const char *content_type);
    @@ -58,7 +59,7 @@ considered when determining whether the handler should be called.

    Additionally each handler has a method it is registered to handle (the default is GET, see nng_http_handler_set_method()), and -optionally a 'Host' header it can be matched against (see +optionally a 'Host' header it can be matched against (see nng_http_handler_set_host()).

    diff --git a/man/tip/nng_http_handler_collect_body.3http.html b/man/tip/nng_http_handler_collect_body.3http.html index 08ffbfb1..2d200e6c 100644 --- a/man/tip/nng_http_handler_collect_body.3http.html +++ b/man/tip/nng_http_handler_collect_body.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_collect_body(3http) ---

    nng_http_handler_collect_body(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_handler_collect_body(nng_http_handler *handler, bool want, size_t maxsz);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_handler_collect_body(nng_http_handler *handler, bool want, size_t maxsz);
    diff --git a/man/tip/nng_http_handler_free.3http.html b/man/tip/nng_http_handler_free.3http.html index 6a9150d8..7625e799 100644 --- a/man/tip/nng_http_handler_free.3http.html +++ b/man/tip/nng_http_handler_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_free(3http) ---

    nng_http_handler_free(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_handler_free(nng_http_handler *h);
    diff --git a/man/tip/nng_http_handler_get_data.3http.html b/man/tip/nng_http_handler_get_data.3http.html index 3396c682..79fef724 100644 --- a/man/tip/nng_http_handler_get_data.3http.html +++ b/man/tip/nng_http_handler_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_get_data(3http) ---

    nng_http_handler_get_data(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void *nng_http_handler_get_data(nng_http_handler *handler);
    diff --git a/man/tip/nng_http_handler_set_data.3http.html b/man/tip/nng_http_handler_set_data.3http.html index c11fdd4c..4ff53cfa 100644 --- a/man/tip/nng_http_handler_set_data.3http.html +++ b/man/tip/nng_http_handler_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_data(3http) ---

    nng_http_handler_set_data(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_handler_set_data(nng_http_handler *handler, void *data,
         void (*dtor)(void *));
    diff --git a/man/tip/nng_http_handler_set_host.3http.html b/man/tip/nng_http_handler_set_host.3http.html index 07f4ca70..3e8c1138 100644 --- a/man/tip/nng_http_handler_set_host.3http.html +++ b/man/tip/nng_http_handler_set_host.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_host(3http) ---

    nng_http_handler_set_host(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_handler_set_host(nng_http_handler *handler, const char *host);
    diff --git a/man/tip/nng_http_handler_set_method.3http.html b/man/tip/nng_http_handler_set_method.3http.html index 4062a557..f45233e6 100644 --- a/man/tip/nng_http_handler_set_method.3http.html +++ b/man/tip/nng_http_handler_set_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_method(3http) ---

    nng_http_handler_set_method(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_handler_set_method(nng_http_handler *handler, const char *method);
    @@ -29,8 +30,8 @@ layout: manpage_v2

    The nng_http_handler_set_method() function sets the method that the -handler will be called for, such as "GET" or "POST". -(By default the "GET" method is handled.) +handler will be called for, such as "GET" or "POST". +(By default the "GET" method is handled.) If method is NULL, then the request method is not examined, and the handler will be executed regardless of the method.

    @@ -42,8 +43,8 @@ method.

    -The server will automatically call "GET" handlers if the client -sends a "HEAD" request, and will suppress HTTP body data in the responses +The server will automatically call "GET" handlers if the client +sends a "HEAD" request, and will suppress HTTP body data in the responses sent for such requests. diff --git a/man/tip/nng_http_handler_set_tree.3http.html b/man/tip/nng_http_handler_set_tree.3http.html index 3d10221c..4dbdd8fe 100644 --- a/man/tip/nng_http_handler_set_tree.3http.html +++ b/man/tip/nng_http_handler_set_tree.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_handler_set_tree(3http) ---

    nng_http_handler_set_tree(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_handler_set_tree(nng_http_handler *handler);
     
     int nng_http_handler_set_tree_exclusive(nng_http_handler *handler);
    diff --git a/man/tip/nng_http_hijack.3http.html b/man/tip/nng_http_hijack.3http.html index 60844405..fbb8fee1 100644 --- a/man/tip/nng_http_hijack.3http.html +++ b/man/tip/nng_http_hijack.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_hijack(3http) ---

    nng_http_hijack(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_hijack(nng_http_conn *conn);
    diff --git a/man/tip/nng_http_req_add_header.3http.html b/man/tip/nng_http_req_add_header.3http.html index 1eb8547c..e7af8c13 100644 --- a/man/tip/nng_http_req_add_header.3http.html +++ b/man/tip/nng_http_req_add_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_add_header(3http) ---

    nng_http_req_add_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_add_header(nng_http_req *req, const char *key,
         const char *val);
    diff --git a/man/tip/nng_http_req_alloc.3http.html b/man/tip/nng_http_req_alloc.3http.html index 963aac5c..63d5e719 100644 --- a/man/tip/nng_http_req_alloc.3http.html +++ b/man/tip/nng_http_req_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_alloc(3http) ---

    nng_http_req_alloc(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_alloc(nng_http_req **reqp, const nng_url *url);
    diff --git a/man/tip/nng_http_req_copy_data.3http.html b/man/tip/nng_http_req_copy_data.3http.html index d26f7e0d..1fdc3226 100644 --- a/man/tip/nng_http_req_copy_data.3http.html +++ b/man/tip/nng_http_req_copy_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_copy_data(3http) ---

    nng_http_req_copy_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_req_copy_data(nng_http_req *req, const void *body, size_t size);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_req_copy_data(nng_http_req *req, const void *body, size_t size);
    diff --git a/man/tip/nng_http_req_del_header.3http.html b/man/tip/nng_http_req_del_header.3http.html index 1874efeb..39065466 100644 --- a/man/tip/nng_http_req_del_header.3http.html +++ b/man/tip/nng_http_req_del_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_del_header(3http) ---

    nng_http_req_del_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_del_header(nng_http_req *req, const char *key);
    diff --git a/man/tip/nng_http_req_free.3http.html b/man/tip/nng_http_req_free.3http.html index 63228e2f..168bd434 100644 --- a/man/tip/nng_http_req_free.3http.html +++ b/man/tip/nng_http_req_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_free(3http) ---

    nng_http_req_free(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_req_free(nng_http_req *req);
    diff --git a/man/tip/nng_http_req_get_data.3http.html b/man/tip/nng_http_req_get_data.3http.html index 1e1b52cf..b1e5931a 100644 --- a/man/tip/nng_http_req_get_data.3http.html +++ b/man/tip/nng_http_req_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_data(3http) ---

    nng_http_req_get_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -void nng_http_req_get_data(nng_http_req *req, void **bodyp, size_t *sizep);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +void nng_http_req_get_data(nng_http_req *req, void **bodyp, size_t *sizep);
    diff --git a/man/tip/nng_http_req_get_header.3http.html b/man/tip/nng_http_req_get_header.3http.html index e3759f6d..a5470296 100644 --- a/man/tip/nng_http_req_get_header.3http.html +++ b/man/tip/nng_http_req_get_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_header(3http) ---

    nng_http_req_get_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_req_get_header(nng_http_req *req, const char *key);
    diff --git a/man/tip/nng_http_req_get_method.3http.html b/man/tip/nng_http_req_get_method.3http.html index 5640af89..df575784 100644 --- a/man/tip/nng_http_req_get_method.3http.html +++ b/man/tip/nng_http_req_get_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_method(3http) ---

    nng_http_req_get_method(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_req_get_method(nng_http_req *req);
    @@ -30,7 +31,7 @@ layout: manpage_v2

    The nng_http_req_get_method() returns the HTTP method associated with the request req. -The value will be a string, such as "GET" or "POST".

    +The value will be a string, such as "GET" or "POST".

    diff --git a/man/tip/nng_http_req_get_uri.3http.html b/man/tip/nng_http_req_get_uri.3http.html index d2fdb5ef..9a5a12ea 100644 --- a/man/tip/nng_http_req_get_uri.3http.html +++ b/man/tip/nng_http_req_get_uri.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_uri(3http) ---

    nng_http_req_get_uri(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_req_get_uri(nng_http_req *req);
    diff --git a/man/tip/nng_http_req_get_version.3http.html b/man/tip/nng_http_req_get_version.3http.html index b333ec3e..0adfec6f 100644 --- a/man/tip/nng_http_req_get_version.3http.html +++ b/man/tip/nng_http_req_get_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_get_version(3http) ---

    nng_http_req_get_version(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_req_get_version(nng_http_req *req);
    @@ -29,7 +30,7 @@ layout: manpage_v2

    The nng_http_req_get_version() returns a string representing the HTTP -protocol version associated with the request req, such as "HTTP/1.1".

    +protocol version associated with the request req, such as "HTTP/1.1".

    diff --git a/man/tip/nng_http_req_reset.3http.html b/man/tip/nng_http_req_reset.3http.html index 6a3b1ab1..d7984f66 100644 --- a/man/tip/nng_http_req_reset.3http.html +++ b/man/tip/nng_http_req_reset.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_reset(3http) ---

    nng_http_req_reset(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_req_reset(nng_http_req *req);
    diff --git a/man/tip/nng_http_req_set_data.3http.html b/man/tip/nng_http_req_set_data.3http.html index 9e98bb30..7d6f0b45 100644 --- a/man/tip/nng_http_req_set_data.3http.html +++ b/man/tip/nng_http_req_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_data(3http) ---

    nng_http_req_set_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_req_set_data(nng_http_req *req, const void *body, size_t size);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_req_set_data(nng_http_req *req, const void *body, size_t size);
    diff --git a/man/tip/nng_http_req_set_header.3http.html b/man/tip/nng_http_req_set_header.3http.html index 41fae4e3..6eacd2c3 100644 --- a/man/tip/nng_http_req_set_header.3http.html +++ b/man/tip/nng_http_req_set_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_header(3http) ---

    nng_http_req_set_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_set_header(nng_http_req *req, const char *key,
         const char *val);
    diff --git a/man/tip/nng_http_req_set_method.3http.html b/man/tip/nng_http_req_set_method.3http.html index 74270b09..d40a3c93 100644 --- a/man/tip/nng_http_req_set_method.3http.html +++ b/man/tip/nng_http_req_set_method.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_method(3http) ---

    nng_http_req_set_method(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_set_method(nng_http_req *req, const char *method);
    @@ -30,11 +31,11 @@ layout: manpage_v2

    The nng_http_req_set_method() sets the HTTP method associated with the request req to method. The method must be a string, -such as "GET" or "POST", and the HTTP specifications indicate that it must +such as "GET" or "POST", and the HTTP specifications indicate that it must be upper case.

    -

    The default value method for newly allocated requests is "GET".

    +

    The default value method for newly allocated requests is "GET".

    A local copy of the method is made in the request req.

    diff --git a/man/tip/nng_http_req_set_uri.3http.html b/man/tip/nng_http_req_set_uri.3http.html index 796e0979..62b515ae 100644 --- a/man/tip/nng_http_req_set_uri.3http.html +++ b/man/tip/nng_http_req_set_uri.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_uri(3http) ---

    nng_http_req_set_uri(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_set_uri(nng_http_req *req, const char *uri);
    diff --git a/man/tip/nng_http_req_set_version.3http.html b/man/tip/nng_http_req_set_version.3http.html index b11e8bc7..4afacea8 100644 --- a/man/tip/nng_http_req_set_version.3http.html +++ b/man/tip/nng_http_req_set_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_req_set_version(3http) ---

    nng_http_req_set_version(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_req_set_version(nng_http_req *req, const char *version);
    @@ -31,8 +32,8 @@ layout: manpage_v2

    The nng_http_req_set_version() sets the HTTP protocol version associated with the request req to version. The version must be a string containing -a valid HTTP protocol version, such as "HTTP/1.0". -The default value is "HTTP/1.1".

    +a valid HTTP protocol version, such as "HTTP/1.0". +The default value is "HTTP/1.1".

    A local copy of the version is made in the request req.

    @@ -57,7 +58,7 @@ No validation of the version supplied is performed. The library does not contain support for versions of HTTP other than -"HTTP/1.0" and "HTTP/1.1". +"HTTP/1.0" and "HTTP/1.1". Specifying any other version may result in unspecified behavior. diff --git a/man/tip/nng_http_res_add_header.3http.html b/man/tip/nng_http_res_add_header.3http.html index b50fc473..58860793 100644 --- a/man/tip/nng_http_res_add_header.3http.html +++ b/man/tip/nng_http_res_add_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_add_header(3http) ---

    nng_http_res_add_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_add_header(nng_http_res *res, const char *key,
         const char *val);
    diff --git a/man/tip/nng_http_res_alloc.3http.html b/man/tip/nng_http_res_alloc.3http.html index 47ff32d0..4d3e48c9 100644 --- a/man/tip/nng_http_res_alloc.3http.html +++ b/man/tip/nng_http_res_alloc.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_alloc(3http) ---

    nng_http_res_alloc(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_alloc(nng_http_res **resp);
    diff --git a/man/tip/nng_http_res_alloc_error.3http.html b/man/tip/nng_http_res_alloc_error.3http.html index 35d69de2..32457382 100644 --- a/man/tip/nng_http_res_alloc_error.3http.html +++ b/man/tip/nng_http_res_alloc_error.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_alloc_error(3http) ---

    nng_http_res_alloc_error(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_res_alloc_error(nng_http_res **resp, uint16_t status);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_res_alloc_error(nng_http_res **resp, uint16_t status);
    @@ -36,7 +37,7 @@ a simple HTML page containing the same information will be generated and attached to the response. (Relevant HTTP headers will be set as well, such as Content-Type and Content-Length.) -The HTTP protocol version is also set to "HTTP/1.1".

    +The HTTP protocol version is also set to "HTTP/1.1".

    diff --git a/man/tip/nng_http_res_copy_data.3http.html b/man/tip/nng_http_res_copy_data.3http.html index eec3510f..9622b1e1 100644 --- a/man/tip/nng_http_res_copy_data.3http.html +++ b/man/tip/nng_http_res_copy_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_copy_data(3http) ---

    nng_http_res_copy_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_res_copy_data(nng_http_res *res, const void *body, size_t size);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_res_copy_data(nng_http_res *res, const void *body, size_t size);
    diff --git a/man/tip/nng_http_res_del_header.3http.html b/man/tip/nng_http_res_del_header.3http.html index c5217922..d887bab5 100644 --- a/man/tip/nng_http_res_del_header.3http.html +++ b/man/tip/nng_http_res_del_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_del_header(3http) ---

    nng_http_res_del_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_del_header(nng_http_res *res, const char *key);
    diff --git a/man/tip/nng_http_res_free.3http.html b/man/tip/nng_http_res_free.3http.html index 85c36f7c..cb245599 100644 --- a/man/tip/nng_http_res_free.3http.html +++ b/man/tip/nng_http_res_free.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_free(3http) ---

    nng_http_res_free(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_res_free(nng_http_res *req);
    diff --git a/man/tip/nng_http_res_get_data.3http.html b/man/tip/nng_http_res_get_data.3http.html index a899854c..9a2a06ad 100644 --- a/man/tip/nng_http_res_get_data.3http.html +++ b/man/tip/nng_http_res_get_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_data(3http) ---

    nng_http_res_get_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -void nng_http_res_get_data(nng_http_res *res, void **bodyp, size_t *sizep);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +void nng_http_res_get_data(nng_http_res *res, void **bodyp, size_t *sizep);
    diff --git a/man/tip/nng_http_res_get_header.3http.html b/man/tip/nng_http_res_get_header.3http.html index dcc65cc1..9102ad29 100644 --- a/man/tip/nng_http_res_get_header.3http.html +++ b/man/tip/nng_http_res_get_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_header(3http) ---

    nng_http_res_get_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_res_get_header(nng_http_res *res, const char *key);
    diff --git a/man/tip/nng_http_res_get_reason.3http.html b/man/tip/nng_http_res_get_reason.3http.html index e985c7b0..4a5f4162 100644 --- a/man/tip/nng_http_res_get_reason.3http.html +++ b/man/tip/nng_http_res_get_reason.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_reason(3http) ---

    nng_http_res_get_reason(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_res_get_reason(nng_http_res *res);
    diff --git a/man/tip/nng_http_res_get_status.3http.html b/man/tip/nng_http_res_get_status.3http.html index 7f8ca842..259b5ea0 100644 --- a/man/tip/nng_http_res_get_status.3http.html +++ b/man/tip/nng_http_res_get_status.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_status(3http) ---

    nng_http_res_get_status(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -uint16_t nng_http_res_get_status(nng_http_res *res);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +uint16_t nng_http_res_get_status(nng_http_res *res);
    diff --git a/man/tip/nng_http_res_get_version.3http.html b/man/tip/nng_http_res_get_version.3http.html index ad1156f8..f8cf0ff7 100644 --- a/man/tip/nng_http_res_get_version.3http.html +++ b/man/tip/nng_http_res_get_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_get_version(3http) ---

    nng_http_res_get_version(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     const char *nng_http_res_get_version(nng_http_res *res);
    @@ -29,7 +30,7 @@ layout: manpage_v2

    The nng_http_res_get_version() returns a string representing the HTTP -protocol version associated with the request res, such as "HTTP/1.1".

    +protocol version associated with the request res, such as "HTTP/1.1".

    diff --git a/man/tip/nng_http_res_reset.3http.html b/man/tip/nng_http_res_reset.3http.html index 1947bbd3..b8e345b9 100644 --- a/man/tip/nng_http_res_reset.3http.html +++ b/man/tip/nng_http_res_reset.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_reset(3http) ---

    nng_http_res_reset(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_res_reset(nng_http_res *res);
    diff --git a/man/tip/nng_http_res_set_data.3http.html b/man/tip/nng_http_res_set_data.3http.html index 9e426dd6..257e185e 100644 --- a/man/tip/nng_http_res_set_data.3http.html +++ b/man/tip/nng_http_res_set_data.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_data(3http) ---

    nng_http_res_set_data(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_res_set_data(nng_http_res *res, const void *body, size_t size);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_res_set_data(nng_http_res *res, const void *body, size_t size);
    diff --git a/man/tip/nng_http_res_set_header.3http.html b/man/tip/nng_http_res_set_header.3http.html index 7bd7ebfd..fc888922 100644 --- a/man/tip/nng_http_res_set_header.3http.html +++ b/man/tip/nng_http_res_set_header.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_header(3http) ---

    nng_http_res_set_header(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_set_header(nng_http_res *res, const char *key,
         const char *val);
    diff --git a/man/tip/nng_http_res_set_reason.3http.html b/man/tip/nng_http_res_set_reason.3http.html index 22d3309b..105dcc5e 100644 --- a/man/tip/nng_http_res_set_reason.3http.html +++ b/man/tip/nng_http_res_set_reason.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_reason(3http) ---

    nng_http_res_set_reason(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_set_reason(nng_http_res *res, const char *reason);
    diff --git a/man/tip/nng_http_res_set_status.3http.html b/man/tip/nng_http_res_set_status.3http.html index de753733..edda0df5 100644 --- a/man/tip/nng_http_res_set_status.3http.html +++ b/man/tip/nng_http_res_set_status.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_status(3http) ---

    nng_http_res_set_status(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_res_set_status(nng_http_res *res, uint16_t status);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_res_set_status(nng_http_res *res, uint16_t status);
    diff --git a/man/tip/nng_http_res_set_version.3http.html b/man/tip/nng_http_res_set_version.3http.html index 35ab91b1..453f4f20 100644 --- a/man/tip/nng_http_res_set_version.3http.html +++ b/man/tip/nng_http_res_set_version.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_res_set_version(3http) ---

    nng_http_res_set_version(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_res_set_version(nng_http_res *res, const char *version);
    @@ -31,8 +32,8 @@ layout: manpage_v2

    The nng_http_res_set_version() sets the HTTP protocol version associated with the response res to version. The version must be a string containing -a valid HTTP protocol version, such as "HTTP/1.0". -The default value is "HTTP/1.1".

    +a valid HTTP protocol version, such as "HTTP/1.0". +The default value is "HTTP/1.1".

    A local copy of the version is made in the response res.

    @@ -57,7 +58,7 @@ No validation of the version supplied is performed.
    diff --git a/man/tip/nng_http_server_add_handler.3http.html b/man/tip/nng_http_server_add_handler.3http.html index f6017319..e5906600 100644 --- a/man/tip/nng_http_server_add_handler.3http.html +++ b/man/tip/nng_http_server_add_handler.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_add_handler(3http) ---

    nng_http_server_add_handler(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_add_handler(nng_http_server *s, nng_http_handler *h);
    diff --git a/man/tip/nng_http_server_del_handler.3http.html b/man/tip/nng_http_server_del_handler.3http.html index b50e556c..deb3eade 100644 --- a/man/tip/nng_http_server_del_handler.3http.html +++ b/man/tip/nng_http_server_del_handler.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_del_handler(3http) ---

    nng_http_server_del_handler(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_del_handler(nng_http_server *s, nng_http_handler *h);
    diff --git a/man/tip/nng_http_server_get_addr.3http.html b/man/tip/nng_http_server_get_addr.3http.html index 71e7b324..1807c429 100644 --- a/man/tip/nng_http_server_get_addr.3http.html +++ b/man/tip/nng_http_server_get_addr.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_get_addr(3http) ---

    nng_http_server_get_addr(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_get_addr(nng_http_server *server, nng_sockaddr *sap);
    diff --git a/man/tip/nng_http_server_get_tls.3http.html b/man/tip/nng_http_server_get_tls.3http.html index 2ad0706b..b437fd8d 100644 --- a/man/tip/nng_http_server_get_tls.3http.html +++ b/man/tip/nng_http_server_get_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_get_tls(3http) ---

    nng_http_server_get_tls(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_get_tls(nng_http_server *s, nng_tls_config **cfgp);
    diff --git a/man/tip/nng_http_server_hold.3http.html b/man/tip/nng_http_server_hold.3http.html index c7f1ff68..0058f21c 100644 --- a/man/tip/nng_http_server_hold.3http.html +++ b/man/tip/nng_http_server_hold.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_hold(3http) ---

    nng_http_server_hold(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_hold(nng_http_server **serverp, const nng_url *url);
    diff --git a/man/tip/nng_http_server_release.3http.html b/man/tip/nng_http_server_release.3http.html index f71c0e88..d1d2197c 100644 --- a/man/tip/nng_http_server_release.3http.html +++ b/man/tip/nng_http_server_release.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_release(3http) ---

    nng_http_server_release(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_server_release(nng_http_server *server);
    @@ -36,7 +37,7 @@ that was previously held with

    This effectively drops the reference count on the server instance. When the reference count drops to zero, then the server and all resources associated with it (e.g. HTTP handlers, connections, etc.) are deallocated. -(If the server is "running" when this occurs, then the server is stopped.)

    +(If the server is "running" when this occurs, then the server is stopped.)

    The library does not contain support for versions of HTTP other than -"HTTP/1.0" and "HTTP/1.1". +"HTTP/1.0" and "HTTP/1.1". Specifying any other version may result in unspecified behavior.
    diff --git a/man/tip/nng_http_server_res_error.3http.html b/man/tip/nng_http_server_res_error.3http.html index e22e0cde..089af340 100644 --- a/man/tip/nng_http_server_res_error.3http.html +++ b/man/tip/nng_http_server_res_error.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_res_error(3http) ---

    nng_http_server_res_error(3http)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    -int nng_http_server_res_error(nng_http_server *server, 
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
    +int nng_http_server_res_error(nng_http_server *server,
             nng_http_res *response);
    @@ -30,7 +31,7 @@ layout: manpage_v2

    The nng_http_server_res_error() sets the body of response -to server's error page, which may have been customized using the +to server's error page, which may have been customized using the nng_http_server_error_file() or nng_http_server_error_page() diff --git a/man/tip/nng_http_server_set_error_file.3http.html b/man/tip/nng_http_server_set_error_file.3http.html index d60d691e..aced4e28 100644 --- a/man/tip/nng_http_server_set_error_file.3http.html +++ b/man/tip/nng_http_server_set_error_file.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_error_file(3http) ---

    nng_http_server_set_error_file(3http)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_set_error_file(nng_http_server *server,
    -        uint16_t code, const char *path);
    + uint16_t code, const char *path);
    diff --git a/man/tip/nng_http_server_set_error_page.3http.html b/man/tip/nng_http_server_set_error_page.3http.html index 0a08ae28..b5ab9aa3 100644 --- a/man/tip/nng_http_server_set_error_page.3http.html +++ b/man/tip/nng_http_server_set_error_page.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_error_page(3http) ---

    nng_http_server_set_error_page(3http)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_set_error_page(nng_http_server *server,
    -        uint16_t code, const char *html);
    + uint16_t code, const char *html);
    diff --git a/man/tip/nng_http_server_set_tls.3http.html b/man/tip/nng_http_server_set_tls.3http.html index 7db9bf4d..97c967d1 100644 --- a/man/tip/nng_http_server_set_tls.3http.html +++ b/man/tip/nng_http_server_set_tls.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_set_tls(3http) ---

    nng_http_server_set_tls(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_set_tls(nng_http_server *s, nng_tls_config *cfg);
    diff --git a/man/tip/nng_http_server_start.3http.html b/man/tip/nng_http_server_start.3http.html index a47e36e9..0dff888d 100644 --- a/man/tip/nng_http_server_start.3http.html +++ b/man/tip/nng_http_server_start.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_start(3http) ---

    nng_http_server_start(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     int nng_http_server_start(nng_http_server *server);
    diff --git a/man/tip/nng_http_server_stop.3http.html b/man/tip/nng_http_server_stop.3http.html index 6c0ccb9e..c5c16eee 100644 --- a/man/tip/nng_http_server_stop.3http.html +++ b/man/tip/nng_http_server_stop.3http.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_http_server_stop(3http) ---

    nng_http_server_stop(3http)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/http/http.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/http/http.h>
    +
     void nng_http_server_stop(nng_http_server *server);
    diff --git a/man/tip/nng_inproc.7.html b/man/tip/nng_inproc.7.html index aefe9260..f418548e 100644 --- a/man/tip/nng_inproc.7.html +++ b/man/tip/nng_inproc.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_inproc(7) ---

    nng_inproc(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/inproc/inproc.h>
    -
    +
    #include <nng/transport/inproc/inproc.h>
    +
     int nng_inproc_register(void);
    diff --git a/man/tip/nng_inproc_register.3.html b/man/tip/nng_inproc_register.3.html index 3e03f14c..8fc75327 100644 --- a/man/tip/nng_inproc_register.3.html +++ b/man/tip/nng_inproc_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_inproc_register(3) ---

    nng_inproc_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/inproc/inproc.h>
    -
    +
    #include <nng/transport/inproc/inproc.h>
    +
     int nng_inproc_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_inproc_register() function registers the inproc transport(transport, inproc) for use.

    +
    +
    + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nng_iov.5.html b/man/tip/nng_iov.5.html index 9f69d02b..fac3ab6d 100644 --- a/man/tip/nng_iov.5.html +++ b/man/tip/nng_iov.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_iov(5) ---

    nng_iov(5)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct {
         void * iov_buf;
    -    size_t iov_len;
    +    size_t iov_len;
     } nng_iov;
    @@ -50,7 +51,7 @@ an nng_aio structure using the
    iov_buf

    This is a pointer to the first byte within the memory being - referenced by this scatter/gather element.

    +referenced by this scatter/gather element.

    iov_len
    diff --git a/man/tip/nng_ipc.7.html b/man/tip/nng_ipc.7.html index ed2c43cc..c872246c 100644 --- a/man/tip/nng_ipc.7.html +++ b/man/tip/nng_ipc.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc(7) ---

    nng_ipc(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/ipc/ipc.h>
    -
    +
    #include <nng/transport/ipc/ipc.h>
    +
     int nng_ipc_register(void);
    @@ -120,7 +121,7 @@ the Named Pipes and the AF_UNIX based transports.

    On Linux, this transport also can support abstract sockets. Abstract sockets use a URI-encoded name after the scheme, which allows arbitrary values to be conveyed in the path, including embedded NUL bytes. -For example, the name "a\0b" would be represented as abstract://a%00b.

    +For example, the name ”a\0b“ would be represented as abstract://a%00b.

    diff --git a/man/tip/nng_ipc_options.5.html b/man/tip/nng_ipc_options.5.html index 85311c46..e7c91d49 100644 --- a/man/tip/nng_ipc_options.5.html +++ b/man/tip/nng_ipc_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc_options(5) ---

    nng_ipc_options(5)

    @@ -16,14 +17,14 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -#define NNG_OPT_IPC_PEER_GID            "ipc:peer-gid"
    -#define NNG_OPT_IPC_PEER_PID            "ipc:peer-pid"
    -#define NNG_OPT_IPC_PEER_UID            "ipc:peer-uid"
    -#define NNG_OPT_IPC_PEER_ZONEID         "ipc:peer-zoneid"
    -#define NNG_OPT_IPC_PERMISSIONS         "ipc:permissions"
    -#define NNG_OPT_IPC_SECURITY_DESCRIPTOR "ipc:security-descriptor"
    +
    #include <nng/nng.h>
    +
    +#define NNG_OPT_IPC_PEER_GID            "ipc:peer-gid"
    +#define NNG_OPT_IPC_PEER_PID            "ipc:peer-pid"
    +#define NNG_OPT_IPC_PEER_UID            "ipc:peer-uid"
    +#define NNG_OPT_IPC_PEER_ZONEID         "ipc:peer-zoneid"
    +#define NNG_OPT_IPC_PERMISSIONS         "ipc:permissions"
    +#define NNG_OPT_IPC_SECURITY_DESCRIPTOR "ipc:security-descriptor"
    @@ -65,7 +66,7 @@ as the implementations of IPC are quite different on Windows and POSIX systems.

    IPC Options

    -
    [[NNG_OPT_IPC_PEER_GID]]NNG_OPT_IPC_PEER_GID
    +
    NNG_OPT_IPC_PEER_GID

    (uint64_t) This read-only option provides a connected peer’s primary @@ -74,7 +75,7 @@ This is the effective group id of the peer when either the underlying listen() or connect() calls were made, and is not forgeable. This option is generally only available on POSIX systems.

    -
    [[NNG_OPT_IPC_PEER_PID]]NNG_OPT_IPC_PEER_PID
    +
    NNG_OPT_IPC_PEER_PID

    (uint64_t) This read-only option provides the the process id @@ -97,7 +98,7 @@ of a well-behaved one using this method.

    -
    [[NNG_OPT_IPC_PEER_UID]]NNG_OPT_IPC_PEER_UID
    +
    NNG_OPT_IPC_PEER_UID

    (uint64_t) This read-only option provides a connected peer’s user id. @@ -105,13 +106,13 @@ This is the effective user id of the peer when either the underlying listen() or connect() calls were made, and is not forgeable. This option is generally only available on POSIX systems.

    -
    [[NNG_OPT_IPC_PEER_ZONEID]]NNG_OPT_IPC_PEER_ZONEID
    +
    NNG_OPT_IPC_PEER_ZONEID

    (uint64_t) This read-only option provides a connected peer’s the zone id. Zones (and this option) are only supported on Solaris and illumos systems.

    -
    [[NNG_OPT_IPC_PERMISSIONS]]NNG_OPT_IPC_PERMISSIONS
    +
    NNG_OPT_IPC_PERMISSIONS

    (int) This write-only option may be applied to a listener to configure the @@ -179,7 +180,7 @@ permission.

    -
    [[NNG_OPT_IPC_SECURITY_DESCRIPTOR]]NNG_OPT_IPC_SECURITY_DESCRIPTOR
    +
    NNG_OPT_IPC_SECURITY_DESCRIPTOR

    (PSECURITY_DESCRIPTOR) This write-only option may be used on listeners on Windows platforms to diff --git a/man/tip/nng_ipc_register.3.html b/man/tip/nng_ipc_register.3.html index a6fa689b..628f1a25 100644 --- a/man/tip/nng_ipc_register.3.html +++ b/man/tip/nng_ipc_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ipc_register(3) ---

    nng_ipc_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/ipc/ipc.h>
    -
    +
    #include <nng/transport/ipc/ipc.h>
    +
     int nng_ipc_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_ipc_register() function registers the ipc transport(transport, ipc) for use.

    +
    + + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nng_listen.3.html b/man/tip/nng_listen.3.html index aa2f3ebd..f63d5157 100644 --- a/man/tip/nng_listen.3.html +++ b/man/tip/nng_listen.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listen(3) ---

    nng_listen(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listen(nng_socket s, const char *url, nng_listener *lp, int flags);
    @@ -35,7 +36,7 @@ the newly created listener is stored at the address indicated by lp.

    Listeners are used to accept connections initiated by remote dialers. -An incoming connection generally results in and +An incoming connection generally results in an nng_pipe object being created and attached to the socket s. Unlike dialers, listeners generally can create many pipes, which may be open concurrently.

    diff --git a/man/tip/nng_listener.5.html b/man/tip/nng_listener.5.html index afdb98a5..e8d51198 100644 --- a/man/tip/nng_listener.5.html +++ b/man/tip/nng_listener.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener(5) ---

    nng_listener(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_listener_s nng_listener;
    diff --git a/man/tip/nng_listener_close.3.html b/man/tip/nng_listener_close.3.html index 9f897fdb..58aa2de5 100644 --- a/man/tip/nng_listener_close.3.html +++ b/man/tip/nng_listener_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_close(3) ---

    nng_listener_close(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listener_close(nng_listener l);
    diff --git a/man/tip/nng_listener_create.3.html b/man/tip/nng_listener_create.3.html index 7353e963..7654aa16 100644 --- a/man/tip/nng_listener_create.3.html +++ b/man/tip/nng_listener_create.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_create(3) ---

    nng_listener_create(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listener_create(nng_listener *listenerp, nng_socket s, const char *url);
    diff --git a/man/tip/nng_listener_get.3.html b/man/tip/nng_listener_get.3.html index b060d64e..93a7ee4f 100644 --- a/man/tip/nng_listener_get.3.html +++ b/man/tip/nng_listener_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_get(3) ---

    nng_listener_get(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_listener_get(nng_listener l, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_listener_get(nng_listener l, const char *opt, void *val, size_t *valszp);
     
     int nng_listener_get_bool(nng_listener l, const char *opt, bool *bvalp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_listener_get_ptr(nng_listener l, const char *opt, void **ptr);
     
    -int nng_listener_get_size(nng_listener l, const char *opt, size_t *zp);
    +int nng_listener_get_size(nng_listener l, const char *opt, size_t *zp);
     
     int nng_listener_get_addr(nng_listener l, const char *opt, nng_sockaddr *sap);
     
     int nng_listener_get_string(nng_listener l, const char *opt, char **strp);
     
    -int nng_listener_get_uint64(nng_listener l, const char *opt, uint64_t *u64p);
    +int nng_listener_get_uint64(nng_listener l, const char *opt, uint64_t *u64p);
    @@ -49,8 +50,7 @@ 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 and protocols themselves.

    +

    Additionally some transport-specific options are documented with the transports themselves.

    Forms

    diff --git a/man/tip/nng_listener_getopt.3.html b/man/tip/nng_listener_getopt.3.html index 823a78f5..d0049b84 100644 --- a/man/tip/nng_listener_getopt.3.html +++ b/man/tip/nng_listener_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_getopt(3) ---

    nng_listener_getopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_listener_getopt(nng_listener l, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_listener_getopt(nng_listener l, const char *opt, void *val, size_t *valszp);
     
     int nng_listener_getopt_bool(nng_listener l, const char *opt, bool *bvalp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_listener_getopt_ptr(nng_listener l, const char *opt, void **ptr);
     
    -int nng_listener_getopt_size(nng_listener l, const char *opt, size_t *zp);
    +int nng_listener_getopt_size(nng_listener l, const char *opt, size_t *zp);
     
     int nng_listener_getopt_sockaddr(nng_listener l, const char *opt, nng_sockaddr *sap);
     
     int nng_listener_getopt_string(nng_listener l, const char *opt, char **strp);
     
    -int nng_listener_getopt_uint64(nng_listener l, const char *opt, uint64_t *u64p);
    +int nng_listener_getopt_uint64(nng_listener l, const char *opt, uint64_t *u64p);
    @@ -42,14 +43,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_listener_get. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    @@ -61,8 +63,8 @@ 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 and protocols themselves.

    +

    Additionally some transport-specific options +are documented with the transports themselves.

    Forms

    diff --git a/man/tip/nng_listener_id.3.html b/man/tip/nng_listener_id.3.html index c48e8ce6..23233dc9 100644 --- a/man/tip/nng_listener_id.3.html +++ b/man/tip/nng_listener_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_id(3) ---

    nng_listener_id(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listener_id(nng_listener l);
    diff --git a/man/tip/nng_listener_set.3.html b/man/tip/nng_listener_set.3.html index 79f09af6..4e769a25 100644 --- a/man/tip/nng_listener_set.3.html +++ b/man/tip/nng_listener_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_set(3) ---

    nng_listener_set(3)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_listener_set(nng_listener l, const char *opt, const void *val, 
    -    size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_listener_set(nng_listener l, const char *opt, const void *val,
    +    size_t valsz);
     
     int nng_listener_set_bool(nng_listener l, const char *opt, bool bval);
     
    @@ -29,11 +30,11 @@ layout: manpage_v2
     
     int nng_listener_set_ptr(nng_listener l, const char *opt, void *ptr);
     
    -int nng_listener_set_size(nng_listener l, const char *opt, size_t z);
    +int nng_listener_set_size(nng_listener l, const char *opt, size_t z);
     
     int nng_listener_set_string(nng_listener l, const char *opt, const char *str);
     
    -int nng_listener_set_uint64(nng_listener l, const char *opt, uint64_t u64);
    +int nng_listener_set_uint64(nng_listener l, const char *opt, uint64_t u64);
    @@ -48,8 +49,7 @@ The actual options that may be configured 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 and protocols themselves.

    +

    Additionally some transport-specific options are documented with the transports themselves.

    diff --git a/man/tip/nng_listener_setopt.3.html b/man/tip/nng_listener_setopt.3.html index 19ef85b1..93cf96a7 100644 --- a/man/tip/nng_listener_setopt.3.html +++ b/man/tip/nng_listener_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_setopt(3) ---

    nng_listener_setopt(3)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listener_setopt(nng_listener l, const char *opt, const void *val,
    -    size_t valsz);
    -    
    +    size_t valsz);
    +
     int nng_listener_setopt_bool(nng_listener l, const char *opt, bool bval);
     
     int nng_listener_setopt_int(nng_listener l, const char *opt, int ival);
    @@ -29,11 +30,11 @@ layout: manpage_v2
     
     int nng_listener_setopt_ptr(nng_listener l, const char *opt, void *ptr);
     
    -int nng_listener_setopt_size(nng_listener l, const char *opt, size_t z);
    +int nng_listener_setopt_size(nng_listener l, const char *opt, size_t z);
     
     int nng_listener_setopt_string(nng_listener l, const char *opt, const char *str);
     
    -int nng_listener_setopt_uint64(nng_listener l, const char *opt, uint64_t u64);
    +int nng_listener_setopt_uint64(nng_listener l, const char *opt, uint64_t u64);
    @@ -41,14 +42,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_listener_set. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    @@ -60,8 +62,8 @@ The actual options that may be configured 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 and protocols themselves.

    +

    Additionally some transport-specific options +are documented with the transports themselves.

    diff --git a/man/tip/nng_listener_start.3.html b/man/tip/nng_listener_start.3.html index 6cfd2858..9bed3250 100644 --- a/man/tip/nng_listener_start.3.html +++ b/man/tip/nng_listener_start.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_listener_start(3) ---

    nng_listener_start(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_listener_start(nng_listener l, int flags);
    diff --git a/man/tip/nng_msg.5.html b/man/tip/nng_msg.5.html index 2a85a1fc..21c645e7 100644 --- a/man/tip/nng_msg.5.html +++ b/man/tip/nng_msg.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg(5) ---

    nng_msg(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_msg nng_msg;
    @@ -73,6 +74,8 @@ by making use of scratch areas at the beginning and end of the message.

    nng_msg_header(3), nng_msg_header_len(3), nng_msg_len(3), +nng_msg_capacity(3), +nng_msg_reserve(3), nng_msg_realloc(3), nng_recvmsg(3), nng_sendmsg(3), diff --git a/man/tip/nng_msg_alloc.3.html b/man/tip/nng_msg_alloc.3.html index e9be7944..794b0789 100644 --- a/man/tip/nng_msg_alloc.3.html +++ b/man/tip/nng_msg_alloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_alloc(3) ---

    nng_msg_alloc(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_alloc(nng_msg **msgp, size_t size);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_alloc(nng_msg **msgp, size_t size);
    @@ -69,6 +70,8 @@ They are used with receive and transmit functions.

    nng_msg_header(3), nng_msg_header_len(3), nng_msg_len(3), +nng_msg_capacity(3), +nng_msg_reserve(3), nng_msg_realloc(3), nng_strerror(3), nng_msg(5), diff --git a/man/tip/nng_msg_append.3.html b/man/tip/nng_msg_append.3.html index 4635a0dd..5f3c189c 100644 --- a/man/tip/nng_msg_append.3.html +++ b/man/tip/nng_msg_append.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_append(3) ---

    nng_msg_append(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_append(nng_msg *msg, const void *val, size_t size);
    -int nng_msg_append_u16(nng_msg *msg, uint16_t val16);
    -int nng_msg_append_u32(nng_msg *msg, uint32_t val32);
    -int nng_msg_append_u64(nng_msg *msg, uint64_t val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_append(nng_msg *msg, const void *val, size_t size);
    +int nng_msg_append_u16(nng_msg *msg, uint16_t val16);
    +int nng_msg_append_u32(nng_msg *msg, uint32_t val32);
    +int nng_msg_append_u64(nng_msg *msg, uint64_t val64);
    diff --git a/man/tip/nng_msg_body.3.html b/man/tip/nng_msg_body.3.html index 739f563f..c086378f 100644 --- a/man/tip/nng_msg_body.3.html +++ b/man/tip/nng_msg_body.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_body(3) ---

    nng_msg_body(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void *nng_msg_body(nng_msg *msg);
    @@ -78,6 +79,8 @@ or nng_msg_insert() variants. nng_msg_free(3), nng_msg_insert(3), nng_msg_len(3), +nng_msg_capacity(3), +nng_msg_reserve(3), nng_msg_realloc(3), nng_msg_trim(3), nng_msg(5), diff --git a/man/tip/nng_msg_capacity.3.html b/man/tip/nng_msg_capacity.3.html new file mode 100644 index 00000000..9246c64c --- /dev/null +++ b/man/tip/nng_msg_capacity.3.html @@ -0,0 +1,64 @@ +--- +version: tip +layout: manpage_v2 +title: nng_msg_capacity(3) +--- +

    nng_msg_capacity(3)

    +
    +

    NAME

    +
    +
    +

    nng_msg_capacity - return message body length

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +size_t nng_msg_capacity(nng_msg *msg);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_msg_capacity() returns the storage allocated for the body of message msg. +The capacity includes the current contents of the message and free space after it. +The message body may grow to capacity without performing any further allocations.

    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    Allocated capacity for message body.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    +

    None.

    +
    +
    +
    + diff --git a/man/tip/nng_msg_chop.3.html b/man/tip/nng_msg_chop.3.html index daba7b3f..9c12d5da 100644 --- a/man/tip/nng_msg_chop.3.html +++ b/man/tip/nng_msg_chop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_chop(3) ---

    nng_msg_chop(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_chop(nng_msg *msg, size_t size);
    -int nng_msg_chop_u16(nng_msg *msg, uint16_t *val16);
    -int nng_msg_chop_u32(nng_msg *msg, uint32_t *val32);
    -int nng_msg_chop_u64(nng_msg *msg, uint64_t *val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_chop(nng_msg *msg, size_t size);
    +int nng_msg_chop_u16(nng_msg *msg, uint16_t *val16);
    +int nng_msg_chop_u32(nng_msg *msg, uint32_t *val32);
    +int nng_msg_chop_u64(nng_msg *msg, uint64_t *val64);
    @@ -74,6 +75,8 @@ after converting them from network-byte order (big-endian) to native byte order. nng_msg_free(3), nng_msg_insert(3), nng_msg_len(3), +nng_msg_capacity(3), +nng_msg_reserve(3), nng_msg_realloc(3), nng_msg_trim(3), nng_strerror(3), diff --git a/man/tip/nng_msg_clear.3.html b/man/tip/nng_msg_clear.3.html index a2edd237..3b974bc8 100644 --- a/man/tip/nng_msg_clear.3.html +++ b/man/tip/nng_msg_clear.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_clear(3) ---

    nng_msg_clear(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_msg_clear(nng_msg *msg);
    diff --git a/man/tip/nng_msg_dup.3.html b/man/tip/nng_msg_dup.3.html index a2264f49..31a4c997 100644 --- a/man/tip/nng_msg_dup.3.html +++ b/man/tip/nng_msg_dup.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_dup(3) ---

    nng_msg_dup(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_dup(nng_msg **dup, nng_msg_t *orig);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_dup(nng_msg **dup, nng_msg_t *orig);
    diff --git a/man/tip/nng_msg_free.3.html b/man/tip/nng_msg_free.3.html index 211b33de..6b81bec6 100644 --- a/man/tip/nng_msg_free.3.html +++ b/man/tip/nng_msg_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_free(3) ---

    nng_msg_free(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_msg_free(nng_msg *msg);
    diff --git a/man/tip/nng_msg_get_pipe.3.html b/man/tip/nng_msg_get_pipe.3.html index 532138a7..064a5723 100644 --- a/man/tip/nng_msg_get_pipe.3.html +++ b/man/tip/nng_msg_get_pipe.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_get_pipe(3) ---

    nng_msg_get_pipe(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     nng_pipe nng_msg_get_pipe(nng_msg *msg);
    diff --git a/man/tip/nng_msg_header.3.html b/man/tip/nng_msg_header.3.html index c561d672..60abf0e7 100644 --- a/man/tip/nng_msg_header.3.html +++ b/man/tip/nng_msg_header.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header(3) ---

    nng_msg_header(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void *nng_msg_header(nng_msg *msg);
    diff --git a/man/tip/nng_msg_header_append.3.html b/man/tip/nng_msg_header_append.3.html index d2b45fda..0f8673c8 100644 --- a/man/tip/nng_msg_header_append.3.html +++ b/man/tip/nng_msg_header_append.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_append(3) ---

    nng_msg_header_append(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_header_append(nng_msg *msg, const void *val, size_t size);
    -int nng_msg_header_append_u16(nng_msg *msg, uint16_t val16);
    -int nng_msg_header_append_u32(nng_msg *msg, uint32_t val32);
    -int nng_msg_header_append_u64(nng_msg *msg, uint64_t val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_header_append(nng_msg *msg, const void *val, size_t size);
    +int nng_msg_header_append_u16(nng_msg *msg, uint16_t val16);
    +int nng_msg_header_append_u32(nng_msg *msg, uint32_t val32);
    +int nng_msg_header_append_u64(nng_msg *msg, uint64_t val64);
    diff --git a/man/tip/nng_msg_header_chop.3.html b/man/tip/nng_msg_header_chop.3.html index a88d8af4..f2a71511 100644 --- a/man/tip/nng_msg_header_chop.3.html +++ b/man/tip/nng_msg_header_chop.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_chop(3) ---

    nng_msg_header_chop(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_header_chop(nng_msg *msg, size_t size);
    -int nng_msg_header_chop_u16(nng_msg *msg, uint16_t *val16);
    -int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32);
    -int nng_msg_header_chop_u64(nng_msg *msg, uint64_t *val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_header_chop(nng_msg *msg, size_t size);
    +int nng_msg_header_chop_u16(nng_msg *msg, uint16_t *val16);
    +int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32);
    +int nng_msg_header_chop_u64(nng_msg *msg, uint64_t *val64);
    diff --git a/man/tip/nng_msg_header_clear.3.html b/man/tip/nng_msg_header_clear.3.html index 33f524b5..9cea2ac5 100644 --- a/man/tip/nng_msg_header_clear.3.html +++ b/man/tip/nng_msg_header_clear.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_clear(3) ---

    nng_msg_header_clear(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_msg_header_clear(nng_msg *msg);
    diff --git a/man/tip/nng_msg_header_insert.3.html b/man/tip/nng_msg_header_insert.3.html index fff2439e..5672d0e5 100644 --- a/man/tip/nng_msg_header_insert.3.html +++ b/man/tip/nng_msg_header_insert.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_insert(3) ---

    nng_msg_header_insert(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_header_insert(nng_msg *msg, const void *val, size_t size);
    -int nng_msg_header_insert_u16(nng_msg *msg, uint16_t val16);
    -int nng_msg_header_insert_u32(nng_msg *msg, uint32_t val32);
    -int nng_msg_header_insert_u64(nng_msg *msg, uint64_t val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_header_insert(nng_msg *msg, const void *val, size_t size);
    +int nng_msg_header_insert_u16(nng_msg *msg, uint16_t val16);
    +int nng_msg_header_insert_u32(nng_msg *msg, uint32_t val32);
    +int nng_msg_header_insert_u64(nng_msg *msg, uint64_t val64);
    @@ -75,6 +76,8 @@ network-byte order (big-endian).

    nng_msg_header_len(3), nng_msg_header_trim(3), nng_msg_free(3), +nng_msg_capacity(3), +nng_msg_reserve(3), nng_msg_realloc(3), nng_strerror(3), nng(7)

    diff --git a/man/tip/nng_msg_header_len.3.html b/man/tip/nng_msg_header_len.3.html index b867995d..68333fc6 100644 --- a/man/tip/nng_msg_header_len.3.html +++ b/man/tip/nng_msg_header_len.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_len(3) ---

    nng_msg_header_len(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -size_t nng_msg_header_len(nng_msg *msg);
    +
    #include <nng/nng.h>
    +
    +size_t nng_msg_header_len(nng_msg *msg);
    diff --git a/man/tip/nng_msg_header_trim.3.html b/man/tip/nng_msg_header_trim.3.html index be1e7ae3..9db2a803 100644 --- a/man/tip/nng_msg_header_trim.3.html +++ b/man/tip/nng_msg_header_trim.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_header_trim(3) ---

    nng_msg_header_trim(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_header_trim(nng_msg *msg, size_t size);
    -int nng_msg_header_trim_u16(nng_msg *msg, uint16_t *val16);
    -int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32);
    -int nng_msg_header_trim_u64(nng_msg *msg, uint64_t *val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_header_trim(nng_msg *msg, size_t size);
    +int nng_msg_header_trim_u16(nng_msg *msg, uint16_t *val16);
    +int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32);
    +int nng_msg_header_trim_u64(nng_msg *msg, uint64_t *val64);
    diff --git a/man/tip/nng_msg_insert.3.html b/man/tip/nng_msg_insert.3.html index d7014c6a..19ed4254 100644 --- a/man/tip/nng_msg_insert.3.html +++ b/man/tip/nng_msg_insert.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_insert(3) ---

    nng_msg_insert(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_insert(nng_msg *msg, const void *val, size_t size);
    -int nng_msg_insert_u16(nng_msg *msg, uint16_t val16);
    -int nng_msg_insert_u32(nng_msg *msg, uint32_t val32);
    -int nng_msg_insert_u64(nng_msg *msg, uint64_t val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_insert(nng_msg *msg, const void *val, size_t size);
    +int nng_msg_insert_u16(nng_msg *msg, uint16_t val16);
    +int nng_msg_insert_u32(nng_msg *msg, uint32_t val32);
    +int nng_msg_insert_u64(nng_msg *msg, uint64_t val64);
    diff --git a/man/tip/nng_msg_len.3.html b/man/tip/nng_msg_len.3.html index 6b421c9e..ced2da68 100644 --- a/man/tip/nng_msg_len.3.html +++ b/man/tip/nng_msg_len.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_len(3) ---

    nng_msg_len(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -size_t nng_msg_len(nng_msg *msg);
    +
    #include <nng/nng.h>
    +
    +size_t nng_msg_len(nng_msg *msg);
    diff --git a/man/tip/nng_msg_realloc.3.html b/man/tip/nng_msg_realloc.3.html index 127990d5..1eb7b85f 100644 --- a/man/tip/nng_msg_realloc.3.html +++ b/man/tip/nng_msg_realloc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_realloc(3) ---

    nng_msg_realloc(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_realloc(nng_msg *msg, size_t size);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_realloc(nng_msg *msg, size_t size);
    @@ -39,14 +40,12 @@ and will reuse the existing memory when possible.

    -One way to further reduce message allocations is to allocate a message -larger than needed, then use this function or -nng_msg_chop() to reduce the message size -to that actually needed. -The extra space left -over will still be present in the message, so that when the message size -needs to grow due to this function or nng_msg_append() -no actual memory allocations need to take place. +nng_msg_realloc is suitable for creating space for direct writing of data. +When appending many small pieces of data to a message using nng_msg_append(), +allocations may be reduced by first using nng_msg_reserve() +to create sufficient space. +In any case, reallocating or appending to a message is guaranteed to succeed if the resulting +body length is less than nng_msg_capacity().
    @@ -96,7 +95,8 @@ may have changed, particularly if the message size is increasing.

    SEE ALSO

    -

    nng_msg_alloc(3), +

    nng_msg_reserve(3), +nng_msg_alloc(3), nng_msg_append(3), nng_msg_body(3), nng_msg_chop(3), diff --git a/man/tip/nng_msg_reserve.3.html b/man/tip/nng_msg_reserve.3.html new file mode 100644 index 00000000..e6d9cc0a --- /dev/null +++ b/man/tip/nng_msg_reserve.3.html @@ -0,0 +1,109 @@ +--- +version: tip +layout: manpage_v2 +title: nng_msg_reserve(3) +--- +

    nng_msg_reserve(3)

    +
    +

    NAME

    +
    +
    +

    nng_msg_reserve - reserve storage for a message

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +int nng_msg_reserve(nng_msg *msg, size_t capacity);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_msg_reserve() function ensures a message has allocated enough storage +to accommodate a body of the given length. +This message attempts to avoid extra allocations, +and will reuse the existing memory when possible.

    +
    +
    + + + + + +
    + + +Using this message before nng_msg_append() +will prevent additional memory allocations until the message’s length exceeds +the alotted capacity. +
    +
    +
    + + + + + +
    + + +Pointers to message body and header content obtained prior to this +function must not be in use, as the underlying memory used for the message +may have changed, particularly if the message capacity is increasing. +
    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    This function returns 0 on success, and non-zero otherwise.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    + + + + + +
    +NNG_ENOMEM + +

    Insufficient free memory exists to reallocate a message.

    +
    +
    +
    +
    + diff --git a/man/tip/nng_msg_set_pipe.3.html b/man/tip/nng_msg_set_pipe.3.html index 500824d8..02532a00 100644 --- a/man/tip/nng_msg_set_pipe.3.html +++ b/man/tip/nng_msg_set_pipe.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_set_pipe(3) ---

    nng_msg_set_pipe(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_msg_set_pipe(nng_msg *msg, nng_pipe p);
    diff --git a/man/tip/nng_msg_trim.3.html b/man/tip/nng_msg_trim.3.html index 734c6612..90de3483 100644 --- a/man/tip/nng_msg_trim.3.html +++ b/man/tip/nng_msg_trim.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msg_trim(3) ---

    nng_msg_trim(3)

    @@ -16,12 +17,12 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_msg_trim(nng_msg *msg, size_t size);
    -int nng_msg_trim_u16(nng_msg *msg, uint16_t *val16);
    -int nng_msg_trim_u32(nng_msg *msg, uint32_t *val32);
    -int nng_msg_trim_u64(nng_msg *msg, uint64_t *val64);
    +
    #include <nng/nng.h>
    +
    +int nng_msg_trim(nng_msg *msg, size_t size);
    +int nng_msg_trim_u16(nng_msg *msg, uint16_t *val16);
    +int nng_msg_trim_u32(nng_msg *msg, uint32_t *val32);
    +int nng_msg_trim_u64(nng_msg *msg, uint64_t *val64);
    diff --git a/man/tip/nng_msleep.3supp.html b/man/tip/nng_msleep.3supp.html index 3f0841ac..4ed0ed30 100644 --- a/man/tip/nng_msleep.3supp.html +++ b/man/tip/nng_msleep.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_msleep(3supp) ---

    nng_msleep(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_msleep(nng_duration msec);
    diff --git a/man/tip/nng_mtx_alloc.3supp.html b/man/tip/nng_mtx_alloc.3supp.html index b40af39b..96b94aef 100644 --- a/man/tip/nng_mtx_alloc.3supp.html +++ b/man/tip/nng_mtx_alloc.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_alloc(3supp) ---

    nng_mtx_alloc(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     typedef struct nng_mtx nng_mtx;
     
     int nng_mtx_alloc(nng_mtx **mtxp);
    diff --git a/man/tip/nng_mtx_free.3supp.html b/man/tip/nng_mtx_free.3supp.html index 5192b0f6..85132893 100644 --- a/man/tip/nng_mtx_free.3supp.html +++ b/man/tip/nng_mtx_free.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_free(3supp) ---

    nng_mtx_free(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_mtx_free(nng_mtx *mtx);
    diff --git a/man/tip/nng_mtx_lock.3supp.html b/man/tip/nng_mtx_lock.3supp.html index c8a27327..8232582f 100644 --- a/man/tip/nng_mtx_lock.3supp.html +++ b/man/tip/nng_mtx_lock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_lock(3supp) ---

    nng_mtx_lock(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_mtx_lock(nng_mtx *mtx);
    diff --git a/man/tip/nng_mtx_unlock.3supp.html b/man/tip/nng_mtx_unlock.3supp.html index 9a691386..03ef6da6 100644 --- a/man/tip/nng_mtx_unlock.3supp.html +++ b/man/tip/nng_mtx_unlock.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_mtx_unlock(3supp) ---

    nng_mtx_unlock(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_mtx_unlock(nng_mtx *mtx);
    diff --git a/man/tip/nng_options.5.html b/man/tip/nng_options.5.html index ec72f764..582f5519 100644 --- a/man/tip/nng_options.5.html +++ b/man/tip/nng_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_options(5) ---

    nng_options(5)

    @@ -16,27 +17,27 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -#define NNG_OPT_SOCKNAME      "socket-name"
    -#define NNG_OPT_RAW           "raw"
    -#define NNG_OPT_PROTO         "protocol"
    -#define NNG_OPT_PROTONAME     "protocol-name"
    -#define NNG_OPT_PEER          "peer"
    -#define NNG_OPT_PEERNAME      "peer-name"
    -#define NNG_OPT_RECVBUF       "recv-buffer"
    -#define NNG_OPT_SENDBUF       "send-buffer"
    -#define NNG_OPT_RECVFD        "recv-fd"
    -#define NNG_OPT_SENDFD        "send-fd"
    -#define NNG_OPT_RECVTIMEO     "recv-timeout"
    -#define NNG_OPT_SENDTIMEO     "send-timeout"
    -#define NNG_OPT_LOCADDR       "local-address"
    -#define NNG_OPT_REMADDR       "remote-address"
    -#define NNG_OPT_URL           "url"
    -#define NNG_OPT_MAXTTL        "ttl-max"
    -#define NNG_OPT_RECVMAXSZ     "recv-size-max"
    -#define NNG_OPT_RECONNMINT    "reconnect-time-min"
    -#define NNG_OPT_RECONNMAXT    "reconnect-time-max"
    +
    #include <nng/nng.h>
    +
    +#define NNG_OPT_SOCKNAME      "socket-name"
    +#define NNG_OPT_RAW           "raw"
    +#define NNG_OPT_PROTO         "protocol"
    +#define NNG_OPT_PROTONAME     "protocol-name"
    +#define NNG_OPT_PEER          "peer"
    +#define NNG_OPT_PEERNAME      "peer-name"
    +#define NNG_OPT_RECVBUF       "recv-buffer"
    +#define NNG_OPT_SENDBUF       "send-buffer"
    +#define NNG_OPT_RECVFD        "recv-fd"
    +#define NNG_OPT_SENDFD        "send-fd"
    +#define NNG_OPT_RECVTIMEO     "recv-timeout"
    +#define NNG_OPT_SENDTIMEO     "send-timeout"
    +#define NNG_OPT_LOCADDR       "local-address"
    +#define NNG_OPT_REMADDR       "remote-address"
    +#define NNG_OPT_URL           "url"
    +#define NNG_OPT_MAXTTL        "ttl-max"
    +#define NNG_OPT_RECVMAXSZ     "recv-size-max"
    +#define NNG_OPT_RECONNMINT    "reconnect-time-min"
    +#define NNG_OPT_RECONNMAXT    "reconnect-time-max"
    @@ -112,7 +113,9 @@ choose a random ephemeral port instead.

    NNG_OPT_RAW
    -

    (bool) +

    + +(bool) This read-only option indicates whether the socket is in raw mode. If true, the socket is in raw mode, and if false the socket is in normal mode.

    @@ -131,7 +134,8 @@ See Raw Mode for more details.

    NNG_OPT_RECONNMINT
    -

    (nng_duration) +

    +(nng_duration) This is the minimum amount of time (milliseconds) to wait before attempting to establish a connection after a previous attempt has failed. This can be set on a socket, but it can also be overridden on an individual @@ -145,6 +149,7 @@ The option is irrelevant for listeners.

    NNG_OPT_RECONNMAXT

    (NNG_OPT_RECONNMAXT) + (nng_duration) This is the maximum amount of time (milliseconds) to wait before attempting to establish a connection after @@ -165,7 +170,9 @@ The option is irrelevant for listeners.

    NNG_OPT_RECVBUF
    -

    (int) +

    + +(int) This is the depth of the socket’s receive buffer as a number of messages. Messages received by a transport may be buffered until the application has accepted them for delivery. @@ -179,7 +186,10 @@ For example req can only deal with a singl

    NNG_OPT_RECVFD
    -

    (int) +

    + + +(int) This read-only option is used to obtain an integer file descriptor suitable for use with poll(), @@ -240,7 +250,8 @@ See nng_aio_alloc().

    NNG_OPT_RECVMAXSZ
    -

    (size_t) +

    +(size_t) This is the maximum message size that the will be accepted from a remote peer. If a peer attempts to send a message larger than this, then the message will be discarded. @@ -263,6 +274,24 @@ value to prevent denial-of-service attacks.

    +
    + + + + + +
    + + +This option should be set before any listeners or dialers are added. +Ideally this option should be set on specific dialers or listeners; setting it +on the socket globally is deprecated behavior, and might not work in a future release, +or might only work for endpoints that have not yet been created. +(Maximum receive sizes might be negotiated during connection establishment for +future transports, which means that the option needs to be set before any connections +are established.) +
    +
    @@ -282,7 +311,9 @@ Some transports may have further message size restrictions.
    NNG_OPT_RECVTIMEO
    -

    (nng_duration) +

    + +(nng_duration) This is the socket receive timeout in milliseconds. When no message is available for receiving at the socket for this period of time, receive operations will fail with a return value of NNG_ETIMEDOUT.

    @@ -304,7 +335,9 @@ Not all transports support this option.

    NNG_OPT_SENDBUF
    -

    (int) +

    + +(int) This is the depth of the socket send buffer as a number of messages. Messages sent by an application may be buffered by the socket until a transport is ready to accept them for delivery. @@ -316,9 +349,9 @@ This value must be an integer between 0 and 8192, inclusive.

    -Not all protocols support buffering sent messages; -generally multicast protocols like pub will -simply discard messages when they cannot be delivered immediately. +Not all protocols support buffering sent messages. +For example, req can only have a single request +outstanding at a time (per context).
    @@ -330,7 +363,10 @@ simply discard messages when they cannot be delivered immediately.
    NNG_OPT_SENDFD
    -

    (int) +

    + + +(int) This read-only option is used to obtain an integer file descriptor suitable for use with poll(), @@ -393,7 +429,9 @@ See nng_aio_alloc().

    NNG_OPT_SENDTIMEO
    -

    (nng_duration) +

    + +(nng_duration) This is the socket send timeout in milliseconds. When a message cannot be queued for delivery by the socket for this period of time (such as if send buffers are full), the operation will fail with a @@ -405,9 +443,10 @@ return value of NNG_ETIMEDOUT.

    NNG_OPT_SOCKNAME
    -

    (string) +

    +(string) This the socket name. -By default this is a string corresponding to the value of the socket. +By default, this is a string corresponding to the value of the socket. The string must fit within 64-bytes, including the terminating NUL byte. The value is intended for application use, and is not used for anything @@ -460,7 +499,9 @@ this option.

    NNG_OPT_URL
    -

    (string) +

    + +(string) This read-only option is used to obtain the URL with which a listener or dialer was configured. Accordingly it can only be used with dialers, listeners, and pipes.

    diff --git a/man/tip/nng_opts_parse.3supp.html b/man/tip/nng_opts_parse.3supp.html index bc715d53..97a934be 100644 --- a/man/tip/nng_opts_parse.3supp.html +++ b/man/tip/nng_opts_parse.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_opts_parse(3supp) ---

    nng_opts_parse(3supp)

    @@ -16,15 +17,19 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/options.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/options.h>
    +
     typedef struct nng_optspec {
         const char *o_name;  // Long style name (may be NULL for short only)
    -    int         o_short; // Short option (no clustering!)
    -    int         o_val;   // Value stored on a good parse (>0)
    -    bool        o_arg;   // Option takes an argument if true
    -} nng_optspec;
    +
    +    int         o_short; // Short option (no clustering!)
    +
    +    int         o_val;   // Value stored on a good parse (>0)
    +
    +    bool        o_arg;   // Option takes an argument if true
    +
    +} nng_optspec;
     
     int nng_opts_parse(int argc, char *const *argv, const nng_optspec *spec, int *val, char **arg, int *idx);
    @@ -47,7 +52,7 @@ starting at the index referenced by idx. (New invocations typically set the value pointed to by idx to 1.)

    -

    Options are parsed as specified by spec (see [Option Specification].) +

    Options are parsed as specified by spec (see Option Specification.) The value of the parsed option will be stored at the address indicated by val, and the value of idx will be incremented to reflect the next option to parse.

    @@ -86,26 +91,26 @@ This structure has the following members:

    o_name
    -

    The long style name for the option, such as "verbose". - This will be parsed on the command line when it is prefixed with two dashes. - It may be NULL if only a short option is to be supported.

    +

    The long style name for the option, such as "verbose". +This will be parsed on the command line when it is prefixed with two dashes. +It may be NULL if only a short option is to be supported.

    o_short

    This is a single letter (at present only ASCII letters are supported). - These options appear as just a single letter, and are prefixed with a single dash on the command line. - The use of a slash in lieu of the dash is not supported, in order to avoid confusion with path name arguments. - This value may be set to 0 if no short option is needed.

    +These options appear as just a single letter, and are prefixed with a single dash on the command line. +The use of a slash in lieu of the dash is not supported, in order to avoid confusion with path name arguments. +This value may be set to 0 if no short option is needed.

    o_val

    This is a numeric value that is unique to this option. - This value is assigned by the application program, and must be non-zero - for a valid option. - If this is zero, then it indicates the end of the specifications, and the - rest of this structure is ignored. - The value will be returned to the caller in val by nng_opts_parse() when - this option is parsed from the command line.

    +This value is assigned by the application program, and must be non-zero +for a valid option. +If this is zero, then it indicates the end of the specifications, and the +rest of this structure is ignored. +The value will be returned to the caller in val by nng_opts_parse() when +this option is parsed from the command line.

    o_arg
    @@ -119,7 +124,7 @@ This structure has the following members:

    Long options are parsed from the argv array, and are indicated when the element being scanned starts with two dashes. -For example, the "verbose" option would be specified as --verbose on +For example, the "verbose" option would be specified as --verbose on the command line. If a long option takes an argument, it can either immediately follow the option as the next element in argv, or it can be appended to @@ -169,7 +174,8 @@ unambiguously (meaning it must not match any other option specification.)

        enum { OPT_LOGFILE, OPT_VERBOSE };
         char *logfile; // options to be set
    -    bool verbose;
    +
    +    bool verbose;
     
         static nng_optspec specs[] = {
             {
    @@ -184,13 +190,14 @@ unambiguously (meaning it must not match any other option specification.)

    .o_arg = false, }, { .o_val = 0; // Terminate array - } + + } }; for (int idx = 1;;) { int rv, opt; char *arg; - rv = nng_opts_parse(argc, argv, specs, &opt, &arg, &idx); + rv = nng_opts_parse(argc, argv, specs, &opt, &arg, &idx); if (rv != 0) { break; } @@ -204,8 +211,8 @@ unambiguously (meaning it must not match any other option specification.)

    } } if (rv != -1) { - printf("Options error: %s\n", nng_strerror(rv)); - exit(1); + printf("Options error: %s\n", nng_strerror(rv)); + exit(1); }
    diff --git a/man/tip/nng_pair.7.html b/man/tip/nng_pair.7.html index 45ef7cd6..4b7303b4 100644 --- a/man/tip/nng_pair.7.html +++ b/man/tip/nng_pair.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pair(7) ---

    nng_pair(7)

    @@ -174,15 +175,15 @@ to the sender.

    -
    NNG_OPT_MAXTTL
    +
    `NNG_OPT_MAXTTL`

    (int, version 1 only). Maximum time-to-live.

    NNG_OPT_PAIR1_POLY

    (bool, version 1 only) This option is no longer supported. - Formerly it was used to configure polyamorous mode, but that mode - is now established by using the nng_pair1_open_poly() function.

    +Formerly it was used to configure polyamorous mode, but that mode +is now established by using the nng_pair1_open_poly() function.

    @@ -194,7 +195,7 @@ to the sender.

    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 +low-order (big-endian) byte of this value contains a "hop" count, and is used in conjunction with the NNG_OPT_MAXTTL option to guard against device forwarding loops. diff --git a/man/tip/nng_pair_open.3.html b/man/tip/nng_pair_open.3.html index 4ef504c1..a6c4ef03 100644 --- a/man/tip/nng_pair_open.3.html +++ b/man/tip/nng_pair_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pair_open(3) ---

    nng_pair_open(3)

    @@ -17,8 +18,8 @@ layout: manpage_v2
    Version 0
    -
    #include <nng/protocol/pair0/pair.h>
    -
    +
    #include <nng/protocol/pair0/pair.h>
    +
     int nng_pair0_open(nng_socket *s);
     
     int nng_pair0_open_raw(nng_socket *s);
    @@ -27,8 +28,8 @@ layout: manpage_v2
    Version 1
    -
    #include <nng/protocol/pair1/pair.h>
    -
    +
    #include <nng/protocol/pair1/pair.h>
    +
     int nng_pair1_open(nng_socket *s);
     
     int nng_pair1_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_pipe.5.html b/man/tip/nng_pipe.5.html
    index 8163045f..6d6befdc 100644
    --- a/man/tip/nng_pipe.5.html
    +++ b/man/tip/nng_pipe.5.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_pipe(5)
     ---
     

    nng_pipe(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_pipe_s nng_pipe;
    @@ -29,7 +30,7 @@ layout: manpage_v2

    An nng_pipe is a handle to a pipe object, which can be thought of as a single connection. -(In most cases this is actually the case -- the pipe is an abstraction for a +(In most cases this is actually the case — the pipe is an abstraction for a single TCP or IPC connection.) Pipes are associated with either the listener or dialer that created them, and therefore are also automatically associated with a single socket.

    diff --git a/man/tip/nng_pipe_close.3.html b/man/tip/nng_pipe_close.3.html index bafdf669..eedd6b4a 100644 --- a/man/tip/nng_pipe_close.3.html +++ b/man/tip/nng_pipe_close.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_close(3) ---

    nng_pipe_close(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_pipe_close(nng_pipe p);
    diff --git a/man/tip/nng_pipe_dialer.3.html b/man/tip/nng_pipe_dialer.3.html index 63d771cb..6eb12ce9 100644 --- a/man/tip/nng_pipe_dialer.3.html +++ b/man/tip/nng_pipe_dialer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_dialer(3) ---

    nng_pipe_dialer(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     nng_dialer nng_pipe_dialer(nng_pipe p);
    diff --git a/man/tip/nng_pipe_get.3.html b/man/tip/nng_pipe_get.3.html index cf35d096..061fc9b9 100644 --- a/man/tip/nng_pipe_get.3.html +++ b/man/tip/nng_pipe_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_get(3) ---

    nng_pipe_get(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_pipe_get(nng_pipe p, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_pipe_get(nng_pipe p, const char *opt, void *val, size_t *valszp);
     
     int nng_pipe_get_bool(nng_pipe p, const char *opt, bool *bvalp);
     
    @@ -32,9 +33,9 @@ layout: manpage_v2
     
     int nng_pipe_get_string(nng_pipe p, const char *opt, char **strp);
     
    -int nng_pipe_get_size(nng_pipe p, const char *opt, size_t *zp);
    +int nng_pipe_get_size(nng_pipe p, const char *opt, size_t *zp);
     
    -int nng_pipe_get_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
    +int nng_pipe_get_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
    diff --git a/man/tip/nng_pipe_getopt.3.html b/man/tip/nng_pipe_getopt.3.html index a8e429ee..4c2167e8 100644 --- a/man/tip/nng_pipe_getopt.3.html +++ b/man/tip/nng_pipe_getopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_getopt(3) ---

    nng_pipe_getopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp);
     
     int nng_pipe_getopt_bool(nng_pipe p, const char *opt, bool *bvalp);
     
    @@ -32,9 +33,9 @@ layout: manpage_v2
     
     int nng_pipe_getopt_string(nng_pipe p, const char *opt, char **strp);
     
    -int nng_pipe_getopt_size(nng_pipe p, const char *opt, size_t *zp);
    +int nng_pipe_getopt_size(nng_pipe p, const char *opt, size_t *zp);
     
    -int nng_pipe_getopt_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
    +int nng_pipe_getopt_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
    diff --git a/man/tip/nng_pipe_id.3.html b/man/tip/nng_pipe_id.3.html index d97f9c78..ebf37b70 100644 --- a/man/tip/nng_pipe_id.3.html +++ b/man/tip/nng_pipe_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_id(3) ---

    nng_pipe_id(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_pipe_id(nng_pipe p);
    diff --git a/man/tip/nng_pipe_listener.3.html b/man/tip/nng_pipe_listener.3.html index c715b06b..6d1b77b9 100644 --- a/man/tip/nng_pipe_listener.3.html +++ b/man/tip/nng_pipe_listener.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_listener(3) ---

    nng_pipe_listener(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     nng_listener nng_pipe_listener(nng_pipe p);
    diff --git a/man/tip/nng_pipe_notify.3.html b/man/tip/nng_pipe_notify.3.html index 77ceedad..ad477be1 100644 --- a/man/tip/nng_pipe_notify.3.html +++ b/man/tip/nng_pipe_notify.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pipe_notify(3) ---

    nng_pipe_notify(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef enum {
             NNG_PIPE_EV_ADD_PRE,
             NNG_PIPE_EV_ADD_POST,
    diff --git a/man/tip/nng_pipe_socket.3.html b/man/tip/nng_pipe_socket.3.html
    index dd45cf4f..a98ccc5f 100644
    --- a/man/tip/nng_pipe_socket.3.html
    +++ b/man/tip/nng_pipe_socket.3.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_pipe_socket(3)
     ---
     

    nng_pipe_socket(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     nng_socket nng_pipe_socket(nng_pipe p);
    diff --git a/man/tip/nng_pub.7.html b/man/tip/nng_pub.7.html index c435be2c..55c02373 100644 --- a/man/tip/nng_pub.7.html +++ b/man/tip/nng_pub.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pub(7) ---

    nng_pub(7)

    diff --git a/man/tip/nng_pub_open.3.html b/man/tip/nng_pub_open.3.html index 930609d9..08afb8e6 100644 --- a/man/tip/nng_pub_open.3.html +++ b/man/tip/nng_pub_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pub_open(3) ---

    nng_pub_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/pubsub0/pub.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/pubsub0/pub.h>
    +
     int nng_pub0_open(nng_socket *s);
     
     int nng_pub0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_pull.7.html b/man/tip/nng_pull.7.html index 425f1ca1..78dd4e8d 100644 --- a/man/tip/nng_pull.7.html +++ b/man/tip/nng_pull.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pull(7) ---

    nng_pull(7)

    diff --git a/man/tip/nng_pull_open.3.html b/man/tip/nng_pull_open.3.html index aef13363..3e1545b4 100644 --- a/man/tip/nng_pull_open.3.html +++ b/man/tip/nng_pull_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_pull_open(3) ---

    nng_pull_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/pipeline0/pull.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/pipeline0/pull.h>
    +
     int nng_pull0_open(nng_socket *s);
     
     int nng_pull0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_push.7.html b/man/tip/nng_push.7.html index 9e0ef507..600d65b7 100644 --- a/man/tip/nng_push.7.html +++ b/man/tip/nng_push.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_push(7) ---

    nng_push(7)

    @@ -75,8 +76,30 @@ applications that need reliable delivery are encouraged to consider the

    Protocol Options

    -
    -

    The push protocol has no protocol-specific options.

    +
    +
    +
    `NNG_OPT_SENDBUF`
    +
    +

    (int, 0 - 8192) +Normally this is set to zero, indicating that send operations are unbuffered. +In unbuffered operation, send operations will wait until a suitable peer is available to receive the message. +If this is set to a positive value (up to 8192), then an intermediate buffer is +provided for the socket with the specified depth (in messages).

    +
    +
    +
    +
    + + + + + +
    + + +Transport layer buffering may occur in addition to any socket + buffer determined by this option. +
    diff --git a/man/tip/nng_push_open.3.html b/man/tip/nng_push_open.3.html index 8401d2a4..05a76c5d 100644 --- a/man/tip/nng_push_open.3.html +++ b/man/tip/nng_push_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_push_open(3) ---

    nng_push_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/pipeline0/push.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/pipeline0/push.h>
    +
     int nng_push0_open(nng_socket *s);
     
     int nng_push0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_random.3supp.html b/man/tip/nng_random.3supp.html index f8063039..35becdec 100644 --- a/man/tip/nng_random.3supp.html +++ b/man/tip/nng_random.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_random(3supp) ---

    nng_random(3supp)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    -uint32_t nng_random(void);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
    +uint32_t nng_random(void);
    diff --git a/man/tip/nng_recv.3.html b/man/tip/nng_recv.3.html index d9db3a37..e9e79abf 100644 --- a/man/tip/nng_recv.3.html +++ b/man/tip/nng_recv.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_recv(3) ---

    nng_recv(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_recv(nng_socket s, void *data, size_t *sizep, int flags);
    +
    #include <nng/nng.h>
    +
    +int nng_recv(nng_socket s, void *data, size_t *sizep, int flags);
    @@ -37,22 +38,22 @@ layout: manpage_v2
    NNG_FLAG_NONBLOCK

    The function returns immediately, even if no message is available. - Without this flag, the function will wait until a message is received - by the socket s, or any configured timer expires.

    +Without this flag, the function will wait until a message is received +by the socket s, or any configured timer expires.

    NNG_FLAG_ALLOC

    If this flag is present, then a zero-copy mode is used. - In this case the caller must set the value of data to the location - of another pointer (of type void *), and the sizep pointer must be set - to a location to receive the size of the message body. - The function will then allocate a message buffer - (as if by nng_alloc()), fill it with - the message body, and store it at the address referenced by data, and update - the size referenced by sizep. - The caller is responsible for disposing of the received buffer either by - the nng_free() function or passing the message (also - with the NNG_FLAG_ALLOC flag) in a call to nng_send().

    +In this case the caller must set the value of data to the location +of another pointer (of type void *), and the sizep pointer must be set +to a location to receive the size of the message body. +The function will then allocate a message buffer +(as if by nng_alloc()), fill it with +the message body, and store it at the address referenced by data, and update +the size referenced by sizep. +The caller is responsible for disposing of the received buffer either by +the nng_free() function or passing the message (also +with the NNG_FLAG_ALLOC flag) in a call to nng_send().

    diff --git a/man/tip/nng_recv_aio.3.html b/man/tip/nng_recv_aio.3.html index 9a186453..1343e3a6 100644 --- a/man/tip/nng_recv_aio.3.html +++ b/man/tip/nng_recv_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_recv_aio(3) ---

    nng_recv_aio(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_recv_aio(nng_socket s, nng_aio *aio);
    diff --git a/man/tip/nng_recvmsg.3.html b/man/tip/nng_recvmsg.3.html index 766b67ba..60dd3a86 100644 --- a/man/tip/nng_recvmsg.3.html +++ b/man/tip/nng_recvmsg.3.html @@ -1,13 +1,14 @@ --- version: tip layout: manpage_v2 +title: nng_recvmsg(3) ---

    nng_recvmsg(3)

    NAME

    -

    nng_recvmsg - recv message

    +

    nng_recvmsg - receive a message

    @@ -16,8 +17,8 @@ layout: manpage_v2 @@ -157,6 +158,7 @@ Furthermore, some protocols may not support receiving data at all, such as nng_recv(3), nng_sendmsg(3), nng_strerror(3), +nng_socket(5), nng(7)

    diff --git a/man/tip/nng_rep.7.html b/man/tip/nng_rep.7.html index e828bb0c..c883e56f 100644 --- a/man/tip/nng_rep.7.html +++ b/man/tip/nng_rep.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_rep(7) ---

    nng_rep(7)

    diff --git a/man/tip/nng_rep_open.3.html b/man/tip/nng_rep_open.3.html index 1bdebff4..4663f66f 100644 --- a/man/tip/nng_rep_open.3.html +++ b/man/tip/nng_rep_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_rep_open(3) ---

    nng_rep_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/reqrep0/rep.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/reqrep0/rep.h>
    +
     int nng_rep0_open(nng_socket *s);
     
     int nng_rep0_open_raw(nng_socket *);
    diff --git a/man/tip/nng_req.7.html b/man/tip/nng_req.7.html index 1ed71b8c..32ca4dfe 100644 --- a/man/tip/nng_req.7.html +++ b/man/tip/nng_req.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_req(7) ---

    nng_req(7)

    @@ -40,7 +41,7 @@ until a reply is received or the request times out.

    This protocol is useful in setting up RPC-like services. -It is also "reliable", in that a the requester will keep retrying until +It is also "reliable", in that a the requester will keep retrying until a reply is received. @@ -149,12 +150,12 @@ a separate socket.

    NNG_OPT_REQ_RESENDTIME

    (nng_duration) - When a new request is started, a timer of this duration is also started. - If no reply is received before this timer expires, then the request will - be resent. - (Requests are also automatically resent if the peer to whom - the original request was sent disconnects, or if a peer becomes available - while the requester is waiting for an available peer.)

    +When a new request is started, a timer of this duration is also started. +If no reply is received before this timer expires, then the request will +be resent. +(Requests are also automatically resent if the peer to whom +the original request was sent disconnects, or if a peer becomes available +while the requester is waiting for an available peer.)

    diff --git a/man/tip/nng_req_open.3.html b/man/tip/nng_req_open.3.html index 4ffbf3f2..99c78d0d 100644 --- a/man/tip/nng_req_open.3.html +++ b/man/tip/nng_req_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_req_open(3) ---

    nng_req_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/reqrep0/req.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/reqrep0/req.h>
    +
     int nng_req0_open(nng_socket *s);
     
     int nng_req0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_respondent.7.html b/man/tip/nng_respondent.7.html index bf9d2d51..f17afcac 100644 --- a/man/tip/nng_respondent.7.html +++ b/man/tip/nng_respondent.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_respondent(7) ---

    nng_respondent(7)

    diff --git a/man/tip/nng_respondent_open.3.html b/man/tip/nng_respondent_open.3.html index 73330241..734ae44f 100644 --- a/man/tip/nng_respondent_open.3.html +++ b/man/tip/nng_respondent_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_respondent_open(3) ---

    nng_respondent_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/survey0/respond.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/survey0/respond.h>
    +
     int nng_respondent0_open(nng_socket *s);
     
     int nng_respondent0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_send.3.html b/man/tip/nng_send.3.html index 4ccaa8e4..236109f8 100644 --- a/man/tip/nng_send.3.html +++ b/man/tip/nng_send.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_send(3) ---

    nng_send(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_send(nng_socket s, void *data, size_t size, int flags);
    +
    #include <nng/nng.h>
    +
    +int nng_send(nng_socket s, void *data, size_t size, int flags);
    @@ -58,22 +59,22 @@ which are responses to requests, until they have first received a request.)
    NNG_FLAG_NONBLOCK

    The function returns immediately, regardless of whether - the socket is able to accept the data or not. If the socket is unable - to accept the data (such as if backpressure exists because the peers - are consuming messages too slowly, or no peer is present), then the - function will return with NNG_EAGAIN. If this flag is not specified, - then the function will block if such a condition exists.

    +the socket is able to accept the data or not. If the socket is unable +to accept the data (such as if backpressure exists because the peers +are consuming messages too slowly, or no peer is present), then the +function will return with NNG_EAGAIN. If this flag is not specified, +then the function will block if such a condition exists.

    NNG_FLAG_ALLOC

    The data was allocated using nng_alloc(), or was - obtained from a call to nng_recv() with - the NNG_FLAG_ALLOC flag. - If this function returns success, then the data is "owned" by the - function, and it will assume responsibility for calling - nng_free() when it is no longer needed. - In the absence of this flag, the data is copied by the implementation - before the function returns to the caller.

    +obtained from a call to nng_recv() with +the NNG_FLAG_ALLOC flag. +If this function returns success, then the data is "owned" by the +function, and it will assume responsibility for calling +nng_free() when it is no longer needed. +In the absence of this flag, the data is copied by the implementation +before the function returns to the caller.

    diff --git a/man/tip/nng_send_aio.3.html b/man/tip/nng_send_aio.3.html index ba0a2dbf..ce6d35f8 100644 --- a/man/tip/nng_send_aio.3.html +++ b/man/tip/nng_send_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_send_aio(3) ---

    nng_send_aio(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_send_aio(nng_socket s, nng_aio *aio);
    diff --git a/man/tip/nng_sendmsg.3.html b/man/tip/nng_sendmsg.3.html index 7203fbc3..35c389d4 100644 --- a/man/tip/nng_sendmsg.3.html +++ b/man/tip/nng_sendmsg.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sendmsg(3) ---

    nng_sendmsg(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_sendmsg(nng_socket s, nng_msg *msg, int flags);
    @@ -81,12 +82,12 @@ are responses to requests, until they have first received a request.)
    NNG_FLAG_NONBLOCK

    The function returns immediately, regardless of whether - the socket is able to accept the data or not. - If the socket is unable to accept the data (such as if backpressure exists - because the peers are consuming messages too slowly, or no peer is present), - then the function will return with NNG_EAGAIN. - If this flag is not specified, then the function will block if such a - condition exists.

    +the socket is able to accept the data or not. +If the socket is unable to accept the data (such as if backpressure exists +because the peers are consuming messages too slowly, or no peer is present), +then the function will return with NNG_EAGAIN. +If this flag is not specified, then the function will block if such a +condition exists.

    diff --git a/man/tip/nng_setopt.3.html b/man/tip/nng_setopt.3.html index eef87b2b..cf1aa725 100644 --- a/man/tip/nng_setopt.3.html +++ b/man/tip/nng_setopt.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_setopt(3) ---

    nng_setopt(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_setopt(nng_socket s, const char *opt, const void *val, size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_setopt(nng_socket s, const char *opt, const void *val, size_t valsz);
     
     int nng_setopt_bool(nng_socket s, const char *opt, bool bval);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_setopt_ptr(nng_socket s, const char *opt, void *ptr);
     
    -int nng_setopt_size(nng_socket s, const char *opt, size_t z);
    +int nng_setopt_size(nng_socket s, const char *opt, size_t z);
     
     int nng_setopt_string(nng_socket s, const char *opt, const char *str);
     
    -int nng_setopt_uint64(nng_socket s, const char *opt, uint64_t u64);
    +int nng_setopt_uint64(nng_socket s, const char *opt, uint64_t u64);
    @@ -40,14 +41,15 @@ layout: manpage_v2

    DESCRIPTION

    -
    +
    - + These functions are deprecated. Please see nng_socket_set. +They may not be present if the library was built with NNG_ELIDE_DEPRECATED.
    diff --git a/man/tip/nng_sleep_aio.3.html b/man/tip/nng_sleep_aio.3.html index 03541073..c6920b97 100644 --- a/man/tip/nng_sleep_aio.3.html +++ b/man/tip/nng_sleep_aio.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sleep_aio(3) ---

    nng_sleep_aio(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_sleep_aio(nng_duration msec, nng_aio *aio);
    diff --git a/man/tip/nng_sockaddr.5.html b/man/tip/nng_sockaddr.5.html index 467da3b4..e02f26b8 100644 --- a/man/tip/nng_sockaddr.5.html +++ b/man/tip/nng_sockaddr.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr(5) ---

    nng_sockaddr(5)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef union nng_sockaddr {
    -    uint16_t              s_family;
    +    uint16_t              s_family;
         nng_sockaddr_ipc      s_ipc;
         nng_sockaddr_inproc   s_inproc;
         nng_sockaddr_in       s_in;
    diff --git a/man/tip/nng_sockaddr_abstract.5.html b/man/tip/nng_sockaddr_abstract.5.html
    index 1eec3a30..70b59a68 100644
    --- a/man/tip/nng_sockaddr_abstract.5.html
    +++ b/man/tip/nng_sockaddr_abstract.5.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_sockaddr_abstract(5)
     ---
     

    nng_sockaddr_abstract(5)

    @@ -16,15 +17,15 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_ABSTRACT = 6,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    -    uint16_t sa_len;
    +    uint16_t sa_family;
    +    uint16_t sa_len;
         char     sa_name[107];
     } nng_sockaddr_abstract;
    diff --git a/man/tip/nng_sockaddr_in.5.html b/man/tip/nng_sockaddr_in.5.html index 8e19a2ce..6013be31 100644 --- a/man/tip/nng_sockaddr_in.5.html +++ b/man/tip/nng_sockaddr_in.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_in(5) ---

    nng_sockaddr_in(5)

    @@ -16,16 +17,16 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_INET = 3,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    -    uint16_t sa_port;
    -    uint32_t sa_addr;
    +    uint16_t sa_family;
    +    uint16_t sa_port;
    +    uint32_t sa_addr;
     } nng_sockaddr_in;
    @@ -56,12 +57,12 @@ for IPv6 addresses.

    sa_port

    This field holds the TCP or UDP port number, in network byte-order. - A zero value here is used when no specific port number is indicated.

    +A zero value here is used when no specific port number is indicated.

    sa_addr

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

    +network-byte order.

    diff --git a/man/tip/nng_sockaddr_in6.5.html b/man/tip/nng_sockaddr_in6.5.html index 6799d385..68de4f0d 100644 --- a/man/tip/nng_sockaddr_in6.5.html +++ b/man/tip/nng_sockaddr_in6.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_in6(5) ---

    nng_sockaddr_in6(5)

    @@ -16,17 +17,17 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_INET6 = 4,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    -    uint16_t sa_port;
    -    uint8_t  sa_addr[16];
    -    uint32_t sa_scope;
    +    uint16_t sa_family;
    +    uint16_t sa_port;
    +    uint8_t  sa_addr[16];
    +    uint32_t sa_scope;
     } nng_sockaddr_in6;
    @@ -57,20 +58,20 @@ for IPv4 addresses.

    sa_port

    This field holds the TCP or UDP port number, in network byte-order. - A zero value here is used when no specific port number is indicated.

    +A zero value here is used when no specific port number is indicated.

    sa_addr

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

    +network-byte order.

    sa_scope

    This is the scope, and is typically used with link local - addresses to identify a specific interface. The details of - this are specific to the operating system. This value is - presented identically to the underlying system’s, including - any byte order considerations.

    +addresses to identify a specific interface. The details of +this are specific to the operating system. This value is +presented identically to the underlying system’s, including +any byte order considerations.

    diff --git a/man/tip/nng_sockaddr_inproc.5.html b/man/tip/nng_sockaddr_inproc.5.html index 26fe3db2..4b8d0368 100644 --- a/man/tip/nng_sockaddr_inproc.5.html +++ b/man/tip/nng_sockaddr_inproc.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_inproc(5) ---

    nng_sockaddr_inproc(5)

    @@ -16,15 +17,15 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_INPROC = 1,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    -    uint16_t sa_name[128];
    +    uint16_t sa_family;
    +    uint16_t sa_name[128];
     } nng_sockaddr_inproc;
    @@ -50,7 +51,7 @@ using the inproc transport.

    sa_name

    This field holds an arbitrary C string, which is the name of the address. - The string must be NUL terminated, but no other restrictions exist.

    +The string must be NUL terminated, but no other restrictions exist.

    diff --git a/man/tip/nng_sockaddr_ipc.5.html b/man/tip/nng_sockaddr_ipc.5.html index 90e9b04c..183ce16d 100644 --- a/man/tip/nng_sockaddr_ipc.5.html +++ b/man/tip/nng_sockaddr_ipc.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_ipc(5) ---

    nng_sockaddr_ipc(5)

    @@ -16,14 +17,14 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_IPC = 2,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    +    uint16_t sa_family;
         char     sa_path[128];
     } nng_sockaddr_ipc;
    diff --git a/man/tip/nng_sockaddr_zt.5.html b/man/tip/nng_sockaddr_zt.5.html index 3a5b6447..7d4d8017 100644 --- a/man/tip/nng_sockaddr_zt.5.html +++ b/man/tip/nng_sockaddr_zt.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sockaddr_zt(5) ---

    nng_sockaddr_zt(5)

    @@ -16,17 +17,17 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     enum sockaddr_family {
         NNG_AF_ZT = 5,
     };
     
     typedef struct {
    -    uint16_t sa_family;
    -    uint64_t sa_nwid;
    -    uint64_t sa_nodeid;
    -    uint32_t sa_port;
    +    uint16_t sa_family;
    +    uint64_t sa_nwid;
    +    uint64_t sa_nodeid;
    +    uint32_t sa_port;
     } nng_sockaddr_zt;
    @@ -65,27 +66,28 @@ are still considered experimental, and subject to change.
    sa_nwid
    -

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

    +

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

    sa_nodeid

    This field holds the ZeroTier node ID. - This value is in native byte order, and only the lower 40 bits - are significant. - (ZeroTier node numbers are 40 bits long.) - A zero value here is used for a wild-card to indicate that the - caller’s own node number be used.

    +This value is in native byte order, and only the lower 40 bits +are significant. +(ZeroTier node numbers are 40 bits long.) +A zero value here is used for a wild-card to indicate that the +caller’s own node number be used.

    sa_port

    This field holds the port number used by the - zt transport to distinguish different - sockets. - This value in native byte order. - A zero value here indicates that a port number should be chosen - randomly from the ephemeral ports. - Only the lower 24 bits of the port number are used.

    +zt transport to distinguish different +sockets. +This value in native byte order. +A zero value here indicates that a port number should be chosen +randomly from the ephemeral ports. +Only the lower 24 bits of the port number are used.

    diff --git a/man/tip/nng_socket.5.html b/man/tip/nng_socket.5.html index 81f421fd..9e5adb11 100644 --- a/man/tip/nng_socket.5.html +++ b/man/tip/nng_socket.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket(5) ---

    nng_socket(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_socket_s nng_socket;
    diff --git a/man/tip/nng_socket_get.3.html b/man/tip/nng_socket_get.3.html index 8407e430..de493e9f 100644 --- a/man/tip/nng_socket_get.3.html +++ b/man/tip/nng_socket_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_get(3) ---

    nng_socket_get(3)

    @@ -16,17 +17,17 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_socket_get(nng_socket s, const char *opt, void *val, size_t *valszp);
    +
    #include <nng/nng.h>
    +
    +int nng_socket_get(nng_socket s, const char *opt, void *val, size_t *valszp);
     
     int nng_socket_get_bool(nng_socket s, const char *opt, bool *bvalp);
     
     int nng_socket_get_int(nng_socket s, const char *opt, int *ivalp);
     
    -int nng_socket_get_size(nng_socket s, const char *opt, size_t *zp);
    +int nng_socket_get_size(nng_socket s, const char *opt, size_t *zp);
     
    -int nng_socket_get_uint64(nng_socket s, const char *opt, uint64_t *u64p);
    +int nng_socket_get_uint64(nng_socket s, const char *opt, uint64_t *u64p);
     
     int nng_socket_get_string(nng_socket s, const char *opt, char **strp);
     
    @@ -49,8 +50,22 @@ The actual options that may be retrieved in this way vary.
     A number of them are documented in nng_options(5).

    -

    Additionally transport-specific options and protocol-specific options are -documented with the transports and protocols themselves.

    +

    Additionally protocol-specific options are documented with the protocols themselves.

    +
    +
    + + + + + +
    + + +Access to transport options via this function is deprecated, and may be +removed from a future release. Applications should instead make use of +nng_dialer_get or +nng_listener_get for specific dialers or listeners. +

    Forms

    diff --git a/man/tip/nng_socket_id.3.html b/man/tip/nng_socket_id.3.html index ea5fc527..e95fe45b 100644 --- a/man/tip/nng_socket_id.3.html +++ b/man/tip/nng_socket_id.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_id(3) ---

    nng_socket_id(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_socket_id(nng_socket s);
    diff --git a/man/tip/nng_socket_set.3.html b/man/tip/nng_socket_set.3.html index ea96ccd5..e929be17 100644 --- a/man/tip/nng_socket_set.3.html +++ b/man/tip/nng_socket_set.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_socket_set(3) ---

    nng_socket_set(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_socket_set(nng_socket s, const char *opt, const void *val, size_t valsz);
    +
    #include <nng/nng.h>
    +
    +int nng_socket_set(nng_socket s, const char *opt, const void *val, size_t valsz);
     
     int nng_socket_set_bool(nng_socket s, const char *opt, bool bval);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_socket_set_ptr(nng_socket s, const char *opt, void *ptr);
     
    -int nng_socket_set_size(nng_socket s, const char *opt, size_t z);
    +int nng_socket_set_size(nng_socket s, const char *opt, size_t z);
     
     int nng_socket_set_string(nng_socket s, const char *opt, const char *str);
     
    -int nng_socket_set_uint64(nng_socket s, const char *opt, uint64_t u64);
    +int nng_socket_set_uint64(nng_socket s, const char *opt, uint64_t u64);
    @@ -48,14 +49,28 @@ specified by opt. A number of them are documented in nng_options(5).

    -

    Additionally some transport-specific and protocol-specific options are -documented with the transports and protocols themselves.

    +

    Protocol-specific options are documented with the protocol in question.

    +
    +
    + + + + + +
    + + +Access to transport options via this function is deprecated, and may be +removed from a future release. Applications should instead make use of +nng_dialer_get or +nng_listener_get for specific dialers or listeners. +

    Forms

    The details of the type, size, and semantics of the option will depend -on the actual option, and will be documented with the option itself.

    +on the actual option, and is documented with the option itself.

    diff --git a/man/tip/nng_stat.5.html b/man/tip/nng_stat.5.html index 072d9ff1..ccdf0e47 100644 --- a/man/tip/nng_stat.5.html +++ b/man/tip/nng_stat.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat(5) ---

    nng_stat(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
    diff --git a/man/tip/nng_stat_bool.3.html b/man/tip/nng_stat_bool.3.html new file mode 100644 index 00000000..3f98b403 --- /dev/null +++ b/man/tip/nng_stat_bool.3.html @@ -0,0 +1,68 @@ +--- +version: tip +layout: manpage_v2 +title: nng_stat_bool(3) +--- +

    nng_stat_bool(3)

    +
    +

    NAME

    +
    +
    +

    nng_stat_bool - get statistic Boolean value

    +
    +
    +
    +
    +

    SYNOPSIS

    +
    +
    +
    +
    #include <nng/nng.h>
    +
    +typedef struct nng_stat nng_stat;
    +
    +bool nng_stat_bool(nng_stat *stat);
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +
    +

    The nng_stat_bool() function returns the Boolean value for the statistic stat. +Otherwise, if the statistic is not of Boolean type, the result is indeterminate. +See nng_stat_type() for a description of statistic types.

    +
    +
    +
    +
    +

    RETURN VALUES

    +
    +
    +

    The boolean value associated with stat.

    +
    +
    +
    +
    +

    ERRORS

    +
    +
    +

    None.

    +
    +
    +
    + diff --git a/man/tip/nng_stat_child.3.html b/man/tip/nng_stat_child.3.html index 08e02f6f..5f468872 100644 --- a/man/tip/nng_stat_child.3.html +++ b/man/tip/nng_stat_child.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_child(3) ---

    nng_stat_child(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     nng_stat *nng_stat_child(nng_stat *parent);
    diff --git a/man/tip/nng_stat_desc.3.html b/man/tip/nng_stat_desc.3.html index 3afcb46d..577a86f2 100644 --- a/man/tip/nng_stat_desc.3.html +++ b/man/tip/nng_stat_desc.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_desc(3) ---

    nng_stat_desc(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     const char *nng_stat_desc(nng_stat *stat);
    diff --git a/man/tip/nng_stat_find.3.html b/man/tip/nng_stat_find.3.html index d54805a0..9892a449 100644 --- a/man/tip/nng_stat_find.3.html +++ b/man/tip/nng_stat_find.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find(3) ---

    nng_stat_find(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     nng_stat *nng_stat_find(nng_stat *stat, const char *name);
    diff --git a/man/tip/nng_stat_find_dialer.3.html b/man/tip/nng_stat_find_dialer.3.html index c241a74e..ee8d8a82 100644 --- a/man/tip/nng_stat_find_dialer.3.html +++ b/man/tip/nng_stat_find_dialer.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_find_dialer(3) ---

    nng_stat_find_dialer(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     typedef struct nng_dialer nng_dialer;
     
    diff --git a/man/tip/nng_stat_find_listener.3.html b/man/tip/nng_stat_find_listener.3.html
    index 0244b278..8535c94d 100644
    --- a/man/tip/nng_stat_find_listener.3.html
    +++ b/man/tip/nng_stat_find_listener.3.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_stat_find_listener(3)
     ---
     

    nng_stat_find_listener(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     typedef struct nng_listener nng_listener;
     
    diff --git a/man/tip/nng_stat_find_socket.3.html b/man/tip/nng_stat_find_socket.3.html
    index 097f6f6e..f2dac780 100644
    --- a/man/tip/nng_stat_find_socket.3.html
    +++ b/man/tip/nng_stat_find_socket.3.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_stat_find_socket(3)
     ---
     

    nng_stat_find_socket(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     typedef struct nng_socket nng_socket;
     
    diff --git a/man/tip/nng_stat_name.3.html b/man/tip/nng_stat_name.3.html
    index 759189f4..d2dfb87d 100644
    --- a/man/tip/nng_stat_name.3.html
    +++ b/man/tip/nng_stat_name.3.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_stat_name(3)
     ---
     

    nng_stat_name(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     const char *nng_stat_name(nng_stat *stat);
    @@ -38,7 +39,7 @@ layout: manpage_v2 -The global root statistic will have the empty string ("") as it’s name. +The global root statistic will have the empty string ("") as it’s name. diff --git a/man/tip/nng_stat_next.3.html b/man/tip/nng_stat_next.3.html index cc959200..d9955be8 100644 --- a/man/tip/nng_stat_next.3.html +++ b/man/tip/nng_stat_next.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_next(3) ---

    nng_stat_next(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     nng_stat *nng_stat_next(nng_stat *stat);
    diff --git a/man/tip/nng_stat_string.3.html b/man/tip/nng_stat_string.3.html index 106e9f81..29bbe2c7 100644 --- a/man/tip/nng_stat_string.3.html +++ b/man/tip/nng_stat_string.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_string(3) ---

    nng_stat_string(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     const char *nng_stat_string(nng_stat *stat);
    @@ -35,6 +36,19 @@ which must be of type NNG_STAT_STRING (see

    If the statistic is not of type NNG_STAT_STRING, then NULL will be returned.

    +
    + + + + + +
    + + +The returned string is valid until nng_stats_free() is called to +free the memory for the snapshot. +
    +
    diff --git a/man/tip/nng_stat_timestamp.3.html b/man/tip/nng_stat_timestamp.3.html index 9a7e18a5..f1ce4dfb 100644 --- a/man/tip/nng_stat_timestamp.3.html +++ b/man/tip/nng_stat_timestamp.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_timestamp(3) ---

    nng_stat_timestamp(3)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
    -uint64_t nng_stat_timestamp(nng_stat *stat);
    +uint64_t nng_stat_timestamp(nng_stat *stat);
    diff --git a/man/tip/nng_stat_type.3.html b/man/tip/nng_stat_type.3.html index e07f4332..e62e143d 100644 --- a/man/tip/nng_stat_type.3.html +++ b/man/tip/nng_stat_type.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stat_type(3) ---

    nng_stat_type(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
     enum {
    diff --git a/man/tip/nng_stat_unit.3.html b/man/tip/nng_stat_unit.3.html
    index 6e070d94..294406f7 100644
    --- a/man/tip/nng_stat_unit.3.html
    +++ b/man/tip/nng_stat_unit.3.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_stat_unit(3)
     ---
     

    nng_stat_unit(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    @@ -59,6 +58,7 @@ See nng_stat_type() for a descri

    libnng(3), nng_stats_get(3), +nng_stat_bool(3), nng_stat_type(3), nng_stat_unit(3), nng_stat(5), diff --git a/man/tip/nng_stats_free.3.html b/man/tip/nng_stats_free.3.html index f26ef808..3c4e580b 100644 --- a/man/tip/nng_stats_free.3.html +++ b/man/tip/nng_stats_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stats_free(3) ---

    nng_stats_free(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef nng_stat nng_stat;
     
     void nng_stats_free(nng_stat *);
    diff --git a/man/tip/nng_stats_get.3.html b/man/tip/nng_stats_get.3.html index 9bdb60a3..b1621f94 100644 --- a/man/tip/nng_stats_get.3.html +++ b/man/tip/nng_stats_get.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stats_get(3) ---

    nng_stats_get(3)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stat nng_stat;
     
    -int nng_stats_get(nng_stat **statsp)
    +int nng_stats_get(nng_stat **statsp)
    diff --git a/man/tip/nng_strdup.3.html b/man/tip/nng_strdup.3.html index 1d4068da..5b0b7949 100644 --- a/man/tip/nng_strdup.3.html +++ b/man/tip/nng_strdup.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strdup(3) ---

    nng_strdup(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     char *nng_strdup(const char *src);
    @@ -31,7 +32,7 @@ layout: manpage_v2

    This is logically equivalent to using nng_alloc() -to allocate a region of memory of strlen(s) + 1 bytes, and then +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.

    diff --git a/man/tip/nng_stream.5.html b/man/tip/nng_stream.5.html index 649e72a4..f2dbab8d 100644 --- a/man/tip/nng_stream.5.html +++ b/man/tip/nng_stream.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream(5) ---

    nng_stream(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stream nng_stream;
    diff --git a/man/tip/nng_stream_close.3str.html b/man/tip/nng_stream_close.3str.html index 3c367973..efede130 100644 --- a/man/tip/nng_stream_close.3str.html +++ b/man/tip/nng_stream_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_close(3str) ---

    nng_stream_close(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_close(nng_stream *s);
    diff --git a/man/tip/nng_stream_dialer.5.html b/man/tip/nng_stream_dialer.5.html index 2d3e0a84..285e2614 100644 --- a/man/tip/nng_stream_dialer.5.html +++ b/man/tip/nng_stream_dialer.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer(5) ---

    nng_stream_dialer(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stream_dialer nng_stream_dialer;
    diff --git a/man/tip/nng_stream_dialer_alloc.3str.html b/man/tip/nng_stream_dialer_alloc.3str.html index 23f1746c..2c7f7db3 100644 --- a/man/tip/nng_stream_dialer_alloc.3str.html +++ b/man/tip/nng_stream_dialer_alloc.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_alloc(3str) ---

    nng_stream_dialer_alloc(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_stream_dialer_alloc(nng_stream_dialer **dp, const char *addr);
     
     int nng_stream_dialer_alloc_url(nng_stream_dialer **dp, const nng_url *url);
    @@ -46,7 +47,7 @@ or pre-constructed

    These functions may support different URL schemes, such as -ipc://, tcp://, tls+tcp://, or ws://.

    +ipc://, tcp://, tls+tcp://, or ws://.

    Both forms store the dialer in the location referenced by dp.

    diff --git a/man/tip/nng_stream_dialer_close.3str.html b/man/tip/nng_stream_dialer_close.3str.html index 29368827..00043079 100644 --- a/man/tip/nng_stream_dialer_close.3str.html +++ b/man/tip/nng_stream_dialer_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_close(3str) ---

    nng_stream_dialer_close(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_dialer_close(nng_stream_dialer *d);
    diff --git a/man/tip/nng_stream_dialer_dial.3str.html b/man/tip/nng_stream_dialer_dial.3str.html index 2e0123fc..ae12872b 100644 --- a/man/tip/nng_stream_dialer_dial.3str.html +++ b/man/tip/nng_stream_dialer_dial.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_dial(3str) ---

    nng_stream_dialer_dial(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_dialer_dial(nng_stream_dialer *d, nng_aio *aio);
    diff --git a/man/tip/nng_stream_dialer_free.3str.html b/man/tip/nng_stream_dialer_free.3str.html index 46b3d917..247e133a 100644 --- a/man/tip/nng_stream_dialer_free.3str.html +++ b/man/tip/nng_stream_dialer_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_free(3str) ---

    nng_stream_dialer_free(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_dialer_free(nng_stream_dialer *d);
    diff --git a/man/tip/nng_stream_dialer_get.3str.html b/man/tip/nng_stream_dialer_get.3str.html index fb514120..a2fb1e8f 100644 --- a/man/tip/nng_stream_dialer_get.3str.html +++ b/man/tip/nng_stream_dialer_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_get(3str) ---

    nng_stream_dialer_get(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_dialer_get(nng_stream_dialer *d, const char *opt, void *val, size_t *sizep);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_dialer_get(nng_stream_dialer *d, const char *opt, void *val, size_t *sizep);
     
     int nng_stream_dialer_get_bool(nng_stream_dialer *d, const char *opt, bool *valp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_stream_dialer_get_ptr(nng_stream_dialer *d, const char *opt, void **valp);
     
    -int nng_stream_dialer_get_size(nng_stream_dialer *d, const char *opt, size_t *valp);
    +int nng_stream_dialer_get_size(nng_stream_dialer *d, const char *opt, size_t *valp);
     
     int nng_stream_dialer_get_addr(nng_stream_dialer *d, const char *opt, nng_sockaddr *valp);
     
     int nng_stream_dialer_get_string(nng_stream_dialer *d, const char *opt, char **valp);
     
    -int nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *opt, uint64_t *valp);
    +int nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *opt, uint64_t *valp);
    @@ -190,7 +191,7 @@ numbers, and similar options.

    There was insufficient space to receive the object. - The amount of data actually needed is returned in sizep.

    +The amount of data actually needed is returned in sizep.

    diff --git a/man/tip/nng_stream_dialer_set.3str.html b/man/tip/nng_stream_dialer_set.3str.html index 71ff3803..10e36dd9 100644 --- a/man/tip/nng_stream_dialer_set.3str.html +++ b/man/tip/nng_stream_dialer_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_dialer_set(3str) ---

    nng_stream_dialer_set(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_dialer_set(nng_stream_dialer *d, const char *name, const void *data, size_t size);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_dialer_set(nng_stream_dialer *d, const char *name, const void *data, size_t size);
     
     int nng_stream_dialer_set_bool(nng_stream_dialer *d, const char *opt, bool val);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_stream_dialer_set_ptr(nng_stream_dialer *d, const char *opt, void *val);
     
    -int nng_stream_dialer_set_size(nng_stream_dialer *d, const char *opt, size_t val);
    +int nng_stream_dialer_set_size(nng_stream_dialer *d, const char *opt, size_t val);
     
     int nng_stream_dialer_set_string(nng_stream_dialer *d, const char *opt, const char *val);
     
    -int nng_stream_dialer_set_uint64(nng_stream_dialer *d, const char *opt, uint64_t val);
    +int nng_stream_dialer_set_uint64(nng_stream_dialer *d, const char *opt, uint64_t val);
     
     int nng_stream_dialer_set_addr(nng_stream_dialer *d, const char *opt, const nng_sockaddr *val);
    diff --git a/man/tip/nng_stream_free.3str.html b/man/tip/nng_stream_free.3str.html index 55dbdf42..b6b16ed8 100644 --- a/man/tip/nng_stream_free.3str.html +++ b/man/tip/nng_stream_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_free(3str) ---

    nng_stream_free(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_free(nng_stream *s);
    diff --git a/man/tip/nng_stream_get.3str.html b/man/tip/nng_stream_get.3str.html index fad04ccc..7105fb48 100644 --- a/man/tip/nng_stream_get.3str.html +++ b/man/tip/nng_stream_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_get(3str) ---

    nng_stream_get(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_get(nng_stream *s, const char *opt, void *val, size_t *sizep);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_get(nng_stream *s, const char *opt, void *val, size_t *sizep);
     
     int nng_stream_get_bool(nng_stream *s, const char *opt, bool *valp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_stream_get_ptr(nng_stream *s, const char *opt, void **valp);
     
    -int nng_stream_get_size(nng_stream *s, const char *opt, size_t *valp);
    +int nng_stream_get_size(nng_stream *s, const char *opt, size_t *valp);
     
     int nng_stream_get_addr(nng_stream *s, const char *opt, nng_sockaddr *valp);
     
     int nng_stream_get_string(nng_stream *s, const char *opt, char **valp);
     
    -int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp);
    +int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp);
    @@ -190,7 +191,7 @@ numbers, and similar options.

    There was insufficient space to receive the object. - The amount of data actually needed is returned in sizep.

    +The amount of data actually needed is returned in sizep.

    diff --git a/man/tip/nng_stream_listener.5.html b/man/tip/nng_stream_listener.5.html index afc49478..b80b6052 100644 --- a/man/tip/nng_stream_listener.5.html +++ b/man/tip/nng_stream_listener.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener(5) ---

    nng_stream_listener(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_stream_listener nng_stream_listener;
    diff --git a/man/tip/nng_stream_listener_accept.3str.html b/man/tip/nng_stream_listener_accept.3str.html index a16cfc75..872028d4 100644 --- a/man/tip/nng_stream_listener_accept.3str.html +++ b/man/tip/nng_stream_listener_accept.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_accept(3str) ---

    nng_stream_listener_accept(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_listener_accept(nng_stream_listener *l, nng_aio *aio);
    diff --git a/man/tip/nng_stream_listener_alloc.3str.html b/man/tip/nng_stream_listener_alloc.3str.html index c7854d8a..06008696 100644 --- a/man/tip/nng_stream_listener_alloc.3str.html +++ b/man/tip/nng_stream_listener_alloc.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_alloc(3str) ---

    nng_stream_listener_alloc(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_stream_listener_alloc(nng_stream_listener **lp, const char *addr);
     
     int nng_stream_listener_alloc_url(nng_stream_listener **lp, const nng_url *url);
    @@ -47,7 +48,7 @@ or pre-constructed

    These functions may support different URL schemes, such as -ipc://, tcp://, tls+tcp://, or ws://.

    +ipc://, tcp://, tls+tcp://, or ws://.

    Both forms store the listener in the location referenced by lp.

    diff --git a/man/tip/nng_stream_listener_close.3str.html b/man/tip/nng_stream_listener_close.3str.html index ccd76c3e..2d2c4ce8 100644 --- a/man/tip/nng_stream_listener_close.3str.html +++ b/man/tip/nng_stream_listener_close.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_close(3str) ---

    nng_stream_listener_close(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_listener_close(nng_stream_listener *l);
    diff --git a/man/tip/nng_stream_listener_free.3str.html b/man/tip/nng_stream_listener_free.3str.html index e1eabeea..bc08bd22 100644 --- a/man/tip/nng_stream_listener_free.3str.html +++ b/man/tip/nng_stream_listener_free.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_free(3str) ---

    nng_stream_listener_free(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_listener_free(nng_stream_listener *)l;
    diff --git a/man/tip/nng_stream_listener_get.3str.html b/man/tip/nng_stream_listener_get.3str.html index fc31284a..d7d42c41 100644 --- a/man/tip/nng_stream_listener_get.3str.html +++ b/man/tip/nng_stream_listener_get.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_get(3str) ---

    nng_stream_listener_get(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_listener_get(nng_stream_listener *l, const char *opt, void *val, size_t *sizep);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_listener_get(nng_stream_listener *l, const char *opt, void *val, size_t *sizep);
     
     int nng_stream_listener_get_bool(nng_stream_listener *l, const char *opt, bool *valp);
     
    @@ -28,13 +29,13 @@ layout: manpage_v2
     
     int nng_stream_listener_get_ptr(nng_stream_listener *l, const char *opt, void **valp);
     
    -int nng_stream_listener_get_size(nng_stream_listener *l, const char *opt, size_t *valp);
    +int nng_stream_listener_get_size(nng_stream_listener *l, const char *opt, size_t *valp);
     
     int nng_stream_listener_get_addr(nng_stream_listener *l, const char *opt, nng_sockaddr *valp);
     
     int nng_stream_listener_get_string(nng_stream_listener *l, const char *opt, char **valp);
     
    -int nng_stream_listener_get_uint64(nng_stream_listener *l, const char *opt, uint64_t *valp);
    +int nng_stream_listener_get_uint64(nng_stream_listener *l, const char *opt, uint64_t *valp);
    @@ -191,7 +192,7 @@ numbers, and similar options.

    There was insufficient space to receive the object. - The amount of data actually needed is returned in sizep.

    +The amount of data actually needed is returned in sizep.

    diff --git a/man/tip/nng_stream_listener_listen.3str.html b/man/tip/nng_stream_listener_listen.3str.html index b6a9bc28..33c60e78 100644 --- a/man/tip/nng_stream_listener_listen.3str.html +++ b/man/tip/nng_stream_listener_listen.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_listen(3str) ---

    nng_stream_listener_listen(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_stream_listener_listen(nng_stream_listener *l);
    diff --git a/man/tip/nng_stream_listener_set.3str.html b/man/tip/nng_stream_listener_set.3str.html index 72e33430..25366c46 100644 --- a/man/tip/nng_stream_listener_set.3str.html +++ b/man/tip/nng_stream_listener_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_listener_set(3str) ---

    nng_stream_listener_set(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_listener_set(nng_stream_listener *l, const char *name, const void *data, size_t size);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_listener_set(nng_stream_listener *l, const char *name, const void *data, size_t size);
     
     int nng_stream_listener_set_bool(nng_stream_listener *l, const char *opt, bool val);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_stream_listener_set_ptr(nng_stream_listener *l, const char *opt, void *val);
     
    -int nng_stream_listener_set_size(nng_stream_listener *l, const char *opt, size_t val);
    +int nng_stream_listener_set_size(nng_stream_listener *l, const char *opt, size_t val);
     
     int nng_stream_listener_set_string(nng_stream_listener *l, const char *opt, const char *val);
     
    -int nng_stream_listener_set_uint64(nng_stream_listener *l, const char *opt, uint64_t val);
    +int nng_stream_listener_set_uint64(nng_stream_listener *l, const char *opt, uint64_t val);
     
     int nng_stream_listener_set_addr(nng_stream_listener *l, const char *opt, const nng_sockaddr *val);
    diff --git a/man/tip/nng_stream_recv.3str.html b/man/tip/nng_stream_recv.3str.html index 880d8816..3165ca91 100644 --- a/man/tip/nng_stream_recv.3str.html +++ b/man/tip/nng_stream_recv.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_recv(3str) ---

    nng_stream_recv(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_recv(nng_stream *s, nng_aio *aio);
    diff --git a/man/tip/nng_stream_send.3str.html b/man/tip/nng_stream_send.3str.html index 77f34253..22672467 100644 --- a/man/tip/nng_stream_send.3str.html +++ b/man/tip/nng_stream_send.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_send(3str) ---

    nng_stream_send(3str)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_stream_send(nng_stream *s, nng_aio *aio);
    diff --git a/man/tip/nng_stream_set.3str.html b/man/tip/nng_stream_set.3str.html index 7f1520c2..4428a3d3 100644 --- a/man/tip/nng_stream_set.3str.html +++ b/man/tip/nng_stream_set.3str.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_stream_set(3str) ---

    nng_stream_set(3str)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -int nng_stream_set(nng_stream *s, const char *name, const void *data, size_t size);
    +
    #include <nng/nng.h>
    +
    +int nng_stream_set(nng_stream *s, const char *name, const void *data, size_t size);
     
     int nng_stream_set_bool(nng_stream *s, const char *opt, bool val);
     
    @@ -28,11 +29,11 @@ layout: manpage_v2
     
     int nng_stream_set_ptr(nng_stream *s, const char *opt, void *val);
     
    -int nng_stream_set_size(nng_stream *s, const char *opt, size_t val);
    +int nng_stream_set_size(nng_stream *s, const char *opt, size_t val);
     
     int nng_stream_set_string(nng_stream *s, const char *opt, const char *val);
     
    -int nng_stream_set_uint64(nng_stream *s, const char *opt, uint64_t val);
    +int nng_stream_set_uint64(nng_stream *s, const char *opt, uint64_t val);
     
     int nng_stream_set_addr(nng_stream *s, const char *opt, const nng_sockaddr *val);
    diff --git a/man/tip/nng_strerror.3.html b/man/tip/nng_strerror.3.html index 96bf8780..13081507 100644 --- a/man/tip/nng_strerror.3.html +++ b/man/tip/nng_strerror.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strerror(3) ---

    nng_strerror(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     const char * nng_strerror(int err);
    diff --git a/man/tip/nng_strfree.3.html b/man/tip/nng_strfree.3.html index b6c0a5df..ef0254af 100644 --- a/man/tip/nng_strfree.3.html +++ b/man/tip/nng_strfree.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_strfree(3) ---

    nng_strfree(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_strfree(char *str);
    @@ -43,7 +44,7 @@ This should only be used with strings that were allocated by nng_strdup() or nng_alloc(). In all cases, the allocation size of the string must be the same -as strlen(str) + 1. +as strlen(str) + 1. diff --git a/man/tip/nng_sub.7.html b/man/tip/nng_sub.7.html index 400da1ec..27be33fe 100644 --- a/man/tip/nng_sub.7.html +++ b/man/tip/nng_sub.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sub(7) ---

    nng_sub(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/pubsub0/sub.h>
    +
    #include <nng/nng.h>
    +#include <nng/protocol/pubsub0/sub.h>
    @@ -81,11 +82,11 @@ Attempts to send messages will result in NNG_ENOTSUP.

    NNG_OPT_SUB_SUBSCRIBE

    This option registers a topic that the subscriber is interested in. - The option is write-only, and takes an array of bytes, of arbitrary size. - Each incoming message is checked against the list of subscribed topics. - If the body begins with the entire set of bytes in the topic, then the - message is accepted. If no topic matches, then the message is - discarded.

    +The option is write-only, and takes an array of bytes, of arbitrary size. +Each incoming message is checked against the list of subscribed topics. +If the body begins with the entire set of bytes in the topic, then the +message is accepted. If no topic matches, then the message is +discarded.

    @@ -119,15 +120,15 @@ To receive all messages, an empty topic (zero length) can be used.
    NNG_OPT_SUB_UNSUBSCRIBE

    This option, also read-only, removes a topic from the subscription list. - Note that if the topic was not previously subscribed to with - NNG_OPT_SUB_SUBSCRIBE then an NNG_ENOENT error will result.

    +Note that if the topic was not previously subscribed to with +NNG_OPT_SUB_SUBSCRIBE then an NNG_ENOENT error will result.

    NNG_OPT_SUB_PREFNEW

    (bool) - This read/write option specifies the behavior of the subscriber when the queue is full. - When true (the default), the subscriber will make room in the queue by removing the oldest message. - When false, the subscriber will reject messages if the message queue does not have room.

    +This read/write option specifies the behavior of the subscriber when the queue is full. +When true (the default), the subscriber will make room in the queue by removing the oldest message. +When false, the subscriber will reject messages if the message queue does not have room.

    diff --git a/man/tip/nng_sub_open.3.html b/man/tip/nng_sub_open.3.html index 2f1a0640..55e2e51f 100644 --- a/man/tip/nng_sub_open.3.html +++ b/man/tip/nng_sub_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_sub_open(3) ---

    nng_sub_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/pubsub0/sub.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/pubsub0/sub.h>
    +
     int nng_sub0_open(nng_socket *s);
     
     int nng_sub0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_surveyor.7.html b/man/tip/nng_surveyor.7.html index 416f444c..c1c7b4c0 100644 --- a/man/tip/nng_surveyor.7.html +++ b/man/tip/nng_surveyor.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_surveyor(7) ---

    nng_surveyor(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/survey0/survey.h>
    +
    #include <nng/nng.h>
    +#include <nng/protocol/survey0/survey.h>
    @@ -134,12 +135,12 @@ version.)

    NNG_OPT_SURVEYOR_SURVEYTIME

    (nng_duration) Duration of surveys. - When a new survey is started, a timer of this duration is also started. - Any responses arriving this time will be discarded. - Attempts to receive - after the timer expires with no other surveys started will result in - NNG_ESTATE. - Attempts to receive when this timer expires will result in NNG_ETIMEDOUT.

    +When a new survey is started, a timer of this duration is also started. +Any responses arriving this time will be discarded. +Attempts to receive +after the timer expires with no other surveys started will result in +NNG_ESTATE. +Attempts to receive when this timer expires will result in NNG_ETIMEDOUT.

    diff --git a/man/tip/nng_surveyor_open.3.html b/man/tip/nng_surveyor_open.3.html index 75c91398..c725d084 100644 --- a/man/tip/nng_surveyor_open.3.html +++ b/man/tip/nng_surveyor_open.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_surveyor_open(3) ---

    nng_surveyor_open(3)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/protocol/survey0/survey.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/protocol/survey0/survey.h>
    +
     int nng_surveyor0_open(nng_socket *s);
     
     int nng_surveyor0_open_raw(nng_socket *s);
    diff --git a/man/tip/nng_tcp.7.html b/man/tip/nng_tcp.7.html index a98355dd..3d85aa49 100644 --- a/man/tip/nng_tcp.7.html +++ b/man/tip/nng_tcp.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp(7) ---

    nng_tcp(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/tcp/tcp.h>
    -
    +
    #include <nng/transport/tcp/tcp.h>
    +
     int nng_tcp_register(void);
    diff --git a/man/tip/nng_tcp_options.5.html b/man/tip/nng_tcp_options.5.html index 49c41c1b..cb003761 100644 --- a/man/tip/nng_tcp_options.5.html +++ b/man/tip/nng_tcp_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp_options(5) ---

    nng_tcp_options(5)

    @@ -16,11 +17,11 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -#define NNG_OPT_TCP_NODELAY    "tcp-nodelay"
    -#define NNG_OPT_TCP_KEEPALIVE  "tcp-keepalive"
    -#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port"
    +
    #include <nng/nng.h>
    +
    +#define NNG_OPT_TCP_NODELAY    "tcp-nodelay"
    +#define NNG_OPT_TCP_KEEPALIVE  "tcp-keepalive"
    +#define NNG_OPT_TCP_BOUND_PORT "tcp-bound-port"
    @@ -56,7 +57,7 @@ TCP/IP communications.

    NNG_OPT_TCP_NODELAY

    (bool) -This option is used to disable (or enable) the use of Nagle's algorithm +This option is used to disable (or enable) the use of Nagle's algorithm for TCP connections.

    diff --git a/man/tip/nng_tcp_register.3.html b/man/tip/nng_tcp_register.3.html index cc0b0bc7..82602dfe 100644 --- a/man/tip/nng_tcp_register.3.html +++ b/man/tip/nng_tcp_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tcp_register(3) ---

    nng_tcp_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/tcp/tcp.h>
    -
    +
    #include <nng/transport/tcp/tcp.h>
    +
     int nng_tcp_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_tcp_register() function registers the tcp transport(transport, tcp) for use.

    +
    +
    + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nng_thread_create.3supp.html b/man/tip/nng_thread_create.3supp.html index 0a385507..71f19032 100644 --- a/man/tip/nng_thread_create.3supp.html +++ b/man/tip/nng_thread_create.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_create(3supp) ---

    nng_thread_create(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     typedef struct nng_thread nng_thread;
     
     int nng_thread_create(nng_thread **thrp, void (*func)(void *), void *arg);
    diff --git a/man/tip/nng_thread_destroy.3supp.html b/man/tip/nng_thread_destroy.3supp.html index a9dc66a3..3958a7b0 100644 --- a/man/tip/nng_thread_destroy.3supp.html +++ b/man/tip/nng_thread_destroy.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_destroy(3supp) ---

    nng_thread_destroy(3supp)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
     void nng_thread_destroy(nng_thread *thread);
    diff --git a/man/tip/nng_thread_set_name.3supp.html b/man/tip/nng_thread_set_name.3supp.html index 2738d5d1..433ed8c0 100644 --- a/man/tip/nng_thread_set_name.3supp.html +++ b/man/tip/nng_thread_set_name.3supp.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_thread_set_name(3supp) ---

    nng_thread_set_name(3supp)

    @@ -16,10 +17,10 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/util/platform.h>
    -
    -void nng_set_thread_name(nng_thread *thread, const char *name);
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/util/platform.h>
    +
    +void nng_thread_set_name(nng_thread *thread, const char *name);
    diff --git a/man/tip/nng_tls.7.html b/man/tip/nng_tls.7.html index 27d02cbd..c9d51637 100644 --- a/man/tip/nng_tls.7.html +++ b/man/tip/nng_tls.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls(7) ---

    nng_tls(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/tls/tls.h>
    -
    +
    #include <nng/transport/tls/tls.h>
    +
     int nng_tls_register(void);
    @@ -88,17 +89,17 @@ license terms of any libraries you use.

    URI Format

    -

    (URI, tls+tcp://) -This transport uses URIs using the scheme tls+tcp://, followed by +

    (URI, tls+tcp://) +This transport uses URIs using the scheme tls+tcp://, followed by an IP address or hostname, followed by a colon and finally a TCP port number. For example, to contact port 4433 on the localhost -either of the following URIs could be used: tls+tcp://127.0.0.1:4433 or -tls+tcp://localhost:4433.

    +either of the following URIs could be used: tls+tcp://127.0.0.1:4433 or +tls+tcp://localhost:4433.

    -

    A URI may be restricted to IPv6 using the scheme tls+tcp6://, and may -be restricted to IPv4 using the scheme tls+tcp4://.

    +

    A URI may be restricted to IPv6 using the scheme tls+tcp6://, and may +be restricted to IPv4 using the scheme tls+tcp4://.

    @@ -107,7 +108,7 @@ be restricted to IPv4 using the scheme tls+tcp4://.

    @@ -147,8 +148,8 @@ square brackets ([]) to avoid confusion with the final colon separating the port.

    -

    For example, the same port 4433 on the IPv6 loopback address ('::1') would -be specified as tls+tcp://[::1]:4433.

    +

    For example, the same port 4433 on the IPv6 loopback address ('::1') would +be specified as tls+tcp://[::1]:4433.

    -Specifying tls+tcp6:// may not prevent IPv4 hosts from being used with +Specifying tls+tcp6:// may not prevent IPv4 hosts from being used with IPv4-in-IPv6 addresses, particularly when using a wildcard hostname with listeners. The details of this varies across operating systems. @@ -122,7 +123,7 @@ The details of this varies across operating systems. -Both tls+tcp6:// and tls+tcp4:// are specific to NNG, and may not +Both tls+tcp6:// and tls+tcp4:// are specific to NNG, and may not be understood by other implementations.
    @@ -176,13 +177,13 @@ and could be used to listen to port 9999 on the host:

    1. -

      tls+tcp://0.0.0.0:9999

      +

      tls+tcp://0.0.0.0:9999

    2. -

      tls+tcp://*:9999

      +

      tls+tcp://*:9999

    3. -

      tls+tcp://:9999

      +

      tls+tcp://:9999

    @@ -235,6 +236,12 @@ Note that setting these must be done before the transport is started.

    NNG_OPT_TLS_VERIFIED_

  • +

    NNG_OPT_TLS_PEER_CN

    +
  • +
  • +

    NNG_OPT_TLS_PEER_ALT_NAMES

    +
  • +
  • NNG_OPT_URL

  • diff --git a/man/tip/nng_tls_config.5.html b/man/tip/nng_tls_config.5.html index f9874ab0..7f41904b 100644 --- a/man/tip/nng_tls_config.5.html +++ b/man/tip/nng_tls_config.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config(5) ---

    nng_tls_config(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/supplemental/tls/tls.h>
    +
     typedef struct nng_tls_config nng_tls_config;
    diff --git a/man/tip/nng_tls_config_alloc.3tls.html b/man/tip/nng_tls_config_alloc.3tls.html index 83eebe48..0ac859fd 100644 --- a/man/tip/nng_tls_config_alloc.3tls.html +++ b/man/tip/nng_tls_config_alloc.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_alloc(3tls) ---

    nng_tls_config_alloc(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     typedef enum nng_tls_mode {
         NNG_TLS_MODE_CLIENT,
         NNG_TLS_MODE_SERVER
    diff --git a/man/tip/nng_tls_config_auth_mode.3tls.html b/man/tip/nng_tls_config_auth_mode.3tls.html
    index 76fdb85a..20172fda 100644
    --- a/man/tip/nng_tls_config_auth_mode.3tls.html
    +++ b/man/tip/nng_tls_config_auth_mode.3tls.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_tls_config_auth_mode(3tls)
     ---
     

    nng_tls_config_auth_mode(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     typedef enum nng_tls_auth_mode {
             NNG_TLS_AUTH_MODE_NONE,
             NNG_TLS_AUTH_MODE_OPTIONAL,
    diff --git a/man/tip/nng_tls_config_ca_chain.3tls.html b/man/tip/nng_tls_config_ca_chain.3tls.html
    index ddf0ee10..971095c0 100644
    --- a/man/tip/nng_tls_config_ca_chain.3tls.html
    +++ b/man/tip/nng_tls_config_ca_chain.3tls.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_tls_config_ca_chain(3tls)
     ---
     

    nng_tls_config_ca_chain(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     int nng_tls_config_ca_chain(nng_tls_config *cfg, const char *chain, const char *crl);
    diff --git a/man/tip/nng_tls_config_ca_file.3tls.html b/man/tip/nng_tls_config_ca_file.3tls.html index c764d5ac..9ae0db00 100644 --- a/man/tip/nng_tls_config_ca_file.3tls.html +++ b/man/tip/nng_tls_config_ca_file.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_ca_file(3tls) ---

    nng_tls_config_ca_file(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     int nng_tls_config_ca_file(nng_tls_config *cfg, const char *path);
    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 e12a54ae..9f20af64 100644 --- a/man/tip/nng_tls_config_cert_key_file.3tls.html +++ b/man/tip/nng_tls_config_cert_key_file.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_cert_key_file(3tls) ---

    nng_tls_config_cert_key_file(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     int nng_tls_config_cert_key_file(nng_tls_config *cfg, const char *path,
         const char *pass);
    diff --git a/man/tip/nng_tls_config_free.3tls.html b/man/tip/nng_tls_config_free.3tls.html index f96a7b7f..7f738366 100644 --- a/man/tip/nng_tls_config_free.3tls.html +++ b/man/tip/nng_tls_config_free.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_free(3tls) ---

    nng_tls_config_free(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     void nng_tls_config_free(nng_tls_config *cfg);
    diff --git a/man/tip/nng_tls_config_hold.3tls.html b/man/tip/nng_tls_config_hold.3tls.html index c6eee3ee..c9102e82 100644 --- a/man/tip/nng_tls_config_hold.3tls.html +++ b/man/tip/nng_tls_config_hold.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_hold(3tls) ---

    nng_tls_config_hold(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     void nng_tls_config_alloc(nng_tls_config *cfg);
    diff --git a/man/tip/nng_tls_config_own_cert.3tls.html b/man/tip/nng_tls_config_own_cert.3tls.html index 7c02dc00..0c9cb630 100644 --- a/man/tip/nng_tls_config_own_cert.3tls.html +++ b/man/tip/nng_tls_config_own_cert.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_own_cert(3tls) ---

    nng_tls_config_own_cert(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     int nng_tls_config_own_cert(nng_tls_config *cfg, const char *cert,
         const char *key, const char *pass);
    diff --git a/man/tip/nng_tls_config_server_name.3tls.html b/man/tip/nng_tls_config_server_name.3tls.html index 79ace5c9..cb800b4f 100644 --- a/man/tip/nng_tls_config_server_name.3tls.html +++ b/man/tip/nng_tls_config_server_name.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_server_name(3tls) ---

    nng_tls_config_server_name(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     int nng_tls_config_server_name(nng_tls_config *cfg, const char *name);
    diff --git a/man/tip/nng_tls_config_version.3tls.html b/man/tip/nng_tls_config_version.3tls.html index 34d6ebbf..f92f1ebe 100644 --- a/man/tip/nng_tls_config_version.3tls.html +++ b/man/tip/nng_tls_config_version.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_config_version(3tls) ---

    nng_tls_config_version(3tls)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -#include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/nng.h>
    +#include <nng/supplemental/tls/tls.h>
    +
     typedef enum nng_tls_version {
         NNG_TLS_1_0 = 0x301,
         NNG_TLS_1_1 = 0x302,
    diff --git a/man/tip/nng_tls_engine.5.html b/man/tip/nng_tls_engine.5.html
    index 55454339..b3d434af 100644
    --- a/man/tip/nng_tls_engine.5.html
    +++ b/man/tip/nng_tls_engine.5.html
    @@ -1,6 +1,7 @@
     ---
     version: tip
     layout: manpage_v2
    +title: nng_tls_engine(5)
     ---
     

    nng_tls_engine(5)

    @@ -16,9 +17,9 @@ layout: manpage_v2
    -
    #include <nng/supplemental/tls/tls.h>
    -#include <nng/supplemental/tls/engine.h>
    -
    +
    #include <nng/supplemental/tls/tls.h>
    +#include <nng/supplemental/tls/engine.h>
    +
     typedef struct nng_tls_engine_s nng_tls_engine;
    diff --git a/man/tip/nng_tls_engine_description.3tls.html b/man/tip/nng_tls_engine_description.3tls.html index d63d6aac..e931e619 100644 --- a/man/tip/nng_tls_engine_description.3tls.html +++ b/man/tip/nng_tls_engine_description.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_description(3tls) ---

    nng_tls_engine_description(3tls)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/supplemental/tls/tls.h>
    +
     const char *nng_tls_engine_description(void);
    @@ -29,7 +30,7 @@ layout: manpage_v2

    The nng_tls_engine_description() returns a short description for the current TLS engine. -If no engine is registered, then the empty string ("") is returned. +If no engine is registered, then the empty string ("") is returned. This is principally useful for diagnostic purposes.

    diff --git a/man/tip/nng_tls_engine_fips_mode.3tls.html b/man/tip/nng_tls_engine_fips_mode.3tls.html index 87b4cf5e..6e587223 100644 --- a/man/tip/nng_tls_engine_fips_mode.3tls.html +++ b/man/tip/nng_tls_engine_fips_mode.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_fips_mode(3tls) ---

    nng_tls_engine_fips_mode(3tls)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/supplemental/tls/tls.h>
    +
     bool nng_tls_engine_fips_mode(void);
    diff --git a/man/tip/nng_tls_engine_name.3tls.html b/man/tip/nng_tls_engine_name.3tls.html index 4282886d..69106875 100644 --- a/man/tip/nng_tls_engine_name.3tls.html +++ b/man/tip/nng_tls_engine_name.3tls.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_engine_name(3tls) ---

    nng_tls_engine_name(3tls)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/supplemental/tls/tls.h>
    -
    +
    #include <nng/supplemental/tls/tls.h>
    +
     const char *nng_tls_engine_name(void);
    @@ -29,7 +30,7 @@ layout: manpage_v2

    The nng_tls_engine_name() returns a short name for the current TLS engine. -If no engine is registered, then the special name "none" is returned.

    +If no engine is registered, then the special name "none" is returned.

    diff --git a/man/tip/nng_tls_options.5.html b/man/tip/nng_tls_options.5.html index 9932709b..e5671549 100644 --- a/man/tip/nng_tls_options.5.html +++ b/man/tip/nng_tls_options.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_options(5) ---

    nng_tls_options(5)

    @@ -16,14 +17,16 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    -#define NNG_OPT_TLS_AUTH_MODE     "tls-authmode"
    -#define NNG_OPT_TLS_CA_FILE       "tls-ca-file"
    -#define NNG_OPT_TLS_CERT_KEY_FILE "tls-cert-key-file"
    -#define NNG_OPT_TLS_CONFIG        "tls-config"
    -#define NNG_OPT_TLS_SERVER_NAME   "tls-server-name"
    -#define NNG_OPT_TLS_VERIFIED      "tls-verified"
    +
    #include <nng/nng.h>
    +
    +#define NNG_OPT_TLS_AUTH_MODE      "tls-authmode"
    +#define NNG_OPT_TLS_CA_FILE        "tls-ca-file"
    +#define NNG_OPT_TLS_CERT_KEY_FILE  "tls-cert-key-file"
    +#define NNG_OPT_TLS_CONFIG         "tls-config"
    +#define NNG_OPT_TLS_SERVER_NAME    "tls-server-name"
    +#define NNG_OPT_TLS_VERIFIED       "tls-verified"
    +#define NNG_OPT_TLS_PEER_CN        "tls-peer-cn"
    +#define NNG_OPT_TLS_PEER_ALT_NAMES "tls-peer-alt-names"
    @@ -52,21 +55,21 @@ description of the option.

    TLS Options

    -
    [[NNG_OPT_TLS_AUTH_MODE]]NNG_OPT_TLS_AUTH_MODE
    +
    NNG_OPT_TLS_AUTH_MODE

    (int) Write-only option used to configure the authentication mode used. See nng_tls_config_auth_mode() for more details.

    -
    [[NNG_OPT_TLS_CA_FILE]]NNG_OPT_TLS_CA_FILE
    +
    NNG_OPT_TLS_CA_FILE

    (string) Write-only option naming a file containing certificates to use for peer validation. See nng_tls_config_ca_file() for more information.

    -
    [[NNG_OPT_TLS_CERT_KEY_FILE]]NNG_OPT_TLS_CERT_KEY_FILE
    +
    NNG_OPT_TLS_CERT_KEY_FILE

    (string) Write-only option naming a file containing the local certificate and associated private key. @@ -74,7 +77,7 @@ The private key used must be unencrypted. See nng_tls_config_own_cert() for more information.

    -
    [[NNG_OPT_TLS_CONFIG]]NNG_OPT_TLS_CONFIG
    +
    NNG_OPT_TLS_CONFIG

    (nng_tls_config *) This option references the underlying @@ -108,7 +111,7 @@ Use this option when more advanced TLS configuration is required.

    -
    [[NNG_OPT_TLS_SERVER_NAME]]NNG_OPT_TLS_SERVER_NAME
    +
    NNG_OPT_TLS_SERVER_NAME

    (string) This write-only option is used to specify the name of the server. @@ -117,13 +120,25 @@ indication, which is used as a hint by a multihosting server to choose the appropriate certificate to provide) and also is used to validate the name presented in the server’s x509 certificate.

    -
    [[NNG_OPT_TLS_VERIFIED]]NNG_OPT_TLS_VERIFIED
    +
    NNG_OPT_TLS_VERIFIED

    (bool) This read-only option indicates whether the remote peer has been properly verified using TLS authentication. May return incorrect results if peer authentication is disabled.

    +
    NNG_OPT_TLS_PEER_CN
    +
    +

    (string) +This read-only option returns the common name of the peer certificate. +May return incorrect results if peer authentication is disabled.

    +
    +
    NNG_OPT_TLS_PEER_ALT_NAMES
    +
    +

    (string) +This read-only option returns string list with the subject alternative names of the +peer certificate. May return incorrect results if peer authentication is disabled.

    +
    diff --git a/man/tip/nng_tls_register.3.html b/man/tip/nng_tls_register.3.html index 64c67d6f..1c61f130 100644 --- a/man/tip/nng_tls_register.3.html +++ b/man/tip/nng_tls_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_tls_register(3) ---

    nng_tls_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/tls/tls.h>
    -
    +
    #include <nng/transport/tls/tls.h>
    +
     int nng_tls_register(void);
    diff --git a/man/tip/nng_url.5.html b/man/tip/nng_url.5.html index db244943..0d631d1f 100644 --- a/man/tip/nng_url.5.html +++ b/man/tip/nng_url.5.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url(5) ---

    nng_url(5)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     typedef struct nng_url {
         char *u_rawurl;
         char *u_scheme;
    @@ -65,7 +66,7 @@ alter them, as the underlying memory is managed by the library.

    u_scheme -

    The URL scheme, such as "http" or "inproc". Always lower case. This will never be NULL.

    +

    The URL scheme, such as "http" or "inproc". Always lower case. This will never be NULL.

    diff --git a/man/tip/nng_url_clone.3.html b/man/tip/nng_url_clone.3.html index 4feaad7c..27715560 100644 --- a/man/tip/nng_url_clone.3.html +++ b/man/tip/nng_url_clone.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_clone(3) ---

    nng_url_clone(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_url_clone(nng_url **dup, nng_url *orig);
    diff --git a/man/tip/nng_url_free.3.html b/man/tip/nng_url_free.3.html index 80474e3e..8b0df134 100644 --- a/man/tip/nng_url_free.3.html +++ b/man/tip/nng_url_free.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_free(3) ---

    nng_url_free(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     void nng_url_free(nng_url *url);
    diff --git a/man/tip/nng_url_parse.3.html b/man/tip/nng_url_parse.3.html index fbf863f7..469a4a7c 100644 --- a/man/tip/nng_url_parse.3.html +++ b/man/tip/nng_url_parse.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_url_parse(3) ---

    nng_url_parse(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     int nng_url_parse(nng_url **urlp, const char *str);
    @@ -50,34 +51,34 @@ follows:

  • The u_scheme, u_hostname, u_host, and u_port members are - converted to lower case.

    +converted to lower case.

  • Percent-encoded values for - unreserved characters - converted to their unencoded forms.

    +unreserved characters +converted to their unencoded forms.

  • Additionally URL percent-encoded values for characters in the path - and with numeric values larger than 127 (i.e. not ASCII) are decoded.

    +and with numeric values larger than 127 (i.e. not ASCII) are decoded.

  • The resulting u_path is checked for invalid UTF-8 sequences, consisting - of surrogate pairs, illegal byte sequences, or overlong encodings. - If this check fails, then the entire URL is considered invalid, and - the function returns NNG_EINVAL.

    +of surrogate pairs, illegal byte sequences, or overlong encodings. +If this check fails, then the entire URL is considered invalid, and +the function returns NNG_EINVAL.

  • Path segments consisting of . and .. are resolved as per - RFC 3986 6.2.2.3.

    +RFC 3986 6.2.2.3.

  • Further, empty path segments are removed, meaning that duplicate - slash (/) separators are removed from the path.

    +slash (/) separators are removed from the path.

  • If a port was not specified, but the scheme defines a default - port, then u_port will be filled in with the value of the default port.

    +port, then u_port will be filled in with the value of the default port.

  • diff --git a/man/tip/nng_version.3.html b/man/tip/nng_version.3.html index abd2b4e7..0993cb3b 100644 --- a/man/tip/nng_version.3.html +++ b/man/tip/nng_version.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_version(3) ---

    nng_version(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/nng.h>
    -
    +
    #include <nng/nng.h>
    +
     const char * nng_version(void);
    @@ -67,7 +68,7 @@ via some predefined macros:

    Semantic Versioning 2.0, and the version numbers reported refer to both the API and the library itself. -(The ABI -- application binary interface -- between the +(The ABI — application binary interface — between the library and the application is controlled in a similar, but different manner depending upon the link options and how the library is built.)

    diff --git a/man/tip/nng_ws.7.html b/man/tip/nng_ws.7.html index dd252cc5..fc54b683 100644 --- a/man/tip/nng_ws.7.html +++ b/man/tip/nng_ws.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ws(7) ---

    nng_ws(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/websocket/ws.h>
    -
    +
    #include <nng/transport/websocket/ws.h>
    +
     int nng_ws_register(void);
     int nng_wss_register(void);
    @@ -28,7 +29,7 @@ layout: manpage_v2

    DESCRIPTION

    -

    (transport, ws and wss) +

    (transport, ws and _wss_) The ws transport provides communication support between peers across a TCP/IP network using WebSockets. @@ -329,6 +330,17 @@ more details.

    authentication. May return incorrect results if peer authentication is disabled.

    +
    NNG_OPT_TLS_PEER_CN
    +
    +

    (string) This read-only option returns the common name of the peer certificate. +May return incorrect results if peer authentication is disabled.

    +
    +
    NNG_OPT_TLS_PEER_ALT_NAMES
    +
    +

    (string list) returns string list with the subject alternative names of the +peer certificate. May return incorrect results if peer authentication +is disabled.

    +
    diff --git a/man/tip/nng_ws_register.3.html b/man/tip/nng_ws_register.3.html index ddebc167..b8a8f2b6 100644 --- a/man/tip/nng_ws_register.3.html +++ b/man/tip/nng_ws_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_ws_register(3) ---

    nng_ws_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/websocket/ws.h>
    -
    +
    #include <nng/transport/websocket/ws.h>
    +
     int nng_ws_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_ws_register() function registers the ws transport(transport, ws) for use.

    +
    + + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nng_wss_register.3.html b/man/tip/nng_wss_register.3.html index 76a05883..f2b09090 100644 --- a/man/tip/nng_wss_register.3.html +++ b/man/tip/nng_wss_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_wss_register(3) ---

    nng_wss_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/websocket/ws.h>
    -
    +
    #include <nng/transport/websocket/ws.h>
    +
     int nng_wss_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_wss_register() function registers the wss transport(transport, wss) for use.

    +
    + + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nng_zerotier.7.html b/man/tip/nng_zerotier.7.html index 0f818434..3f0a924b 100644 --- a/man/tip/nng_zerotier.7.html +++ b/man/tip/nng_zerotier.7.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_zerotier(7) ---

    nng_zerotier(7)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/zerotier/zerotier.h>
    -
    +
    #include <nng/transport/zerotier/zerotier.h>
    +
     int nng_zt_register(void);
    @@ -70,7 +71,7 @@ and adhere to the licensing terms. The ZeroTier transport can take a long time to establish an -initial connection -- up to even a minute in extreme cases, while the network +initial connection — up to even a minute in extreme cases, while the network topology is configured. Consequently, this transport is not recommended for use cases involving short-lived programs, but is better for long-running programs such as background daemons or agents. @@ -146,7 +147,7 @@ the actual structure is of type

    Node Presence

    -

    By default this transport creates an "ephemeral" node, and used the +

    By default this transport creates an "ephemeral" node, and used the same ephemeral node for any additional endpoints created. As this node is ephemeral, the keys associated with it and all associated data are located in memory and are discarded upon application termination. @@ -211,12 +212,12 @@ The network is most likely not available.

    NNG_OPT_ZT_HOME

    (string) This option represents the home directory, where the transport - 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, - and no persistent state is used. - The default is to use an ephemeral node.

    +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, +and no persistent state is used. +The default is to use an ephemeral node.

    @@ -251,8 +252,9 @@ in this fashion.
    NNG_OPT_ZT_NETWORK_STATUS
    -

    (int) The ZeroTier network status. - See [Network Status] for an explanation of this option.

    +

    +(int) The ZeroTier network status. +See Network Status for an explanation of this option.

    @@ -260,8 +262,9 @@ in this fashion.
    NNG_OPT_ZT_NETWORK_NAME
    -

    (string) The name of the network - as established by the ZeroTier network administrator.

    +

    +(string) The name of the network +as established by the ZeroTier network administrator.

    @@ -270,9 +273,9 @@ in this fashion.
    NNG_OPT_ZT_CONN_TIME

    (nng_duration) - The time to wait between sending connection attempts, - only used with dialers. - The default is 500 msec.

    +The time to wait between sending connection attempts, +only used with dialers. +The default is 500 msec.

    @@ -281,10 +284,10 @@ in this fashion.
    NNG_OPT_ZT_CONN_TRIES

    (int) The maximum number of attempts to try to establish a connection - before reporting a timeout, and is only used with dialers. - The default is 240, which results in a 2 minute timeout if - NNG_OPT_ZT_CONN_TIME is at its default of 500. - If the value is set to 0, then connection attempts will keep retrying forever.

    +before reporting a timeout, and is only used with dialers. +The default is 240, which results in a 2 minute timeout if +NNG_OPT_ZT_CONN_TIME is at its default of 500. +If the value is set to 0, then connection attempts will keep retrying forever.

    @@ -293,9 +296,9 @@ in this fashion.
    NNG_OPT_ZT_PING_TIME

    (nng_duration) If no traffic has been received from - the ZeroTier peer after this - period of time, then a ping message is sent to check if the peer - is still alive.

    +the ZeroTier peer after this +period of time, then a ping message is sent to check if the peer +is still alive.

    @@ -304,8 +307,8 @@ in this fashion.
    NNG_OPT_ZT_PING_TRIES

    (int) If this number of consecutive ping requests are sent to the - peer with no response (and no other intervening traffic), then the - peer is assumed to be dead and the connection is closed.

    +peer with no response (and no other intervening traffic), then the +peer is assumed to be dead and the connection is closed.

    @@ -314,10 +317,10 @@ in this fashion.
    NNG_OPT_ZT_MTU

    (size_t) The ZeroTier virtual network MTU (read-only) as configured - on the network; this is the Virtual Layer 2 MTU. The headers used by - this transport and the protocols consume some of this for each message - sent over the network. (The transport uses 20-bytes of this, and each - protocol may consume additional space, typically not more than 16-bytes.)

    +on the network; this is the Virtual Layer 2 MTU. The headers used by +this transport and the protocols consume some of this for each message +sent over the network. (The transport uses 20-bytes of this, and each +protocol may consume additional space, typically not more than 16-bytes.)

    @@ -326,9 +329,9 @@ in this fashion.
    NNG_OPT_ZT_ORBIT

    (uint64_t[2]) Write-only array of two uint64_t values, - indicating the ID of a ZeroTier <em>moon</em>, and the node ID of the root server - for that moon. (The ID may be zero if the moon ID is the same as its - root server ID, which is conventional.)

    +indicating the ID of a ZeroTier <em>moon</em>, and the node ID of the root server +for that moon. (The ID may be zero if the moon ID is the same as its +root server ID, which is conventional.)

    @@ -337,7 +340,7 @@ in this fashion.
    NNG_OPT_ZT_DEORBIT

    (uint64_t) Write-only option indicating the moon ID to deorbit. - If the node is not already orbiting the moon, then this has no effect.

    +If the node is not already orbiting the moon, then this has no effect.

    diff --git a/man/tip/nng_zt_register.3.html b/man/tip/nng_zt_register.3.html index 2ac24e28..21764bad 100644 --- a/man/tip/nng_zt_register.3.html +++ b/man/tip/nng_zt_register.3.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nng_zt_register(3) ---

    nng_zt_register(3)

    @@ -16,8 +17,8 @@ layout: manpage_v2
    -
    #include <nng/transport/zerotier/zerotier.h>
    -
    +
    #include <nng/transport/zerotier/zerotier.h>
    +
     int nng_zt_register(void);
    @@ -30,6 +31,19 @@ layout: manpage_v2

    The nng_zt_register() function registers the zt transport(transport, zt) for use.

    +
    +
    + + + + +
    + + +This function is deprecated, and may be removed from a future release. +It is no longer necessary to explicitly register transports. +
    +
    diff --git a/man/tip/nngcat.1.html b/man/tip/nngcat.1.html index 2ca4087e..a640c1db 100644 --- a/man/tip/nngcat.1.html +++ b/man/tip/nngcat.1.html @@ -1,6 +1,7 @@ --- version: tip layout: manpage_v2 +title: nngcat(1) ---

    nngcat(1)

    @@ -97,33 +98,33 @@ each option must be presented as a separate argument to the program.

    --compat
    -

    Compatible mode. - This cause nngcat to behave more like the legacy - nanocat application. - In this mode connections are made asynchronously, - and the --pair option selects version 0 of - the pair protocol instead of version 1.

    +

    Compatible mode. +This cause nngcat to behave more like the legacy +nanocat application. +In this mode connections are made asynchronously, +and the --pair option selects version 0 of +the pair protocol instead of version 1.

    --subscribe=TOPIC

    Subscribe to TOPIC. This option can only be used with the - sub protocol. - The TOPIC is checked against the first bytes - of messages received, and messages are discarded if they do not match. - This may be specified multiple times to subscribe to multiple topics. - If not specified at all, then a default subscription to everything is assumed.

    +sub protocol. +The TOPIC is checked against the first bytes +of messages received, and messages are discarded if they do not match. +This may be specified multiple times to subscribe to multiple topics. +If not specified at all, then a default subscription to everything is assumed.

    --count==COUNT

    Limit the number of iterations when looping to COUNT iterations. - For protocols that only send, this will only send COUNT messages before - exiting. - For protocols that only receive, this will only receive COUNT messages - before exiting. - For protocols that involve a full exchange, this will only perform COUNT - exchanges (each exchange is characterized by at most a single send, and - one or more receives.) - If COUNT is zero, then an infinite number of iterations is performed.

    +For protocols that only send, this will only send COUNT messages before +exiting. +For protocols that only receive, this will only receive COUNT messages +before exiting. +For protocols that involve a full exchange, this will only perform COUNT +exchanges (each exchange is characterized by at most a single send, and +one or more receives.) +If COUNT is zero, then an infinite number of iterations is performed.

    @@ -147,75 +148,75 @@ At least one protocol must be selected.
    --bus, --bus0

    Select the bus version 0 protocol. - This protocol can send and receive messages to and from other bus version 0 - peers.

    +This protocol can send and receive messages to and from other bus version 0 +peers.

    --req, --req0

    Select the req version 0 protocol. - This protocol sends messages to rep version 0 - peers and receives replies from them.

    +This protocol sends messages to rep version 0 +peers and receives replies from them.

    --rep, --rep0

    Select the rep version 0 protocol. - This protocol receives messages from req version 0 peers - and can send replies to them.

    +This protocol receives messages from req version 0 peers +and can send replies to them.

    --pub, --pub0

    Select the pub version 0 protocol. - This protocol sends messages to sub version peers.

    +This protocol sends messages to sub version peers.

    --sub, --sub0

    Select the sub version 0 protocol. - This protocol receives messages from pub version - 0 peers, and filters them based on subscriptions set with --subscribe.

    +This protocol receives messages from pub version +0 peers, and filters them based on subscriptions set with --subscribe.

    --push, --push0

    Select the push version 0 protocol. - This protocol sends messages to pull version 0 peers. - A given message is normally only delivered to a single peer.

    +This protocol sends messages to pull version 0 peers. +A given message is normally only delivered to a single peer.

    --pull, --pull0

    Select the pull version 0 protocol. - This protocol receives - messages from push version 0 peers.

    +This protocol receives +messages from push version 0 peers.

    --pair0

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

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

    --pair1

    Select the pair version 1 protocol. - This protocol can send and receive messages with one connected pair - version 1 peer. - It is not supported in --compat mode. - (Polyamorous mode is not supported - in nngcat, although peers may be using polyamorous mode.)

    +This protocol can send and receive messages with one connected pair +version 1 peer. +It is not supported in --compat mode. +(Polyamorous mode is not supported +in nngcat, although peers may be using polyamorous mode.)

    --pair

    Acts as an alias for --pair1, unless --compat mode is selected, in - which case it acts as an alias for --pair0.

    +which case it acts as an alias for --pair0.

    --surveyor, --surveyor0

    Select the surveyor version 0 protocol. - This protocol sends a survey request to respondent - version 0 peers, and then receives replies from them.

    +This protocol sends a survey request to respondent +version 0 peers, and then receives replies from them.

    --respondent, --respondent0

    Select the respondent version 0 protocol. - This protocol receives survey requests from surveyor - version 0 peers, and can send a reply to them.

    +This protocol receives survey requests from surveyor +version 0 peers, and can send a reply to them.

    @@ -260,22 +261,22 @@ more than one peer on a given connection.
    -x, --connect-ipc=PATH

    Connect to the IPC path specified by PATH. This is the same as - --connect=ipc://PATH.

    +--connect=ipc://PATH.

    -X, --bind-ipc=PATH

    Bind to the IPC path specified by PATH. This is the same as - --bind=ipc://PATH.

    +--bind=ipc://PATH.

    -l, --connect-local=PORT

    Connect to localhost at the TCP port specified by PORT. This is the same - as --connect=tcp://127.0.0.1:PORT.

    +as --connect=tcp://127.0.0.1:PORT.

    -L, --bind-local=PORT

    Bind to the TCP port specified by PORT. This is the same as - --bind=tcp://127.0.0.1:PORT.

    +--bind=tcp://127.0.0.1:PORT.

    @@ -312,14 +313,14 @@ receives messages.

    --receive-timeout=SEC

    Give up receiving messages after SEC seconds pass without any received - messages.

    +messages.

    --recv-maxsz=COUNT

    Set the maximum message size socket will accept to COUNT bytes. - Messages larger than this will be discarded. - The default is 1048576 (1 MB). - To eliminate any restriction, use 0.

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

    --format=FORMAT
    @@ -346,11 +347,12 @@ conventions.

    hex
    -

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

    +

    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" +

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

    @@ -377,14 +379,14 @@ conventions.

    -i, --interval=SEC

    For protocols that send unsolicited data (as opposed to those that - send data only in response to received messages), this will resend the - outgoing message at repeating intervals of SEC seconds.

    +send data only in response to received messages), this will resend the +outgoing message at repeating intervals of SEC seconds.

    -d, --delay=SEC

    Wait SEC seconds before sending the first outgoing message. - This is useful to let connections establish before sending data, thereby - avoiding message loss.

    +This is useful to let connections establish before sending data, thereby +avoiding message loss.

    --send-timeout=SEC
    @@ -412,15 +414,15 @@ when using addresses that are not secured with TLS.

    --key=FILE

    Load own key from FILE. - 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.

    +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.

    --cacert=FILE

    Load CA certificates from FILE. - These CAs ("Certificate Authorities") are - used as trust roots when validating certificates presented by peers.

    +These CAs ("Certificate Authorities") are +used as trust roots when validating certificates presented by peers.

    @@ -436,9 +438,9 @@ otherwise.

    --zt-home=DIRECTORY

    Directory for persistent ZeroTier node (key material, etc.) - This directory must already exist. - Only one program may use a ZeroTier node at a time; - file locking is used to prevent this.

    +This directory must already exist. +Only one program may use a ZeroTier node at a time; +file locking is used to prevent this.

    -- cgit v1.2.3-70-g09d2