From 25cc7699fb8d03a06f2f89e94b304c735d95ddc9 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 23 Jan 2020 23:25:16 -0800 Subject: Publishing updates for v1.2.2 --- man/v1.2.2/asciidoctor.css | 426 ++++++++ man/v1.2.2/index.html | 457 +-------- man/v1.2.2/libnng.3.html | 1065 ++++++-------------- man/v1.2.2/nn_allocmsg.3compat.html | 522 +--------- man/v1.2.2/nn_bind.3compat.html | 522 +--------- man/v1.2.2/nn_close.3compat.html | 514 +--------- man/v1.2.2/nn_cmsg.3compat.html | 518 +--------- man/v1.2.2/nn_connect.3compat.html | 522 +--------- man/v1.2.2/nn_device.3compat.html | 516 +--------- man/v1.2.2/nn_errno.3compat.html | 512 +--------- man/v1.2.2/nn_freemsg.3compat.html | 518 +--------- man/v1.2.2/nn_get_statistic.3compat.html | 510 +--------- man/v1.2.2/nn_getsockopt.3compat.html | 520 +--------- man/v1.2.2/nn_poll.3compat.html | 522 +--------- man/v1.2.2/nn_reallocmsg.3compat.html | 516 +--------- man/v1.2.2/nn_recv.3compat.html | 524 +--------- man/v1.2.2/nn_recvmsg.3compat.html | 524 +--------- man/v1.2.2/nn_send.3compat.html | 522 +--------- man/v1.2.2/nn_sendmsg.3compat.html | 524 +--------- man/v1.2.2/nn_setsockopt.3compat.html | 520 +--------- man/v1.2.2/nn_shutdown.3compat.html | 518 +--------- man/v1.2.2/nn_socket.3compat.html | 536 +--------- man/v1.2.2/nn_strerror.3compat.html | 512 +--------- man/v1.2.2/nn_term.3compat.html | 514 +--------- man/v1.2.2/nng.7.html | 551 +--------- man/v1.2.2/nng_aio.5.html | 556 +--------- man/v1.2.2/nng_aio_abort.3.html | 514 +--------- man/v1.2.2/nng_aio_alloc.3.html | 556 +--------- man/v1.2.2/nng_aio_begin.3.html | 518 +--------- man/v1.2.2/nng_aio_cancel.3.html | 516 +--------- man/v1.2.2/nng_aio_count.3.html | 520 +--------- man/v1.2.2/nng_aio_defer.3.html | 518 +--------- man/v1.2.2/nng_aio_finish.3.html | 518 +--------- man/v1.2.2/nng_aio_free.3.html | 512 +--------- man/v1.2.2/nng_aio_get_input.3.html | 516 +--------- man/v1.2.2/nng_aio_get_msg.3.html | 518 +--------- man/v1.2.2/nng_aio_get_output.3.html | 514 +--------- man/v1.2.2/nng_aio_result.3.html | 516 +--------- man/v1.2.2/nng_aio_set_input.3.html | 516 +--------- man/v1.2.2/nng_aio_set_iov.3.html | 518 +--------- man/v1.2.2/nng_aio_set_msg.3.html | 516 +--------- man/v1.2.2/nng_aio_set_output.3.html | 516 +--------- man/v1.2.2/nng_aio_set_timeout.3.html | 514 +--------- man/v1.2.2/nng_aio_stop.3.html | 516 +--------- man/v1.2.2/nng_aio_wait.3.html | 510 +--------- man/v1.2.2/nng_alloc.3.html | 514 +--------- man/v1.2.2/nng_bus.7.html | 512 +--------- man/v1.2.2/nng_bus_open.3.html | 516 +--------- man/v1.2.2/nng_clock.3supp.html | 516 +--------- man/v1.2.2/nng_close.3.html | 512 +--------- man/v1.2.2/nng_compat.3compat.html | 562 +---------- man/v1.2.2/nng_ctx.5.html | 544 +--------- man/v1.2.2/nng_ctx_close.3.html | 512 +--------- man/v1.2.2/nng_ctx_get.3.html | 528 +--------- man/v1.2.2/nng_ctx_getopt.3.html | 530 +--------- man/v1.2.2/nng_ctx_id.3.html | 508 +--------- man/v1.2.2/nng_ctx_open.3.html | 526 +--------- man/v1.2.2/nng_ctx_recv.3.html | 528 +--------- man/v1.2.2/nng_ctx_send.3.html | 534 +--------- man/v1.2.2/nng_ctx_set.3.html | 520 +--------- man/v1.2.2/nng_ctx_setopt.3.html | 520 +--------- man/v1.2.2/nng_cv_alloc.3supp.html | 526 +--------- man/v1.2.2/nng_cv_free.3supp.html | 506 +--------- man/v1.2.2/nng_cv_until.3supp.html | 524 +--------- man/v1.2.2/nng_cv_wait.3supp.html | 522 +--------- man/v1.2.2/nng_cv_wake.3supp.html | 524 +--------- man/v1.2.2/nng_cv_wake1.3supp.html | 524 +--------- man/v1.2.2/nng_device.3.html | 522 +--------- man/v1.2.2/nng_dial.3.html | 528 +--------- man/v1.2.2/nng_dialer.5.html | 542 +--------- man/v1.2.2/nng_dialer_close.3.html | 516 +--------- man/v1.2.2/nng_dialer_create.3.html | 530 +--------- man/v1.2.2/nng_dialer_get.3.html | 534 +--------- man/v1.2.2/nng_dialer_getopt.3.html | 536 +--------- man/v1.2.2/nng_dialer_id.3.html | 510 +--------- man/v1.2.2/nng_dialer_set.3.html | 524 +--------- man/v1.2.2/nng_dialer_setopt.3.html | 526 +--------- man/v1.2.2/nng_dialer_start.3.html | 512 +--------- man/v1.2.2/nng_duration.5.html | 506 +--------- man/v1.2.2/nng_free.3.html | 514 +--------- man/v1.2.2/nng_getopt.3.html | 536 +--------- man/v1.2.2/nng_http_client_alloc.3http.html | 512 +--------- man/v1.2.2/nng_http_client_connect.3http.html | 524 +--------- man/v1.2.2/nng_http_client_free.3http.html | 510 +--------- man/v1.2.2/nng_http_client_get_tls.3http.html | 522 +--------- man/v1.2.2/nng_http_client_set_tls.3http.html | 518 +--------- man/v1.2.2/nng_http_client_transact.3http.html | 522 +--------- man/v1.2.2/nng_http_conn_close.3http.html | 510 +--------- man/v1.2.2/nng_http_conn_read.3http.html | 526 +--------- man/v1.2.2/nng_http_conn_read_all.3http.html | 524 +--------- man/v1.2.2/nng_http_conn_read_req.3http.html | 518 +--------- man/v1.2.2/nng_http_conn_read_res.3http.html | 526 +--------- man/v1.2.2/nng_http_conn_transact.3http.html | 530 +--------- man/v1.2.2/nng_http_conn_write.3http.html | 526 +--------- man/v1.2.2/nng_http_conn_write_all.3http.html | 546 +--------- man/v1.2.2/nng_http_conn_write_req.3http.html | 528 +--------- man/v1.2.2/nng_http_conn_write_res.3http.html | 528 +--------- man/v1.2.2/nng_http_handler_alloc.3http.html | 564 +---------- .../nng_http_handler_collect_body.3http.html | 512 +--------- man/v1.2.2/nng_http_handler_free.3http.html | 508 +--------- man/v1.2.2/nng_http_handler_get_data.3http.html | 512 +--------- man/v1.2.2/nng_http_handler_set_data.3http.html | 512 +--------- man/v1.2.2/nng_http_handler_set_host.3http.html | 508 +--------- man/v1.2.2/nng_http_handler_set_method.3http.html | 512 +--------- man/v1.2.2/nng_http_handler_set_tree.3http.html | 510 +--------- man/v1.2.2/nng_http_hijack.3http.html | 514 +--------- man/v1.2.2/nng_http_req_add_header.3http.html | 514 +--------- man/v1.2.2/nng_http_req_alloc.3http.html | 550 +--------- man/v1.2.2/nng_http_req_copy_data.3http.html | 516 +--------- man/v1.2.2/nng_http_req_del_header.3http.html | 512 +--------- man/v1.2.2/nng_http_req_free.3http.html | 510 +--------- man/v1.2.2/nng_http_req_get_data.3http.html | 510 +--------- man/v1.2.2/nng_http_req_get_header.3http.html | 510 +--------- man/v1.2.2/nng_http_req_get_method.3http.html | 508 +--------- man/v1.2.2/nng_http_req_get_uri.3http.html | 508 +--------- man/v1.2.2/nng_http_req_get_version.3http.html | 508 +--------- man/v1.2.2/nng_http_req_reset.3http.html | 512 +--------- man/v1.2.2/nng_http_req_set_data.3http.html | 516 +--------- man/v1.2.2/nng_http_req_set_header.3http.html | 514 +--------- man/v1.2.2/nng_http_req_set_method.3http.html | 508 +--------- man/v1.2.2/nng_http_req_set_uri.3http.html | 512 +--------- man/v1.2.2/nng_http_req_set_version.3http.html | 508 +--------- man/v1.2.2/nng_http_res_add_header.3http.html | 514 +--------- man/v1.2.2/nng_http_res_alloc.3http.html | 550 +--------- man/v1.2.2/nng_http_res_alloc_error.3http.html | 514 +--------- man/v1.2.2/nng_http_res_copy_data.3http.html | 516 +--------- man/v1.2.2/nng_http_res_del_header.3http.html | 512 +--------- man/v1.2.2/nng_http_res_free.3http.html | 510 +--------- man/v1.2.2/nng_http_res_get_data.3http.html | 510 +--------- man/v1.2.2/nng_http_res_get_header.3http.html | 510 +--------- man/v1.2.2/nng_http_res_get_reason.3http.html | 512 +--------- man/v1.2.2/nng_http_res_get_status.3http.html | 512 +--------- man/v1.2.2/nng_http_res_get_version.3http.html | 508 +--------- man/v1.2.2/nng_http_res_reset.3http.html | 508 +--------- man/v1.2.2/nng_http_res_set_data.3http.html | 516 +--------- man/v1.2.2/nng_http_res_set_header.3http.html | 514 +--------- man/v1.2.2/nng_http_res_set_reason.3http.html | 512 +--------- man/v1.2.2/nng_http_res_set_status.3http.html | 512 +--------- man/v1.2.2/nng_http_res_set_version.3http.html | 508 +--------- man/v1.2.2/nng_http_server_add_handler.3http.html | 514 +--------- man/v1.2.2/nng_http_server_del_handler.3http.html | 510 +--------- man/v1.2.2/nng_http_server_get_tls.3http.html | 522 +--------- man/v1.2.2/nng_http_server_hold.3http.html | 516 +--------- man/v1.2.2/nng_http_server_release.3http.html | 510 +--------- man/v1.2.2/nng_http_server_res_error.3http.html | 522 +--------- .../nng_http_server_set_error_file.3http.html | 518 +--------- .../nng_http_server_set_error_page.3http.html | 520 +--------- man/v1.2.2/nng_http_server_set_tls.3http.html | 520 +--------- man/v1.2.2/nng_http_server_start.3http.html | 514 +--------- man/v1.2.2/nng_http_server_stop.3http.html | 518 +--------- man/v1.2.2/nng_inproc.7.html | 512 +--------- man/v1.2.2/nng_inproc_register.3.html | 506 +--------- man/v1.2.2/nng_iov.5.html | 512 +--------- man/v1.2.2/nng_ipc.7.html | 514 +--------- man/v1.2.2/nng_ipc_options.5.html | 518 +--------- man/v1.2.2/nng_ipc_register.3.html | 506 +--------- man/v1.2.2/nng_listen.3.html | 526 +--------- man/v1.2.2/nng_listener.5.html | 542 +--------- man/v1.2.2/nng_listener_close.3.html | 514 +--------- man/v1.2.2/nng_listener_create.3.html | 530 +--------- man/v1.2.2/nng_listener_get.3.html | 538 +--------- man/v1.2.2/nng_listener_getopt.3.html | 540 +--------- man/v1.2.2/nng_listener_id.3.html | 510 +--------- man/v1.2.2/nng_listener_set.3.html | 528 +--------- man/v1.2.2/nng_listener_setopt.3.html | 530 +--------- man/v1.2.2/nng_listener_start.3.html | 514 +--------- man/v1.2.2/nng_msg.5.html | 536 +--------- man/v1.2.2/nng_msg_alloc.3.html | 522 +--------- man/v1.2.2/nng_msg_append.3.html | 524 +--------- man/v1.2.2/nng_msg_body.3.html | 534 +--------- man/v1.2.2/nng_msg_chop.3.html | 524 +--------- man/v1.2.2/nng_msg_clear.3.html | 506 +--------- man/v1.2.2/nng_msg_dup.3.html | 512 +--------- man/v1.2.2/nng_msg_free.3.html | 510 +--------- man/v1.2.2/nng_msg_get_pipe.3.html | 514 +--------- man/v1.2.2/nng_msg_header.3.html | 522 +--------- man/v1.2.2/nng_msg_header_append.3.html | 520 +--------- man/v1.2.2/nng_msg_header_chop.3.html | 520 +--------- man/v1.2.2/nng_msg_header_clear.3.html | 508 +--------- man/v1.2.2/nng_msg_header_insert.3.html | 522 +--------- man/v1.2.2/nng_msg_header_len.3.html | 510 +--------- man/v1.2.2/nng_msg_header_trim.3.html | 522 +--------- man/v1.2.2/nng_msg_insert.3.html | 524 +--------- man/v1.2.2/nng_msg_len.3.html | 510 +--------- man/v1.2.2/nng_msg_realloc.3.html | 528 +--------- man/v1.2.2/nng_msg_set_pipe.3.html | 514 +--------- man/v1.2.2/nng_msg_trim.3.html | 524 +--------- man/v1.2.2/nng_msleep.3supp.html | 512 +--------- man/v1.2.2/nng_mtx_alloc.3supp.html | 514 +--------- man/v1.2.2/nng_mtx_free.3supp.html | 506 +--------- man/v1.2.2/nng_mtx_lock.3supp.html | 512 +--------- man/v1.2.2/nng_mtx_unlock.3supp.html | 510 +--------- man/v1.2.2/nng_options.5.html | 572 +---------- man/v1.2.2/nng_opts_parse.3supp.html | 506 +--------- man/v1.2.2/nng_pair.7.html | 522 +--------- man/v1.2.2/nng_pair_open.3.html | 516 +--------- man/v1.2.2/nng_pipe.5.html | 530 +--------- man/v1.2.2/nng_pipe_close.3.html | 510 +--------- man/v1.2.2/nng_pipe_dialer.3.html | 512 +--------- man/v1.2.2/nng_pipe_get.3.html | 542 +--------- man/v1.2.2/nng_pipe_getopt.3.html | 544 +--------- man/v1.2.2/nng_pipe_id.3.html | 506 +--------- man/v1.2.2/nng_pipe_listener.3.html | 512 +--------- man/v1.2.2/nng_pipe_notify.3.html | 518 +--------- man/v1.2.2/nng_pipe_socket.3.html | 510 +--------- man/v1.2.2/nng_pub.7.html | 512 +--------- man/v1.2.2/nng_pub_open.3.html | 518 +--------- man/v1.2.2/nng_pull.7.html | 512 +--------- man/v1.2.2/nng_pull_open.3.html | 518 +--------- man/v1.2.2/nng_push.7.html | 516 +--------- man/v1.2.2/nng_push_open.3.html | 518 +--------- man/v1.2.2/nng_random.3supp.html | 504 +-------- man/v1.2.2/nng_recv.3.html | 526 +--------- man/v1.2.2/nng_recv_aio.3.html | 536 +--------- man/v1.2.2/nng_recvmsg.3.html | 520 +--------- man/v1.2.2/nng_rep.7.html | 518 +--------- man/v1.2.2/nng_rep_open.3.html | 518 +--------- man/v1.2.2/nng_req.7.html | 528 +--------- man/v1.2.2/nng_req_open.3.html | 520 +--------- man/v1.2.2/nng_respondent.7.html | 518 +--------- man/v1.2.2/nng_respondent_open.3.html | 518 +--------- man/v1.2.2/nng_send.3.html | 534 +--------- man/v1.2.2/nng_send_aio.3.html | 540 +--------- man/v1.2.2/nng_sendmsg.3.html | 528 +--------- man/v1.2.2/nng_setopt.3.html | 524 +--------- man/v1.2.2/nng_sleep_aio.3.html | 518 +--------- man/v1.2.2/nng_sockaddr.5.html | 524 +--------- man/v1.2.2/nng_sockaddr_in.5.html | 514 +--------- man/v1.2.2/nng_sockaddr_in6.5.html | 514 +--------- man/v1.2.2/nng_sockaddr_inproc.5.html | 512 +--------- man/v1.2.2/nng_sockaddr_ipc.5.html | 512 +--------- man/v1.2.2/nng_sockaddr_zt.5.html | 514 +--------- man/v1.2.2/nng_socket.5.html | 530 +--------- man/v1.2.2/nng_socket_get.3.html | 534 +--------- man/v1.2.2/nng_socket_id.3.html | 508 +--------- man/v1.2.2/nng_socket_set.3.html | 522 +--------- man/v1.2.2/nng_stat.5.html | 550 +--------- man/v1.2.2/nng_stat_child.3.html | 514 +--------- man/v1.2.2/nng_stat_desc.3.html | 512 +--------- man/v1.2.2/nng_stat_name.3.html | 510 +--------- man/v1.2.2/nng_stat_next.3.html | 512 +--------- man/v1.2.2/nng_stat_string.3.html | 516 +--------- man/v1.2.2/nng_stat_timestamp.3.html | 516 +--------- man/v1.2.2/nng_stat_type.3.html | 524 +--------- man/v1.2.2/nng_stat_unit.3.html | 524 +--------- man/v1.2.2/nng_stat_value.3.html | 516 +--------- man/v1.2.2/nng_stats_free.3.html | 510 +--------- man/v1.2.2/nng_stats_get.3.html | 532 +--------- man/v1.2.2/nng_strdup.3.html | 514 +--------- man/v1.2.2/nng_stream.5.html | 548 +--------- man/v1.2.2/nng_stream_close.3str.html | 520 +--------- man/v1.2.2/nng_stream_dialer.5.html | 518 +--------- man/v1.2.2/nng_stream_dialer_alloc.3str.html | 522 +--------- man/v1.2.2/nng_stream_dialer_close.3str.html | 516 +--------- man/v1.2.2/nng_stream_dialer_dial.3str.html | 524 +--------- man/v1.2.2/nng_stream_dialer_free.3str.html | 523 +--------- man/v1.2.2/nng_stream_dialer_get.3str.html | 522 +--------- man/v1.2.2/nng_stream_dialer_set.3str.html | 526 +--------- man/v1.2.2/nng_stream_free.3str.html | 518 +--------- man/v1.2.2/nng_stream_get.3str.html | 528 +--------- man/v1.2.2/nng_stream_listener.5.html | 520 +--------- man/v1.2.2/nng_stream_listener_accept.3str.html | 524 +--------- man/v1.2.2/nng_stream_listener_alloc.3str.html | 524 +--------- man/v1.2.2/nng_stream_listener_close.3str.html | 516 +--------- man/v1.2.2/nng_stream_listener_free.3str.html | 523 +--------- man/v1.2.2/nng_stream_listener_get.3str.html | 522 +--------- man/v1.2.2/nng_stream_listener_listen.3str.html | 512 +--------- man/v1.2.2/nng_stream_listener_set.3str.html | 526 +--------- man/v1.2.2/nng_stream_recv.3str.html | 526 +--------- man/v1.2.2/nng_stream_send.3str.html | 522 +--------- man/v1.2.2/nng_stream_set.3str.html | 526 +--------- man/v1.2.2/nng_strerror.3.html | 506 +--------- man/v1.2.2/nng_strfree.3.html | 520 +--------- man/v1.2.2/nng_sub.7.html | 516 +--------- man/v1.2.2/nng_sub_open.3.html | 518 +--------- man/v1.2.2/nng_surveyor.7.html | 520 +--------- man/v1.2.2/nng_surveyor_open.3.html | 518 +--------- man/v1.2.2/nng_tcp.5.html | 546 +--------- man/v1.2.2/nng_tcp.7.html | 520 +--------- man/v1.2.2/nng_tcp_options.5.html | 518 +--------- man/v1.2.2/nng_tcp_register.3.html | 506 +--------- man/v1.2.2/nng_thread_create.3supp.html | 522 +--------- man/v1.2.2/nng_thread_destroy.3supp.html | 506 +--------- man/v1.2.2/nng_tls.5.html | 546 +--------- man/v1.2.2/nng_tls.7.html | 526 +--------- man/v1.2.2/nng_tls_config.5.html | 522 +--------- man/v1.2.2/nng_tls_config_alloc.3tls.html | 524 +--------- man/v1.2.2/nng_tls_config_auth_mode.3tls.html | 514 +--------- man/v1.2.2/nng_tls_config_ca_chain.3tls.html | 512 +--------- man/v1.2.2/nng_tls_config_ca_file.3tls.html | 512 +--------- man/v1.2.2/nng_tls_config_cert_key_file.3tls.html | 510 +--------- man/v1.2.2/nng_tls_config_free.3tls.html | 506 +--------- man/v1.2.2/nng_tls_config_hold.3tls.html | 510 +--------- man/v1.2.2/nng_tls_config_own_cert.3tls.html | 510 +--------- man/v1.2.2/nng_tls_config_server_name.3tls.html | 510 +--------- man/v1.2.2/nng_tls_options.5.html | 532 +--------- man/v1.2.2/nng_tls_register.3.html | 506 +--------- man/v1.2.2/nng_url_clone.3.html | 510 +--------- man/v1.2.2/nng_url_free.3.html | 508 +--------- man/v1.2.2/nng_url_parse.3.html | 510 +--------- man/v1.2.2/nng_version.3.html | 506 +--------- man/v1.2.2/nng_ws.7.html | 530 +--------- man/v1.2.2/nng_ws_register.3.html | 506 +--------- man/v1.2.2/nng_wss_register.3.html | 506 +--------- man/v1.2.2/nng_zerotier.7.html | 518 +--------- man/v1.2.2/nng_zt_register.3.html | 506 +--------- man/v1.2.2/nngcat.1.html | 568 +---------- man/v1.2.2/pygments-default.css | 69 ++ 308 files changed, 5902 insertions(+), 154082 deletions(-) create mode 100644 man/v1.2.2/asciidoctor.css create mode 100644 man/v1.2.2/pygments-default.css diff --git a/man/v1.2.2/asciidoctor.css b/man/v1.2.2/asciidoctor.css new file mode 100644 index 00000000..9d9cc70c --- /dev/null +++ b/man/v1.2.2/asciidoctor.css @@ -0,0 +1,426 @@ +/* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */ +/* Uncomment @import statement to use as custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block} +audio,video{display:inline-block} +audio:not([controls]){display:none;height:0} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +a{background:none} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +img,object,svg{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +.center{margin-left:auto;margin-right:auto} +.stretch{width:100%} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:0} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite::before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}} +table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt{background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} +.clearfix::after,.float-group::after{clear:both} +:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word} +:not(pre)>code.nobreak{word-wrap:normal} +:not(pre)>code.nowrap{white-space:nowrap} +pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} +pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} +pre>code{display:block} +pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} +em em{font-style:normal} +strong strong{font-weight:400} +.keyseq{color:rgba(51,51,51,.8)} +kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menuref{color:#000} +.menuseq b:not(.caret),.menuref{font-weight:inherit} +.menuseq{word-spacing:-.02em} +.menuseq b.caret{font-size:1.25em;line-height:.8} +.menuseq i.caret{font-weight:bold;text-align:center;width:.45em} +b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} +b.button::before{content:"[";padding:0 3px 0 2px} +b.button::after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} +#header::after,#content::after,#footnotes::after,#footer::after{clear:both} +#content{margin-top:1.25em} +#content::before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} +#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span::before{content:"\00a0\2013\00a0"} +#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark::before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber::after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc li{line-height:1.3334;margin-top:.3334em} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} +@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}} +#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +#content{margin-bottom:.625em} +.sect1{padding-bottom:.625em} +@media screen and (min-width:768px){#content{margin-bottom:1.25em} +.sect1{padding-bottom:1.25em}} +.sect1:last-child{padding-bottom:0} +.sect1+.sect1{border-top:1px solid #e7e7e9} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} +.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em} +@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} +@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} +.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} +.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} +.listingblock>.content{position:relative} +.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5} +.listingblock:hover code[data-lang]::before{display:block} +.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} +.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.prettyprint{background:#f7f7f8} +pre.prettyprint .linenums{line-height:1.45;margin-left:2em} +pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} +pre.prettyprint li code[data-lang]::before{opacity:1} +pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} +table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} +table.linenotable td.code{padding-left:.75em} +table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em} +pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em} +pre.pygments .lineno::before{content:"";margin-right:-.125em} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} +.verseblock{margin:0 1em 1.25em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} +.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} +.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0} +.quoteblock.abstract{margin:0 1em 1.25em;display:block} +.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} +.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf} +.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0} +.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} +.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0} +table.tableblock{max-width:100%;border-collapse:separate} +p.tableblock:last-child{margin-bottom:0} +td.tableblock>.content>:last-child{margin-bottom:-1.25em} +td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0} +table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0} +table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0} +table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px} +table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0} +table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0} +table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot,table.frame-ends{border-width:1px 0} +table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} +ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} +ul.unstyled,ol.unstyled{margin-left:0} +ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em} +ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} +ul.inline>li{margin-left:1.25em} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} +td.hdlist1{font-weight:bold;padding-bottom:1.25em} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} +.colist td:not([class]):first-child img{max-width:none} +.colist td:not([class]):last-child{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left{margin:.25em .625em 1.25em 0} +.imageblock.right{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none;display:inline-block} +a.image object{pointer-events:none} +sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} +sup.footnote a,sup.footnoteref a{text-decoration:none} +sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} +#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background:#00fafa} +.black{color:#000} +.black-background{background:#000} +.blue{color:#0000bf} +.blue-background{background:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background:#fa00fa} +.gray{color:#606060} +.gray-background{background:#7d7d7d} +.green{color:#006000} +.green-background{background:#007d00} +.lime{color:#00bf00} +.lime-background{background:#00fa00} +.maroon{color:#600000} +.maroon-background{background:#7d0000} +.navy{color:#000060} +.navy-background{background:#00007d} +.olive{color:#606000} +.olive-background{background:#7d7d00} +.purple{color:#600060} +.purple-background{background:#7d007d} +.red{color:#bf0000} +.red-background{background:#fa0000} +.silver{color:#909090} +.silver-background{background:#bcbcbc} +.teal{color:#006060} +.teal-background{background:#007d7d} +.white{color:#bfbfbf} +.white-background{background:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background:#fafa00} +span.icon>.fa{cursor:default} +a span.icon>.fa{cursor:inherit} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]::after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} +h1,h2,p,td.content,span.alt{letter-spacing:-.01em} +p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} +p,blockquote,dt,td.content,span.alt{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@page{margin:1.25cm .75cm} +@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +html{font-size:80%} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]::after{content:" (" attr(title) ")"} +pre,blockquote,tr,img,object,svg{page-break-inside:avoid} +thead{display:table-header-group} +svg{max-width:100%} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span::before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]::before{display:block} +#footer{padding:0 .9375em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} +@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem} +.sect1{padding:0!important} +.sect1+.sect1{border:0} +#footer{background:none} +#footer-text{color:rgba(0,0,0,.6);font-size:.9em}} +@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} \ No newline at end of file diff --git a/man/v1.2.2/index.html b/man/v1.2.2/index.html index ee76b840..5d977bb5 100644 --- a/man/v1.2.2/index.html +++ b/man/v1.2.2/index.html @@ -1,438 +1,20 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - -NNG Reference Manual: 1.2.2 + +Section 1: Commands and Utilities - - +
-
-
-
-

The following pages are present:

-
-
-

Section 1: Commands and Utilities

@@ -463,7 +38,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

This section documents utilities and programs that are included with the distribution.

- +
@@ -489,7 +64,7 @@ Protocols.

the functions documented in this section, as this represents the primary API for building such applications.

-
+
@@ -1018,7 +593,7 @@ from use in new applications.

- +
Tip
 While this is discouraged for long term use, as a transition aid @@ -1032,7 +607,7 @@ the legacy API to the new API.
- +
@@ -1148,7 +723,7 @@ using HTTP.

static or dynamic content can also be used to host one or more Scalability Protocols sockets.

-
+
@@ -1447,7 +1022,7 @@ connections with the NNG asynchronous I/O API. These byte streams may be useful for applications that need to communicate with raw TCP/IP or IPC streams instead of Scalability Protocols.

-
+
@@ -1546,7 +1121,7 @@ applications with this library.

providing uniform functions for common application needs such as mutual exclusion locks, threading, time keeping, and similar needs.

-
+
@@ -1640,7 +1215,7 @@ additional support was present and enabled with libnng was built.

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

-
+
@@ -1696,7 +1271,7 @@ additional support was present and enabled with libnng was built.

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

-
+
@@ -1831,7 +1406,7 @@ are moved between participants, such as TCP/IP or UNIX domain IPC. A given socket may be using several transports at the same time.

-
+
@@ -1911,4 +1486,4 @@ time.

- + \ No newline at end of file diff --git a/man/v1.2.2/libnng.3.html b/man/v1.2.2/libnng.3.html index 438c4b30..76501647 100644 --- a/man/v1.2.2/libnng.3.html +++ b/man/v1.2.2/libnng.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +libnng(3) - - - + + -

NAME

+

NAME

libnng - nanomsg next generation library

@@ -547,7 +60,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

DESCRIPTION

-

The nng library provides a common messaging framework +

The nng library provides a common messaging framework intended to solve common communication problems in distributed applications.

@@ -558,34 +71,34 @@ intended to solve common communication problems in distributed applications.

The following common functions exist in libnng.

-
+
- + - + - + - + - + - + @@ -596,50 +109,50 @@ intended to solve common communication problems in distributed applications.

The following functions operate on sockets.

-

nng_alloc()

nng_alloc()

allocate memory

nng_free()

nng_free()

free memory

nng_strdup()

nng_strdup()

duplicate string

nng_strerror()

nng_strerror()

return an error description

nng_strfree()

nng_strfree()

free string

nng_version()

nng_version()

report library version
+
- + - + - + - + - + - + - + - + - + - + @@ -651,114 +164,114 @@ intended to solve common communication problems in distributed applications.

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

-

nng_close()

nng_close()

close socket

nng_dial()

nng_dial()

create and start dialer

nng_getopt()

nng_getopt()

get socket option

nng_listen()

nng_listen()

create and start listener

nng_recv()

nng_recv()

receive data

nng_send()

nng_send()

send data

nng_setopt()

nng_setopt()

set socket option

nng_socket_get()

nng_socket_get()

get socket option

nng_socket_id()

nng_socket_id()

get numeric socket identifier

nng_socket_set()

nng_socket_set()

set socket option
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -776,70 +289,70 @@ This API provides the most power support for zero-copy.

user-payload and the header carries protocol specific header information. Most applications will only interact with the body.

-

nng_dial()

nng_dial()

create and start dialer

nng_dialer_close()

nng_dialer_close()

close dialer

nng_dialer_create()

nng_dialer_create()

create dialer

nng_dialer_get()

nng_dialer_get()

get dialer option

nng_dialer_getopt()

nng_dialer_getopt()

get dialer option

nng_dialer_id()

nng_dialer_id()

get numeric dialer identifier

nng_dialer_set()

nng_dialer_set()

set dialer option

nng_dialer_setopt()

nng_dialer_setopt()

set dialer option

nng_dialer_start()

nng_dialer_start()

start dialer

nng_listen()

nng_listen()

create and start listener

nng_listener_close()

nng_listener_close()

close listener

nng_listener_create()

nng_listener_create()

create listener

nng_listener_get()

nng_listener_get()

get listener option

nng_listener_getopt()

nng_listener_getopt()

get listener option

nng_listener_id()

nng_listener_id()

get numeric listener identifier

nng_listener_set()

nng_listener_set()

set listener option

nng_listener_setopt()

nng_listener_setopt()

set listener option

nng_listener_start()

nng_listener_start()

start listener

nng_pipe_close()

nng_pipe_close()

close pipe

nng_pipe_dialer()

nng_pipe_dialer()

return dialer that created pipe

nng_pipe_get()

nng_pipe_get()

get pipe option

nng_pipe_getopt()

nng_pipe_getopt()

get pipe option

nng_pipe_id()

nng_pipe_id()

get numeric pipe identifier

nng_pipe_listener()

nng_pipe_listener()

return listener that created pipe

nng_pipe_notify()

nng_pipe_notify()

register pipe notification callback

nng_pipe_socket()

nng_pipe_socket()

return owning socket for pipe
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -860,38 +373,38 @@ mode may need to access the header of messages.

nng_msg_alloc()

nng_msg_alloc()

allocate a message

nng_msg_append()

nng_msg_append()

append to message body

nng_msg_body()

nng_msg_body()

return message body

nng_msg_chop()

nng_msg_chop()

remove data from end of message body

nng_msg_clear()

nng_msg_clear()

clear message body

nng_msg_dup()

nng_msg_dup()

duplicate a message

nng_msg_free()

nng_msg_free()

free a message

nng_msg_get_pipe()

nng_msg_get_pipe()

get pipe for message

nng_msg_insert()

nng_msg_insert()

prepend to message body

nng_msg_len()

nng_msg_len()

return the message body length

nng_msg_realloc()

nng_msg_realloc()

reallocate a message

nng_msg_set_pipe()

nng_msg_set_pipe()

set pipe for message

nng_msg_trim()

nng_msg_trim()

remove data from start of message body

nng_recvmsg()

nng_recvmsg()

receive a message

nng_sendmsg()

nng_sendmsg()

send a message
- +
- + - + - + - + - + - + - + @@ -902,7 +415,7 @@ mode may need to access the header of messages.

Asynchronous Operations

Most applications will interact with nng synchronously; that is that -functions such as nng_send() will block the calling +functions such as nng_send() will block the calling thread until the operation has completed.

@@ -928,7 +441,7 @@ of whether this was successful or not), then a user supplied function (“callback”) is executed.

-

A context structure, an nng_aio, is allocated and +

A context structure, an nng_aio, is allocated and associated with each asynchronous operation. Only a single asynchronous operation may be associated with an nng_aio at any time.

@@ -936,98 +449,98 @@ Only a single asynchronous operation may be associated with an

The following functions are used in the asynchronous model:

-

nng_msg_header()

nng_msg_header()

return message header

nng_msg_header_append()

nng_msg_header_append()

append to message header

nng_msg_header_chop()

nng_msg_header_chop()

remove data from end of message header

nng_msg_header_clear()

nng_msg_header_clear()

clear message header

nng_msg_header_insert()

nng_msg_header_insert()

prepend to message header

nng_msg_header_len()

nng_msg_header_len()

return the message header length

nng_msg_header_trim()

nng_msg_header_trim()

remove data from start of message header
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1038,50 +551,50 @@ Only a single asynchronous operation may be associated with an

The following functions are used to construct a socket with a specific protocol:

-

nng_aio_abort()

nng_aio_abort()

abort asynchronous I/O operation

nng_aio_alloc()

nng_aio_alloc()

allocate asynchronous I/O handle

nng_aio_begin()

nng_aio_begin()

begin asynchronous I/O operation

nng_aio_cancel()

nng_aio_cancel()

cancel asynchronous I/O operation

nng_aio_count()

nng_aio_count()

return number of bytes transferred

nng_aio_defer()

nng_aio_defer()

defer asynchronous I/O operation

nng_aio_finish()

nng_aio_finish()

finish asynchronous I/O operation

nng_aio_free()

nng_aio_free()

free asynchronous I/O handle

nng_aio_get_input()

nng_aio_get_input()

return input parameter

nng_aio_get_msg()

nng_aio_get_msg()

get message from an asynchronous receive

nng_aio_get_output()

nng_aio_get_output()

return output result

nng_aio_result()

nng_aio_result()

return result of asynchronous operation

nng_aio_set_input()

nng_aio_set_input()

set input parameter

nng_aio_set_iov()

nng_aio_set_iov()

set scatter/gather vector

nng_aio_set_msg()

nng_aio_set_msg()

set message for an asynchronous send

nng_aio_set_output()

nng_aio_set_output()

set output result

nng_aio_set_timeout()

nng_aio_set_timeout()

set asynchronous I/O timeout

nng_aio_stop()

nng_aio_stop()

stop asynchronous I/O operation

nng_aio_wait()

nng_aio_wait()

wait for asynchronous I/O operation

nng_recv_aio()

nng_recv_aio()

receive message asynchronously

nng_send_aio()

nng_send_aio()

send message asynchronously

nng_sleep_aio()

nng_sleep_aio()

sleep asynchronously
+
- + - + - + - + - + - + - + - + - + - + @@ -1092,38 +605,38 @@ Only a single asynchronous operation may be associated with an

The following functions are used to register a transport for use.

-

nng_bus_open()

nng_bus_open()

open a bus socket

nng_pair_open()

nng_pair_open()

open a pair socket

nng_pub_open()

nng_pub_open()

open a pub socket

nng_pull_open()

nng_pull_open()

open a pull socket

nng_push_open()

nng_push_open()

open a push socket

nng_rep_open()

nng_rep_open()

open a rep socket

nng_req_open()

nng_req_open()

open a req socket

nng_respondent_open()

nng_respondent_open()

open a respondent socket

nng_sub_open()

nng_sub_open()

open a sub socket

nng_surveyor_open()

nng_surveyor_open()

open a surveyor socket
+
- + - + - + - + - + - + - + @@ -1137,46 +650,46 @@ from a socket object, into a separate context. This can allow multiple contexts to be created on a single socket for concurrent applications.

-

nng_inproc_register()

nng_inproc_register()

register inproc transport

nng_ipc_register()

nng_ipc_register()

register IPC transport

nng_tcp_register()

nng_tcp_register()

register TCP transport

nng_tls_register()

nng_tls_register()

register TLS transport

nng_ws_register()

nng_ws_register()

register WebSocket transport

nng_wss_register()

nng_wss_register()

register WebSocket Secure transport

nng_zt_register()

nng_zt_register()

register ZeroTier transport
+
- + - + - + - + - + - + - + - + - + @@ -1188,54 +701,54 @@ concurrent applications.

The following functions provide access to statistics which can be used to observe program behaviors and as an aid in troubleshooting.

-

nng_ctx_close()

nng_ctx_close()

close context

nng_ctx_get()

nng_ctx_get()

get context option

nng_ctx_getopt()

nng_ctx_getopt()

get context option

nng_ctx_id()

nng_ctx_id()

get numeric context identifier

nng_ctx_open()

nng_ctx_open()

create context

nng_ctx_recv()

nng_ctx_recv()

receive message using context asynchronously

nng_ctx_send()

nng_ctx_send()

send message using context asynchronously

nng_ctx_set()

nng_ctx_set()

set context option

nng_ctx_setopt()

nng_ctx_setopt()

set context option
+
- + - + - + - + - + - + - + - + - + - + - + @@ -1247,22 +760,22 @@ to observe program behaviors and as an aid in troubleshooting.

Common functionality is supplied for parsing and handling universal resource locators (URLS).

-

nng_stat_child()

nng_stat_child()

get child statistic

nng_stat_name()

nng_stat_name()

get statistic description

nng_stat_name()

nng_stat_name()

get statistic name

nng_stat_next()

nng_stat_next()

get next statistic

nng_stat_string()

nng_stat_string()

get statistic string value

nng_stat_timestamp()

nng_stat_timestamp()

get statistic timestamp

nng_stat_type()

nng_stat_type()

get statistic type

nng_stat_unit()

nng_stat_unit()

get statistic unit

nng_stat_valueg()

nng_stat_valueg()

get statistic value

nng_stats_free()

nng_stats_free()

free statistics

nng_stats_get()

nng_stats_get()

get statistics
+
- + - + - + @@ -1275,74 +788,74 @@ universal resource locators (URLS).

network applications with NNG, but they are made available as a convenience to aid in creating portable applications.

-

nng_url_clone()

nng_url_clone()

clone URL structure

nng_url_free()

nng_url_free()

free URL structure

nng_url_parse()

nng_url_parse()

create URL structure from string
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1357,92 +870,92 @@ using Scalability Protocols are inappropriate.

Byte streams, represented by -nng_stream objects, correspond to underlying +nng_stream objects, correspond to underlying connections such as TCP connections or named pipes. They are created by either -nng_stream_dialer or -nng_stream_listener objects.

+nng_stream_dialer or +nng_stream_listener objects.

-

nng_clock()

nng_clock()

get time

nng_cv_alloc()

nng_cv_alloc()

allocate condition variable

nng_cv_free()

nng_cv_free()

free condition variable

nng_cv_until()

nng_cv_until()

wait for condition or timeout

nng_cv_wait()

nng_cv_wait()

wait for condition

nng_cv_wake()

nng_cv_wake()

wake all waiters

nng_cv_wake1()

nng_cv_wake1()

wake one waiter

nng_msleep()

nng_msleep()

sleep for milliseconds

nng_mtx_alloc()

nng_mtx_alloc()

allocate mutex

nng_mtx_free()

nng_mtx_free()

free mutex

nng_mtx_lock()

nng_mtx_lock()

lock mutex

nng_mtx_unlock()

nng_mtx_unlock()

unlock mutex

nng_opts_parse()

nng_opts_parse()

parse command line options

nng_random()

nng_random()

get random number

nng_thread_create()

nng_thread_create()

create thread

nng_thread_destroy()

nng_thread_destroy()

reap thread
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1462,178 +975,178 @@ HTTP (and HTTP/S if TLS support is present) servers and clients.

The following functions are used to work with HTTP requests, responses, and connections.

-

nng_stream_close()

nng_stream_close()

close byte stream

nng_stream_dialer_alloc()

nng_stream_dialer_alloc()

allocate byte stream dialer

nng_stream_dialer_close()

nng_stream_dialer_close()

close byte stream dialer

nng_stream_dialer_dial()

nng_stream_dialer_dial()

initiate outgoing byte stream

nng_stream_dialer_free()

nng_stream_dialer_free()

free byte stream dialer

nng_stream_dialer_get()

nng_stream_dialer_get()

get option from byte stream dialer

nng_stream_dialer_set()

nng_stream_dialer_set()

set option on byte stream dialer

nng_stream_free()

nng_stream_free()

free byte stream

nng_stream_get()

nng_stream_get()

get option from byte stream

nng_stream_listener_accept()

nng_stream_listener_accept()

accept incoming byte stream

nng_stream_listener_alloc()

nng_stream_listener_alloc()

allocate byte stream listener

nng_stream_listener_close()

nng_stream_listener_close()

close byte stream listener

nng_stream_listener_free()

nng_stream_listener_free()

free byte stream listener

nng_stream_listener_get()

nng_stream_listener_get()

get option from byte stream listener

nng_stream_listener_listen()

nng_stream_listener_listen()

bind byte stream listener to address

nng_stream_listener_set()

nng_stream_listener_set()

set option on byte stream listener

nng_stream_recv()

nng_stream_recv()

receive from byte stream

nng_stream_send()

nng_stream_send()

send to byte stream

nng_stream_set()

nng_stream_set()

set option on byte stream
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1644,38 +1157,38 @@ and connections.

These functions are intended for use with HTTP client applications.

-

nng_http_conn_close()

nng_http_conn_close()

close HTTP connection

nng_http_conn_read()

nng_http_conn_read()

read from HTTP connection

nng_http_conn_read_all()

nng_http_conn_read_all()

read all from HTTP connection

nng_http_conn_read_req()

nng_http_conn_read_req()

read HTTP request

nng_http_conn_read_res()

nng_http_conn_read_res()

read HTTP response

nng_http_conn_write()

nng_http_conn_write()

write to HTTP connection

nng_http_conn_write_all()

nng_http_conn_write_all()

write all to HTTP connection

nng_http_conn_write_req()

nng_http_conn_write_req()

write HTTP request

nng_http_conn_write_res()

nng_http_conn_write_res()

write HTTP response

nng_http_req_add_header()

nng_http_req_add_header()

add HTTP request header

nng_http_req_alloc()

nng_http_req_alloc()

allocate HTTP request structure

nng_http_req_copy_data()

nng_http_req_copy_data()

copy HTTP request body

nng_http_req_del_header()

nng_http_req_del_header()

delete HTTP request header

nng_http_req_free()

nng_http_req_free()

free HTTP request structure

nng_http_req_get_data()

nng_http_req_get_data()

get HTTP request body

nng_http_req_get_header()

nng_http_req_get_header()

return HTTP request header

nng_http_req_get_method()

nng_http_req_get_method()

return HTTP request method

nng_http_req_get_uri()

nng_http_req_get_uri()

return HTTP request URI

nng_http_req_get_version()

nng_http_req_get_version()

return HTTP request protocol version

nng_http_req_reset()

nng_http_req_reset()

reset HTTP request structure

nng_http_req_set_data()

nng_http_req_set_data()

set HTTP request body

nng_http_req_set_header()

nng_http_req_set_header()

set HTTP request header

nng_http_req_set_method()

nng_http_req_set_method()

set HTTP request method

nng_http_req_set_uri()

nng_http_req_set_uri()

set HTTP request URI

nng_http_req_set_version()

nng_http_req_set_version()

set HTTP request protocol version

nng_http_res_add_header()

nng_http_res_add_header()

add HTTP response header

nng_http_res_alloc()

nng_http_res_alloc()

allocate HTTP response structure

nng_http_res_alloc_error()

nng_http_res_alloc_error()

allocate HTTP error response

nng_http_res_copy_data()

nng_http_res_copy_data()

copy HTTP response body

nng_http_res_del_header()

nng_http_res_del_header()

delete HTTP response header

nng_http_res_free()

nng_http_res_free()

free HTTP response structure

nng_http_res_get_data()

nng_http_res_get_data()

get HTTP response body

nng_http_res_get_header()

nng_http_res_get_header()

return HTTP response header

nng_http_res_get_reason()

nng_http_res_get_reason()

return HTTP response reason

nng_http_res_get_status()

nng_http_res_get_status()

return HTTP response status

nng_http_res_get_version()

nng_http_res_get_version()

return HTTP response protocol version

nng_http_res_reset()

nng_http_res_reset()

reset HTTP response structure

nng_http_res_set_data()

nng_http_res_set_data()

set HTTP response body

nng_http_res_set_header()

nng_http_res_set_header()

set HTTP response header

nng_http_res_set_reason()

nng_http_res_set_reason()

set HTTP response reason

nng_http_res_set_status()

nng_http_res_set_status()

set HTTP response status

nng_http_res_set_version()

nng_http_res_set_version()

set HTTP response protocol version
+
- + - + - + - + - + - + - + @@ -1686,90 +1199,90 @@ and connections.

These functions are intended for use with HTTP server applications.

-

nng_http_client_alloc()

nng_http_client_alloc()

allocate HTTP client

nng_http_client_connect()

nng_http_client_connect()

establish HTTP client connection

nng_http_client_free()

nng_http_client_free()

free HTTP client

nng_http_client_get_tls()

nng_http_client_get_tls()

get HTTP client TLS configuration

nng_http_client_set_tls()

nng_http_client_set_tls()

set HTTP client TLS configuration

nng_http_client_transact()

nng_http_client_transact()

perform one HTTP transaction

nng_http_conn_transact()

nng_http_conn_transact()

perform one HTTP transaction on connection
+
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1796,118 +1309,118 @@ with TLS support.

nng_http_handler_alloc()

nng_http_handler_alloc()

allocate HTTP server handler

nng_http_handler_collect_body()

nng_http_handler_collect_body()

set HTTP handler to collect request body

nng_http_handler_free()

nng_http_handler_free()

free HTTP server handler

nng_http_handler_get_data()

nng_http_handler_get_data()

return extra data for HTTP handler

nng_http_handler_set_data()

nng_http_handler_set_data()

set extra data for HTTP handler

nng_http_handler_set_host()

nng_http_handler_set_host()

set host for HTTP handler

nng_http_handler_set_method()

nng_http_handler_set_method()

set HTTP handler method

nng_http_handler_set_tree()

nng_http_handler_set_tree()

set HTTP handler to match trees

nng_http_hijack()

nng_http_hijack()

hijack HTTP server connection

nng_http_server_add_handler()

nng_http_server_add_handler()

add HTTP server handler

nng_http_server_del_handler()

nng_http_server_del_handler()

delete HTTP server handler

nng_http_server_get_tls()

nng_http_server_get_tls()

get HTTP server TLS configuration

nng_http_server_hold()

nng_http_server_hold()

get and hold HTTP server instance

nng_http_server_release()

nng_http_server_release()

release HTTP server instance

nng_http_server_set_error_file()

nng_http_server_set_error_file()

set custom HTTP error file

nng_http_server_set_error_page()

nng_http_server_set_error_page()

set custom HTTP error page

nng_http_server_set_tls()

nng_http_server_set_tls()

set HTTP server TLS configuration

nng_http_server_res_error()

nng_http_server_res_error()

use HTTP server error page

nng_http_server_start()

nng_http_server_start()

start HTTP server

nng_http_server_stop()

nng_http_server_stop()

stop HTTP server
- +
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -1919,11 +1432,11 @@ with TLS support.

SEE ALSO

-

nng_compat(3compat), -nng(7)

+

nng_compat(3compat), +nng(7)

- + \ No newline at end of file diff --git a/man/v1.2.2/nn_allocmsg.3compat.html b/man/v1.2.2/nn_allocmsg.3compat.html index 264e62e0..984f2284 100644 --- a/man/v1.2.2/nn_allocmsg.3compat.html +++ b/man/v1.2.2/nn_allocmsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nn_allocmsg(3compat) - - - + + -

NAME

+

NAME

nn_allocmsg - allocate message (compatible API)

@@ -553,8 +66,8 @@ message data plus book-keeping information.

nng_tls_close()

nng_tls_close()

close TLS connection

nng_tls_config_alloc()

nng_tls_config_alloc()

allocate TLS configuration

nng_tls_config_auth_mode()

nng_tls_config_auth_mode()

set authentication mode

nng_tls_config_ca_chain()

nng_tls_config_ca_chain()

set certificate authority chain

nng_tls_config_ca_file()

nng_tls_config_ca_file()

load certificate authority from file

nng_tls_config_cert_key_file()

nng_tls_config_cert_key_file()

load own certificate and key from file

nng_tls_config_own_cert()

nng_tls_config_own_cert()

set own certificate and key

nng_tls_config_free()

nng_tls_config_free()

free TLS configuration

nng_tls_config_server_name()

nng_tls_config_server_name()

set remote server name

nng_tls_dialer_alloc()

nng_tls_dialer_alloc()

allocate TLS dialer

nng_tls_dialer_close()

nng_tls_dialer_close()

close TLS dialer

nng_tls_dialer_dial()

nng_tls_dialer_dial()

initiate outgoing TLS connection

nng_tls_dialer_free()

nng_tls_dialer_free()

free TLS dialer

nng_tls_dialer_getopt()

nng_tls_dialer_getopt()

get option from TLS dialer

nng_tls_dialer_setopt()

nng_tls_dialer_setopt()

set option on TLS dialer

nng_tls_free()

nng_tls_free()

free TLS connection

nng_tls_getopt()

nng_tls_getopt()

get option from TLS connection

nng_tls_listener_accept()

nng_tls_listener_accept()

accept incoming TLS connection

nng_tls_listener_alloc()

nng_tls_listener_alloc()

allocate TLS listener

nng_tls_listener_close()

nng_tls_listener_close()

close TLS listener

nng_tls_listener_free()

nng_tls_listener_free()

free TLS listener

nng_tls_listener_getopt()

nng_tls_listener_getopt()

get option from TLS listener

nng_tls_listener_listen()

nng_tls_listener_listen()

bind TLS listener to port

nng_tls_listener_setopt()

nng_tls_listener_setopt()

set option on TLS listener

nng_tls_recv()

nng_tls_recv()

receive from TLS connection

nng_tls_send()

nng_tls_send()

send to TLS connection

nng_tls_setopt()

nng_tls_setopt()

set option on TLS connection
This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead.
@@ -566,8 +79,8 @@ for RDMA devices, but this was never developed in the legacy API.)

The returned message must be disposed of by either -nn_freemsg() or -nn_send() when the caller is finished with it.

+nn_freemsg() or +nn_send() when the caller is finished with it.

@@ -617,15 +130,16 @@ on failure.

SEE ALSO

-

nn_errno(3compat), -nn_freemsg(3compat), -nn_reallocmsg(3compat), -nn_send(3compat), -nng_compat(3compat), -nng(7)

+

nn_errno(3compat), +nn_freemsg(3compat), +nn_reallocmsg(3compat), +nn_send(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_bind.3compat.html b/man/v1.2.2/nn_bind.3compat.html index 7e51eaa2..6dc0b973 100644 --- a/man/v1.2.2/nn_bind.3compat.html +++ b/man/v1.2.2/nn_bind.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_bind(3compat) - - - + + -

NAME

+

NAME

nn_bind - accept connections from remote peers (compatible API)

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b accept connections at the address specified by url. An “endpoint identifier” for this socket’s association with the url is returned to the caller on success. -This ID can be used with nn_shutdown() to +This ID can be used with nn_shutdown() to “unbind” the socket from the address at url.

@@ -551,8 +64,8 @@ This ID can be used with nn_shutdown() This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -581,7 +94,7 @@ Only transports supported by legacy libnanomsg may be used with this function. In particular, only the schemes tcp://, ipc://, inproc://, and ws:// are supported with this function. -(Use the modern API to use other schemes.) +(Use the modern API to use other schemes.) @@ -641,15 +154,16 @@ supported with this function.

SEE ALSO

-

nn_connect(3compat), -nn_errno(3compat), -nn_shutdown(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_connect(3compat), +nn_errno(3compat), +nn_shutdown(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_close.3compat.html b/man/v1.2.2/nn_close.3compat.html index 81132d17..baa7c609 100644 --- a/man/v1.2.2/nn_close.3compat.html +++ b/man/v1.2.2/nn_close.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_close(3compat) - - - + + -

NAME

+

NAME

nn_close - close socket (compatible API)

@@ -548,8 +61,8 @@ fail with error EBADF.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -593,13 +106,14 @@ Consider using the relevant modern API instead.

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_cmsg.3compat.html b/man/v1.2.2/nn_cmsg.3compat.html index b40424ec..a731ce6d 100644 --- a/man/v1.2.2/nn_cmsg.3compat.html +++ b/man/v1.2.2/nn_cmsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_cmsg(3compat) - - - + + -

NAME

+

NAME

nn_cmsg - message control data (compatible API)

@@ -539,8 +52,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nn_cmsghdr structure describes a block of control data that is -associated with a message either sent by nn_sendmsg() -or received by nn_recvmsg().

+associated with a message either sent by nn_sendmsg() +or received by nn_recvmsg().

@@ -550,8 +63,8 @@ or received by nn_recvmsg().
This structure and supporting macros are provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead.
@@ -608,13 +121,14 @@ to align for another header.

SEE ALSO

-

nn_recvmsg(3compat), -nn_sendmsg(3compat), -nng_compat(3compat), -nng(7)

+

nn_recvmsg(3compat), +nn_sendmsg(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_connect.3compat.html b/man/v1.2.2/nn_connect.3compat.html index ed06e026..fbde045a 100644 --- a/man/v1.2.2/nn_connect.3compat.html +++ b/man/v1.2.2/nn_connect.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_connect(3compat) - - - + + -

NAME

+

NAME

nn_connect - connect to remote peer (compatible API)

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b initiate connection to a peer at the address specified by url. An “endpoint identifier” for this socket’s association with the url is returned to the caller on success. -This ID can be used with nn_shutdown() to +This ID can be used with nn_shutdown() to “unbind” the socket from the address at url.

@@ -551,8 +64,8 @@ This ID can be used with nn_shutdown() This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -581,7 +94,7 @@ Only transports supported by legacy libnanomsg may be used with this function. In particular, only the schemes tcp://, ipc://, inproc://, and ws:// are supported with this function. -(Use the modern API to use other schemes.) +(Use the modern API to use other schemes.) @@ -633,15 +146,16 @@ supported with this function.

SEE ALSO

-

nn_bind(3compat), -nn_errno(3compat), -nn_shutdown(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_bind(3compat), +nn_errno(3compat), +nn_shutdown(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_device.3compat.html b/man/v1.2.2/nn_device.3compat.html index 1d62f17c..e355950b 100644 --- a/man/v1.2.2/nn_device.3compat.html +++ b/man/v1.2.2/nn_device.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_device(3compat) - - - + + -

NAME

+

NAME

nn_device - create forwarding device (compatible API)

@@ -548,8 +61,8 @@ the other.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -559,7 +72,7 @@ Consider using the relevant modern API instead. raw mode sockets. More detail about devices and how they can be used is available in the -new style nng_device() documentation.

+new style nng_device() documentation.

@@ -609,13 +122,14 @@ one of the sockets is closed or an error occurs.

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_errno.3compat.html b/man/v1.2.2/nn_errno.3compat.html index 5b80ad03..babc14ad 100644 --- a/man/v1.2.2/nn_errno.3compat.html +++ b/man/v1.2.2/nn_errno.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_errno(3compat) - - - + + -

NAME

+

NAME

nn_errno - return most recent error (compatible API)

@@ -547,8 +60,8 @@ most recent failed operation by the calling thread.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -765,12 +278,13 @@ If no operation has failed, then this will be zero.

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_freemsg.3compat.html b/man/v1.2.2/nn_freemsg.3compat.html index fb7ac74a..7aef045a 100644 --- a/man/v1.2.2/nn_freemsg.3compat.html +++ b/man/v1.2.2/nn_freemsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_freemsg(3compat) - - - + + -

NAME

+

NAME

nn_freemsg - free message (compatible API)

@@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nn_freemsg() deallocates a message previously allocated with -nn_allocmsg() or similar functions.

+nn_allocmsg() or similar functions.

@@ -547,8 +60,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead.
@@ -575,14 +88,15 @@ Consider using the relevant modern API instead.

SEE ALSO

-

nn_allocmsg(3compat), -nn_freemsg(3compat), -nn_errno(3compat), -nng_compat(3compat), -nng(7)

+

nn_allocmsg(3compat), +nn_freemsg(3compat), +nn_errno(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_get_statistic.3compat.html b/man/v1.2.2/nn_get_statistic.3compat.html index f70500e9..f17578b4 100644 --- a/man/v1.2.2/nn_get_statistic.3compat.html +++ b/man/v1.2.2/nn_get_statistic.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_get_statistic(3compat) - - - + + -

NAME

+

NAME

nn_get_statistic - get statistic (stub)

@@ -547,8 +60,8 @@ zero.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -575,11 +88,12 @@ Consider using the relevant modern API instead.

SEE ALSO

-

nng_compat(3compat), -nng(7)

+

nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_getsockopt.3compat.html b/man/v1.2.2/nn_getsockopt.3compat.html index f919ee10..3fecccec 100644 --- a/man/v1.2.2/nn_getsockopt.3compat.html +++ b/man/v1.2.2/nn_getsockopt.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_getsockopt(3compat) - - - + + -

NAME

+

NAME

nn_getsockopt - get socket option (compatible API)

@@ -547,8 +60,8 @@ The option retrieved is determined by the level and option.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -752,7 +265,7 @@ their different application-specific purposes.

Maximum “hops” through proxies and devices a message may go through. This value, if positive, provides some protection against forwarding loops in -device chains.

+device chains.

@@ -961,15 +474,16 @@ in this implementation.

SEE ALSO

-

nng_socket(5), -nn_close(3compat), -nn_errno(3compat), -nn_getsockopt(3compat), -nng_compat(3compat), -nng(7)

+

nng_socket(5), +nn_close(3compat), +nn_errno(3compat), +nn_getsockopt(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_poll.3compat.html b/man/v1.2.2/nn_poll.3compat.html index cc9d141c..122f27c5 100644 --- a/man/v1.2.2/nn_poll.3compat.html +++ b/man/v1.2.2/nn_poll.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_poll(3compat) - - - + + -

NAME

+

NAME

nn_poll - poll sockets (compatible API)

@@ -555,8 +68,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -612,10 +125,10 @@ requested events occurs.

This function is only suitable for use with sockets obtained with the -nn_socket() function, and is not compatible +nn_socket() function, and is not compatible with file descriptors obtained via any other means. This includes file descriptors obtained using the NN_SNDFD or NN_RCVFD -options with nn_getsockopt() +options with nn_getsockopt() @@ -702,15 +215,16 @@ platforms and Windows.

SEE ALSO

-

nn_errno(3compat), -nn_recv(3compat), -nn_send(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_errno(3compat), +nn_recv(3compat), +nn_send(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_reallocmsg.3compat.html b/man/v1.2.2/nn_reallocmsg.3compat.html index 331b3412..65a5f675 100644 --- a/man/v1.2.2/nn_reallocmsg.3compat.html +++ b/man/v1.2.2/nn_reallocmsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_reallocmsg(3compat) - - - + + -

NAME

+

NAME

nn_reallocmsg - reallocate message (compatible API)

@@ -546,8 +59,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -609,14 +122,15 @@ on failure.

SEE ALSO

-

nn_allocmsg(3compat), -nn_freemsg(3compat), -nn_errno(3compat), -nng_compat(3compat), -nng(7)

+

nn_allocmsg(3compat), +nn_freemsg(3compat), +nn_errno(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_recv.3compat.html b/man/v1.2.2/nn_recv.3compat.html index 6dca0878..c281457b 100644 --- a/man/v1.2.2/nn_recv.3compat.html +++ b/man/v1.2.2/nn_recv.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_recv(3compat) - - - + + -

NAME

+

NAME

nn_send - receive data (compatible API)

@@ -549,8 +62,8 @@ special value NN_MSG, indicating a zero-copy operation.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -561,14 +74,14 @@ is performed. In this case, instead of copying the message data into the address specified by data, a new message large enough to hold the message data will be allocated (as if by the -function nn_allocmsg()), and the message +function nn_allocmsg()), and the message payload will be stored accordingly. In this case, the value stored at data will not be message data, but a pointer to the message itself. In this case, on success, the caller shall take responsibility for the final disposition of the message (such as by sending it to -another peer using nn_send()) or -nn_freemsg().

+another peer using nn_send()) or +nn_freemsg().

The flags field may contain the special flag NN_DONTWAIT. @@ -638,15 +151,16 @@ the operation shall not block, but instead will fail with the error EAGAIN

SEE ALSO

-

nn_errno(3compat), -nn_recvmsg(3compat), -nn_send(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_errno(3compat), +nn_recvmsg(3compat), +nn_send(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_recvmsg.3compat.html b/man/v1.2.2/nn_recvmsg.3compat.html index 346d8dbd..414bae4d 100644 --- a/man/v1.2.2/nn_recvmsg.3compat.html +++ b/man/v1.2.2/nn_recvmsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_recvmsg(3compat) - - - + + -

NAME

+

NAME

nn_recvmsg - receive message (compatible API)

@@ -547,8 +60,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -588,7 +101,7 @@ has the base address (iov_base) and length (iov_len) i in which case the function shall allocate a message buffer, and store the pointer to it at the address indicated by iov_base. This can help save an extra copy operation. -The buffer should be deallocated by nn_freemsg() +The buffer should be deallocated by nn_freemsg() or similar when it is no longer needed.

@@ -598,7 +111,7 @@ This is currently only useful to obtain the message headers used with raw mode sockets. In all other circumstances these fields should be zero. Details about this structure are covered in -nn_cmsg(3compat).

+nn_cmsg(3compat).

@@ -671,16 +184,17 @@ Details about this structure are covered in

SEE ALSO

-

nn_cmsg(3compat), -nn_errno(3compat), -nn_recv(3compat), -nn_send(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_cmsg(3compat), +nn_errno(3compat), +nn_recv(3compat), +nn_send(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_send.3compat.html b/man/v1.2.2/nn_send.3compat.html index b55ef855..0cb67c06 100644 --- a/man/v1.2.2/nn_send.3compat.html +++ b/man/v1.2.2/nn_send.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_send(3compat) - - - + + -

NAME

+

NAME

nn_send - send data (compatible API)

@@ -547,8 +60,8 @@ and sends using the socket sock.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -559,8 +72,8 @@ is performed. In this case, data points not to the message content itself, but instead 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_allocmsg() or +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 @@ -647,15 +160,16 @@ completed before this function returns control to the caller.

SEE ALSO

-

nn_errno(3compat), -nn_recv(3compat), -nn_sendmsg(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_errno(3compat), +nn_recv(3compat), +nn_sendmsg(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_sendmsg.3compat.html b/man/v1.2.2/nn_sendmsg.3compat.html index 94e551ad..3050c6a1 100644 --- a/man/v1.2.2/nn_sendmsg.3compat.html +++ b/man/v1.2.2/nn_sendmsg.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_sendmsg(3compat) - - - + + -

NAME

+

NAME

nn_sendmsg - send message (compatible API)

@@ -547,8 +60,8 @@ socket sock.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -585,7 +98,7 @@ has the base address (iov_base) and length (iov_len) i

For buffers allocated for zero copy -(such as by nn_allocmsg()), the value +(such as by nn_allocmsg()), the value of iov_base should be the address of the pointer to the buffer, rather than the address of the buffer itself. In this case, the value of iov_len should be NN_MSG, @@ -603,7 +116,7 @@ This is currently only useful to provide the message headers used with raw mode sockets. In all other circumstances these fields should be zero. Details about this structure are covered in -nn_cmsg(3compat).

+nn_cmsg(3compat).

@@ -689,16 +202,17 @@ completed before this function returns control to the caller.

SEE ALSO

-

nn_cmsg(3compat), -nn_errno(3compat), -nn_recv(3compat), -nn_send(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_cmsg(3compat), +nn_errno(3compat), +nn_recv(3compat), +nn_send(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_setsockopt.3compat.html b/man/v1.2.2/nn_setsockopt.3compat.html index 924b5223..350e6897 100644 --- a/man/v1.2.2/nn_setsockopt.3compat.html +++ b/man/v1.2.2/nn_setsockopt.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nn_setsockopt(3compat) - - - + + -

NAME

+

NAME

nn_setsockopt - set socket option (compatible API)

@@ -550,8 +63,8 @@ the actual value and the size of the value, respectively.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead.
@@ -736,7 +249,7 @@ their different application-specific purposes.

Maximum “hops” through proxies and devices a message may go through. This value, if positive, provides some protection against forwarding loops in -device chains.

+device chains.

@@ -918,15 +431,16 @@ in this implementation.

SEE ALSO

-

nng_socket(5), -nn_close(3compat), -nn_errno(3compat), -nn_getsockopt(3compat), -nng_compat(3compat), -nng(7)

+

nng_socket(5), +nn_close(3compat), +nn_errno(3compat), +nn_getsockopt(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_shutdown.3compat.html b/man/v1.2.2/nn_shutdown.3compat.html index 7a35f858..ce97d2ea 100644 --- a/man/v1.2.2/nn_shutdown.3compat.html +++ b/man/v1.2.2/nn_shutdown.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_shutdown(3compat) - - - + + -

NAME

+

NAME

nn_shutdown - shut down endpoint (compatible API)

@@ -550,8 +63,8 @@ closed.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -595,15 +108,16 @@ Consider using the relevant modern API instead.

SEE ALSO

-

nn_bind(3compat), -nn_connect(3compat), -nn_errno(3compat), -nn_socket(3compat), -nn_compat(3compat), -nng(7)

+

nn_bind(3compat), +nn_connect(3compat), +nn_errno(3compat), +nn_socket(3compat), +nn_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_socket.3compat.html b/man/v1.2.2/nn_socket.3compat.html index 2711a064..aef8cdfd 100644 --- a/man/v1.2.2/nn_socket.3compat.html +++ b/man/v1.2.2/nn_socket.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_socket(3compat) - - - + + -

NAME

+

NAME

nn_socket - create socket (compatible API)

@@ -547,8 +60,8 @@ protocol proto and returns it.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -612,7 +125,7 @@ The following protocols are defined:

NN_PAIR -

Pair protocol.

+

Pair protocol.

@@ -620,7 +133,7 @@ The following protocols are defined:

NN_PUB -

Publisher protocol.

+

Publisher protocol.

@@ -628,7 +141,7 @@ The following protocols are defined:

NN_SUB -

Subscriber protocol.

+

Subscriber protocol.

@@ -636,7 +149,7 @@ The following protocols are defined:

NN_REQ -

Requestor protocol.

+

Requestor protocol.

@@ -644,7 +157,7 @@ The following protocols are defined:

NN_REP -

Replier protocol.

+

Replier protocol.

@@ -652,7 +165,7 @@ The following protocols are defined:

NN_PUSH -

Push protocol.

+

Push protocol.

@@ -660,7 +173,7 @@ The following protocols are defined:

NN_PULL -

Pull protocol.

+

Pull protocol.

@@ -668,7 +181,7 @@ The following protocols are defined:

NN_SURVEYOR -

Surveyor protocol.

+

Surveyor protocol.

@@ -676,7 +189,7 @@ The following protocols are defined:

NN_RESPONDENT -

Respondent protocol.

+

Respondent protocol.

@@ -684,7 +197,7 @@ The following protocols are defined:

NN_BUS -

Bus protocol.

+

Bus protocol.

@@ -736,14 +249,15 @@ The following protocols are defined:

SEE ALSO

-

nng_socket(5), -nn_close(3compat), -nn_errno(3compat), -nng_compat(3compat), -nng(7)

+

nng_socket(5), +nn_close(3compat), +nn_errno(3compat), +nng_compat(3compat), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_strerror.3compat.html b/man/v1.2.2/nn_strerror.3compat.html index c2a8d716..e6387989 100644 --- a/man/v1.2.2/nn_strerror.3compat.html +++ b/man/v1.2.2/nn_strerror.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_errno(3compat) - - - + + -

NAME

+

NAME

nn_strerror - return message for error (compatible API)

@@ -547,8 +60,8 @@ to the given error number err.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -575,12 +88,13 @@ Consider using the relevant modern API instead.

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nn_term.3compat.html b/man/v1.2.2/nn_term.3compat.html index a2312df9..369298cd 100644 --- a/man/v1.2.2/nn_term.3compat.html +++ b/man/v1.2.2/nn_term.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nn_term(3compat) - - - + + -

NAME

+

NAME

nn_term - terminate library (compatible API)

@@ -549,8 +62,8 @@ fail with error EBADF or ETERM.

This function is provided for API -compatibility with legacy libnanomsg. -Consider using the relevant modern API instead. +compatibility with legacy libnanomsg. +Consider using the relevant modern API instead. @@ -596,13 +109,14 @@ own sockets directly.

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng.7.html b/man/v1.2.2/nng.7.html index 7ed03ea5..04166c54 100644 --- a/man/v1.2.2/nng.7.html +++ b/man/v1.2.2/nng.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng(7) - - - + + -

NAME

+

NAME

nng - nanomsg next generation

@@ -584,7 +97,7 @@ other languages please check the website.

-nng_bus(7) +nng_bus(7)

Bus protocol

@@ -592,7 +105,7 @@ other languages please check the website.

-nng_pair(7) +nng_pair(7)

Pair protocol

@@ -600,7 +113,7 @@ other languages please check the website.

-nng_pub(7) +nng_pub(7)

Publisher side of publish/subscribe protocol

@@ -608,7 +121,7 @@ other languages please check the website.

-nng_pull(7) +nng_pull(7)

Pull side of pipeline protocol

@@ -616,7 +129,7 @@ other languages please check the website.

-nng_push(7) +nng_push(7)

Push side of pipeline protocol

@@ -624,7 +137,7 @@ other languages please check the website.

-nng_sub(7) +nng_sub(7)

Subscriber side of publish/subscribe protocol

@@ -632,7 +145,7 @@ other languages please check the website.

-nng_rep(7) +nng_rep(7)

Reply side of request/reply protocol

@@ -640,7 +153,7 @@ other languages please check the website.

-nng_req(7) +nng_req(7)

Request side of request/reply protocol

@@ -648,7 +161,7 @@ other languages please check the website.

-nng_respondent(7) +nng_respondent(7)

Respondent side of survey protocol

@@ -656,7 +169,7 @@ other languages please check the website.

-nng_surveyor(7) +nng_surveyor(7)

Surveyor side of survey protocol

@@ -673,7 +186,7 @@ other languages please check the website.

@@ -890,7 +403,7 @@ confusion when they are parsed on different systems.

API

-

The library API is documented at libnng(3).

+

The library API is documented at libnng(3).

@@ -898,11 +411,11 @@ confusion when they are parsed on different systems.

SEE ALSO

-

libnng(3), -nng_compat(3compat)

+

libnng(3), +nng_compat(3compat)

- + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio.5.html b/man/v1.2.2/nng_aio.5.html index 46c58d3d..9e409e3a 100644 --- a/man/v1.2.2/nng_aio.5.html +++ b/man/v1.2.2/nng_aio.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_aio(5) - - - + + -

NAME

+

NAME

nng_aio - asynchronous I/O handle

@@ -549,17 +62,17 @@ This callback will be executed exactly once.

The asynchronous I/O framework in nng also supports cancellation of operations that are already in progress -(see nng_aio_cancel()), as well setting a maximum +(see nng_aio_cancel()), as well setting a maximum timeout for them to complete within -(see nng_aio_set_timeout()).

+(see nng_aio_set_timeout()).

It is also possible to initiate an asynchronous operation, and wait for it to -complete using nng_aio_wait().

+complete using nng_aio_wait().

-

These structures are created using the nng_aio_alloc(), -and destroyed using nng_aio_free().

+

These structures are created using the nng_aio_alloc(), +and destroyed using nng_aio_free().

@@ -567,27 +80,28 @@ and destroyed using nng_aio_free()SEE ALSO
-

nng_aio_abort(3), -nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_count(3), -nng_aio_free(3), -nng_aio_get_input(3), -nng_aio_get_msg(3), -nng_aio_get_output(3), -nng_aio_result(3), -nng_aio_set_input(3), -nng_aio_set_iov(3), -nng_aio_set_msg(3), -nng_aio_set_timeout(3), -nng_aio_stop(3), -nng_aio_wait(3), -nng_strerror(3), -nng_aio(5), -nng(7)

-
-
- - +

nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_count(3), +nng_aio_free(3), +nng_aio_get_input(3), +nng_aio_get_msg(3), +nng_aio_get_output(3), +nng_aio_result(3), +nng_aio_set_input(3), +nng_aio_set_iov(3), +nng_aio_set_msg(3), +nng_aio_set_timeout(3), +nng_aio_stop(3), +nng_aio_wait(3), +nng_strerror(3), +nng_aio(5), +nng(7)

+ + + + + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_abort.3.html b/man/v1.2.2/nng_aio_abort.3.html index 07e2372a..e2526f01 100644 --- a/man/v1.2.2/nng_aio_abort.3.html +++ b/man/v1.2.2/nng_aio_abort.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_aio_abort(3) - - - + + -

NAME

+

NAME

nng_aio_abort - abort asynchronous I/O operation

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b with the handle aio. If the operation is aborted, then the callback for the handle will be called, and the function -nng_aio_result() will return the error err.

+nng_aio_result() will return the error err.

This function does not wait for the operation to be fully aborted, but @@ -573,14 +86,15 @@ has no effect.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_alloc.3.html b/man/v1.2.2/nng_aio_alloc.3.html index 6ccc411c..cae75a8b 100644 --- a/man/v1.2.2/nng_aio_alloc.3.html +++ b/man/v1.2.2/nng_aio_alloc.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_aio_alloc(3) - - - + + -

NAME

+

NAME

nng_aio_alloc - allocate asynchronous I/O handle

@@ -557,23 +70,23 @@ lead ultimately to an apparent "hang" or deadlock in the application.
-nng_inproc(7) +nng_inproc(7)

Intra-process transport

@@ -681,7 +194,7 @@ other languages please check the website.

-nng_ipc(7) +nng_ipc(7)

Inter-process transport

@@ -689,7 +202,7 @@ other languages please check the website.

-nng_tls(7) +nng_tls(7)

TLSv1.2 over TCP transport

@@ -697,7 +210,7 @@ other languages please check the website.

-nng_tcp(7) +nng_tcp(7)

TCP (and TCPv6) transport

@@ -705,7 +218,7 @@ other languages please check the website.

-nng_ws(7) +nng_ws(7)

WebSocket transport

@@ -713,7 +226,7 @@ other languages please check the website.

-nng_zerotier(7) +nng_zerotier(7)

ZeroTier transport

@@ -734,7 +247,7 @@ socket implements precisely one nng protocol.

Each socket can be used to send and receive messages (if the protocol) supports it, and implements the appropriate protocol semantics. -For example, sub sockets automatically filter incoming +For example, sub sockets automatically filter incoming messages to discard those for topics that have not been subscribed.

@@ -742,7 +255,7 @@ messages to discard those for topics that have not been subscribed.

wholly, or not at all. Partial delivery is not possible. Furthermore, nng does not provide any other delivery or ordering guarantees; messages may be dropped or reordered -(Some protocols, such as req may offer stronger +(Some protocols, such as req may offer stronger guarantees by performing their own retry and validation schemes.)

@@ -781,19 +294,19 @@ other than in a few specific circumstances.

Most applications will use nng sockets in “cooked” mode. This mode provides the full semantics of the protocol. -For example, req sockets will automatically +For example, req sockets will automatically match a reply to a request, and resend requests periodically if no reply was received.

-

There are situations, such as with proxies, +

There are situations, such as with proxies, where it is desirable to bypass these semantics and simply pass messages to and from the socket with no extra semantic handling. This is possible using “raw” mode sockets.

Raw mode sockets are generally constructed with a different function, -such as nng_req0_open_raw(). +such as nng_req0_open_raw(). Using these sockets, the application can simply send and receive messages, and is responsible for supplying any additional socket semantics. Typically this means that the application will need to inspect message @@ -806,7 +319,7 @@ headers on incoming messages, and supply them on outgoing messages.

 -The nng_device() function only works with raw mode +The nng_device() function only works with raw mode sockets, but as it only forwards the messages, no additional application processing is needed.
-

Asynchronous I/O operations all take an nng_aio +

Asynchronous I/O operations all take an nng_aio handle such as allocated by this function. Such operations are usually started by a function that returns immediately. The operation is then run asynchronously, and completes sometime later. When that operation is complete, the callback supplied here is called, and that callback is able to determine the result of the operation using -nng_aio_result(), -nng_aio_count(), -and nng_aio_get_output().

+nng_aio_result(), +nng_aio_count(), +and nng_aio_get_output().

It is possible to wait synchronously for an otherwise asynchronous operation -by using the function nng_aio_wait(). +by using the function nng_aio_wait(). In that case, it is permissible for callb and arg to both be NULL. Note that if these are NULL, then it will not be possible to determine when the operation is complete except by calling the aforementioned -nng_aio_wait().

+nng_aio_wait().

@@ -606,26 +119,27 @@ operation is complete except by calling the aforementioned

SEE ALSO

-

nng_aio_abort(3), -nng_aio_cancel(3), -nng_aio_count(3), -nng_aio_free(3), -nng_aio_get_input(3), -nng_aio_get_msg(3), -nng_aio_get_output(3), -nng_aio_result(3), -nng_aio_set_input(3), -nng_aio_set_iov(3), -nng_aio_set_msg(3), -nng_aio_set_timeout(3), -nng_aio_stop(3), -nng_aio_wait(3), -nng_strerror(3), -nng_aio(5), -nng(7)

-
-
- - +

nng_aio_abort(3), +nng_aio_cancel(3), +nng_aio_count(3), +nng_aio_free(3), +nng_aio_get_input(3), +nng_aio_get_msg(3), +nng_aio_get_output(3), +nng_aio_result(3), +nng_aio_set_input(3), +nng_aio_set_iov(3), +nng_aio_set_msg(3), +nng_aio_set_timeout(3), +nng_aio_stop(3), +nng_aio_wait(3), +nng_strerror(3), +nng_aio(5), +nng(7)

+ + + + + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_begin.3.html b/man/v1.2.2/nng_aio_begin.3.html index 9e261de4..5d51f515 100644 --- a/man/v1.2.2/nng_aio_begin.3.html +++ b/man/v1.2.2/nng_aio_begin.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_begin(3) - - - + + -

NAME

+

NAME

nng_aio_begin - begin asynchronous I/O operation

@@ -550,7 +63,7 @@ be called not more than once for a given I/O operation on a given aio.<

Once this function is called, if true is returned, then the provider MUST -guarantee that nng_aio_finish() is called for the aio +guarantee that nng_aio_finish() is called for the aio exactly once, when the operation is complete or canceled.

@@ -606,16 +119,17 @@ users of the aio should not call this function.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_defer(3), -nng_aio_finish(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_defer(3), +nng_aio_finish(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_cancel.3.html b/man/v1.2.2/nng_aio_cancel.3.html index d5cec8d3..f1aa1ab6 100644 --- a/man/v1.2.2/nng_aio_cancel.3.html +++ b/man/v1.2.2/nng_aio_cancel.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_cancel(3) - - - + + -

NAME

+

NAME

nng_aio_cancel - cancel asynchronous I/O operation

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b with the handle aio. If the operation is aborted, then the callback for the handle will be called, and the function -nng_aio_result() will return the error NNG_ECANCELED.

+nng_aio_result() will return the error NNG_ECANCELED.

This function does not wait for the operation to be fully aborted, but @@ -559,7 +72,7 @@ has no effect.

 This function is the same as calling -nng_aio_abort() with the error NNG_ECANCELED. +nng_aio_abort() with the error NNG_ECANCELED.
@@ -586,14 +99,15 @@ This function is the same as calling

SEE ALSO

-

nng_aio_abort(3), -nng_aio_alloc(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_count.3.html b/man/v1.2.2/nng_aio_count.3.html index 63ffef4b..ed7d7c57 100644 --- a/man/v1.2.2/nng_aio_count.3.html +++ b/man/v1.2.2/nng_aio_count.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_count(3) - - - + + -

NAME

+

NAME

nng_aio_count - return number of bytes transferred

@@ -547,7 +60,7 @@ this function will generally return zero.

This function is most useful when used with operations that make use of -of a scatter/gather vector (set by nng_aio_set_iov()).

+of a scatter/gather vector (set by nng_aio_set_iov()).

@@ -560,7 +73,7 @@ The return value from this function is undefined if the operation has not completed yet. Either call this from the handle’s completion callback, or after waiting for the operation to complete with -nng_aio_wait(). +nng_aio_wait().
@@ -587,16 +100,17 @@ or after waiting for the operation to complete with

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_aio_wait(3), -nng_strerror(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_aio_wait(3), +nng_strerror(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_defer.3.html b/man/v1.2.2/nng_aio_defer.3.html index ef09bd74..e0475382 100644 --- a/man/v1.2.2/nng_aio_defer.3.html +++ b/man/v1.2.2/nng_aio_defer.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_defer(3) - - - + + -

NAME

+

NAME

nng_aio_defer - defer asynchronous I/O operation

@@ -555,7 +68,7 @@ In this case, the cancelfn should just return without making any change

If the cancellation routine successfully canceled the operation, it should -ensure that nng_aio_finish() is called, with the +ensure that nng_aio_finish() is called, with the error code specified by err.

@@ -566,7 +79,7 @@ error code specified by err.

It is mandatory that I/O providers call -nng_aio_finish() +nng_aio_finish() EXACTLY ONCE when they are finished with the operation. @@ -636,15 +149,16 @@ although it is harmless if it does.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_finish(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_finish(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_finish.3.html b/man/v1.2.2/nng_aio_finish.3.html index 7a07d4bd..a7ad8c18 100644 --- a/man/v1.2.2/nng_aio_finish.3.html +++ b/man/v1.2.2/nng_aio_finish.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_finish(3) - - - + + -

NAME

+

NAME

nng_aio_finish - finish asynchronous I/O operation

@@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_aio_finish() function marks operation associated with aio as complete, with the status err. This will be the result returned by -nng_aio_result().

+nng_aio_result().

This function causes the callback associated with the aio to called.

@@ -595,16 +108,17 @@ users of the aio should not have any need for this function.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_begin(3), -nng_aio_cancel(3), -nng_aio_defer(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_begin(3), +nng_aio_cancel(3), +nng_aio_defer(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_free.3.html b/man/v1.2.2/nng_aio_free.3.html index 496ecc35..580655e4 100644 --- a/man/v1.2.2/nng_aio_free.3.html +++ b/man/v1.2.2/nng_aio_free.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_free(3) - - - + + -

NAME

+

NAME

nng_aio_free - free asynchronous I/O handle

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b If any operation is in progress, the operation is canceled, and the 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().)

+(This is done by implicitly calling nng_aio_stop().)

@@ -564,13 +77,14 @@ that it is safe to deallocate the handle and any associated resources.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_stop(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_stop(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_get_input.3.html b/man/v1.2.2/nng_aio_get_input.3.html index f33c5540..c9efaf4c 100644 --- a/man/v1.2.2/nng_aio_get_input.3.html +++ b/man/v1.2.2/nng_aio_get_input.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_get_input(3) - - - + + -

NAME

+

NAME

nng_aio_get_input - return input parameter

@@ -538,7 +51,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_aio_get_input() function returns the value of the input parameter previously set at index on aio with the -nng_aio_set_input() function.

+nng_aio_set_input() function.

The valid values of index range from zero (0) to three (3), as no operation @@ -569,15 +82,16 @@ or of the input parameter was not previously set, then NULL is retu

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_get_output(3), -nng_aio_set_input(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_get_output(3), +nng_aio_set_input(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_get_msg.3.html b/man/v1.2.2/nng_aio_get_msg.3.html index 6d66e1b9..676745e4 100644 --- a/man/v1.2.2/nng_aio_get_msg.3.html +++ b/man/v1.2.2/nng_aio_get_msg.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_get_msg(3) - - - + + -

NAME

+

NAME

nng_aio_get_msg - get message from asynchronous receive

@@ -538,8 +51,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_aio_get_msg() function gets any message stored in aio as either a result of a successful receive -(see nng_recv_aio()) -or that was previously stored with nng_aio_set_msg().

+(see nng_recv_aio()) +or that was previously stored with nng_aio_set_msg().

@@ -548,7 +61,7 @@ or that was previously stored with nng_a
-The nng_aio must not have an operation in progress. +The nng_aio must not have an operation in progress.
@@ -575,14 +88,15 @@ The nng_aio must not have an operatio

SEE ALSO

-

nng_aio_set_msg(3), -nng_recv_aio(3), -nng_aio(5), -nng_msg(5), -nng(7)

+

nng_aio_set_msg(3), +nng_recv_aio(3), +nng_aio(5), +nng_msg(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_get_output.3.html b/man/v1.2.2/nng_aio_get_output.3.html index 89751e79..11b7eb84 100644 --- a/man/v1.2.2/nng_aio_get_output.3.html +++ b/man/v1.2.2/nng_aio_get_output.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_get_output(3) - - - + + -

NAME

+

NAME

nng_aio_get_output - return output result

@@ -592,15 +105,16 @@ performed using the aio yet.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_get_output(3), -nng_aio_set_input(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_get_output(3), +nng_aio_set_input(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_result.3.html b/man/v1.2.2/nng_aio_result.3.html index a3de479b..311ac724 100644 --- a/man/v1.2.2/nng_aio_result.3.html +++ b/man/v1.2.2/nng_aio_result.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_result(3) - - - + + -

NAME

+

NAME

nng_aio_result - return result of asynchronous operation

@@ -552,7 +65,7 @@ The return value from this function is undefined if the operation has not completed yet. Either call this from the handle’s completion callback, or after waiting for the operation to complete with -nng_aio_wait(). +nng_aio_wait(). @@ -600,15 +113,16 @@ number on failure.

SEE ALSO

-

nng_aio_abort(3), -nng_aio_alloc(3), -nng_aio_wait(3), -nng_strerror(3), -nng_aio(5), -nng(7)

+

nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio_wait(3), +nng_strerror(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_set_input.3.html b/man/v1.2.2/nng_aio_set_input.3.html index 199e05ad..749d3a60 100644 --- a/man/v1.2.2/nng_aio_set_input.3.html +++ b/man/v1.2.2/nng_aio_set_input.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_set_input(3) - - - + + -

NAME

+

NAME

nng_aio_set_input - set input parameter

@@ -577,7 +90,7 @@ in use by an active asynchronous operation.

An input parameter set with this function may be retrieved later with -the nng_aio_get_input() function.

+the nng_aio_get_input() function.

@@ -601,15 +114,16 @@ the nng_aio_get_input() fun

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_get_input(3), -nng_aio_get_output(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_get_input(3), +nng_aio_get_output(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_set_iov.3.html b/man/v1.2.2/nng_aio_set_iov.3.html index e4c38a77..3d812740 100644 --- a/man/v1.2.2/nng_aio_set_iov.3.html +++ b/man/v1.2.2/nng_aio_set_iov.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_set_iov(3) - - - + + -

NAME

+

NAME

nng_aio_set_iov - set scatter/gather vector

@@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b handle aio.

-

The iov is a pointer to an array of niov nng_iov +

The iov is a pointer to an array of niov nng_iov structures, which have the following definition:

@@ -609,16 +122,17 @@ generally result in NNG_EINVAL.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio(5), -nng_iov(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio(5), +nng_iov(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_set_msg.3.html b/man/v1.2.2/nng_aio_set_msg.3.html index aa5c8bc2..b768ea34 100644 --- a/man/v1.2.2/nng_aio_set_msg.3.html +++ b/man/v1.2.2/nng_aio_set_msg.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_set_msg(3) - - - + + -

NAME

+

NAME

nng_aio_set_msg - set message for asynchronous send

@@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_aio_set_msg() function sets the message that will be used -for an asynchronous send operation (see nng_send_aio()).

+for an asynchronous send operation (see nng_send_aio()).

@@ -546,7 +59,7 @@ for an asynchronous send operation (see nng
-The nng_aio must not have an operation in progress. +The nng_aio must not have an operation in progress.
@@ -573,14 +86,15 @@ The nng_aio must not have an operatio

SEE ALSO

-

nng_aio_get_msg(3), -nng_send_aio(3), -nng_aio(5), -nng_msg(5), -nng(7)

+

nng_aio_get_msg(3), +nng_send_aio(3), +nng_aio(5), +nng_msg(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_set_output.3.html b/man/v1.2.2/nng_aio_set_output.3.html index 22cdc3ba..9bca6167 100644 --- a/man/v1.2.2/nng_aio_set_output.3.html +++ b/man/v1.2.2/nng_aio_set_output.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_set_output(3) - - - + + -

NAME

+

NAME

nng_aio_set_output - set output result

@@ -564,7 +77,7 @@ three (3) will be ignored.

An output result set with this function may be retrieved later with -the nng_aio_get_output() function.

+the nng_aio_get_output() function.

@@ -588,15 +101,16 @@ the nng_aio_get_output() f

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_finish(3), -nng_aio_get_output(3), -nng_aio_result(3), -nng_aio(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_finish(3), +nng_aio_get_output(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_set_timeout.3.html b/man/v1.2.2/nng_aio_set_timeout.3.html index 34d8a76c..a2b613b4 100644 --- a/man/v1.2.2/nng_aio_set_timeout.3.html +++ b/man/v1.2.2/nng_aio_set_timeout.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_set_timeout(3) - - - + + -

NAME

+

NAME

nng_aio_set_timeout - set asynchronous I/O timeout

@@ -591,15 +104,16 @@ timeout.

SEE ALSO

-

nng_aio_alloc(3), -nng_aio_cancel(3), -nng_aio_result(3), -nng_aio(5), -nng_duration(5), -nng(7)

+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_result(3), +nng_aio(5), +nng_duration(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_stop.3.html b/man/v1.2.2/nng_aio_stop.3.html index 39283ced..9ac69c49 100644 --- a/man/v1.2.2/nng_aio_stop.3.html +++ b/man/v1.2.2/nng_aio_stop.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_stop(3) - - - + + -

NAME

+

NAME

nng_aio_stop - stop asynchronous I/O operation

@@ -573,7 +86,7 @@ completing its callback function. When multiple asynchronous I/O handles are in use and need to be shut down, it is safest to stop all of them, before deallocating any of -this with nng_aio_free(), particularly if the callbacks +this with nng_aio_free(), particularly if the callbacks might attempt to reschedule additional operations. @@ -601,15 +114,16 @@ might attempt to reschedule additional operations.

SEE ALSO

-

nng_aio_cancel(3), -nng_aio_free(3), -nng_aio_wait(3), -nng_aio_alloc(3), -nng_aio(5), -nng(7)

+

nng_aio_cancel(3), +nng_aio_free(3), +nng_aio_wait(3), +nng_aio_alloc(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_aio_wait.3.html b/man/v1.2.2/nng_aio_wait.3.html index 66b0a681..80718ace 100644 --- a/man/v1.2.2/nng_aio_wait.3.html +++ b/man/v1.2.2/nng_aio_wait.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_aio_wait(3) - - - + + -

NAME

+

NAME

nng_aio_wait - wait for asynchronous I/O operation

@@ -567,13 +80,14 @@ function will not be called until the callback has completed.

SEE ALSO

-

nng_aio_abort(3), -nng_aio_alloc(3), -nng_aio(5), -nng(7)

+

nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_alloc.3.html b/man/v1.2.2/nng_alloc.3.html index 553f3d30..5f4c27a4 100644 --- a/man/v1.2.2/nng_alloc.3.html +++ b/man/v1.2.2/nng_alloc.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_alloc(3) - - - + + -

NAME

+

NAME

nng_alloc - allocate memory

@@ -542,9 +55,9 @@ The memory will be 64-bit aligned.

The returned memory can be used to hold message buffers, in which -case it can be directly passed to nng_send() using +case it can be directly passed to nng_send() using the flag NNG_FLAG_ALLOC. Alternatively, it can be freed when no -longer needed using nng_free().

+longer needed using nng_free().

@@ -584,13 +97,14 @@ treated the same as NNG_ENOMEM.

SEE ALSO

-

nng_free(3), -nng_send(3), -nng_strerror(3), -nng(7)

+

nng_free(3), +nng_send(3), +nng_strerror(3), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_bus.7.html b/man/v1.2.2/nng_bus.7.html index 39fb9144..3c48b50d 100644 --- a/man/v1.2.2/nng_bus.7.html +++ b/man/v1.2.2/nng_bus.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_bus(7) - - - + + -

NAME

+

NAME

nng_bus - bus protocol

@@ -588,7 +101,7 @@ the more likely that message loss is to occur.

Socket Operations

-

The nng_bus0_open() functions create a bus socket. +

The nng_bus0_open() functions create a bus socket. This socket may be used to send and receive messages. Sending messages will attempt to deliver to each directly connected peer.

@@ -610,11 +123,11 @@ Sending messages will attempt to deliver to each directly connected peer.

Protocol Headers

When using a “raw” bus socket, received messages will -contain the incoming pipe ID as the sole element in the header. +contain the incoming pipe ID as the sole element in the header. If a message containing such a header is sent using a raw bus socket, then, the message will be delivered to all connected pipes except the one identified in the header. -This behavior is intended for use with device +This behavior is intended for use with device configurations consisting of just a single socket. Such configurations are useful in the creation of rebroadcasters, and this capability prevents a message from being routed back to its source. @@ -630,11 +143,12 @@ If no header is present, then a message is sent to all connected pipes.

SEE ALSO

-

nng_bus_open(3), -nng(7)

+

nng_bus_open(3), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_bus_open.3.html b/man/v1.2.2/nng_bus_open.3.html index f5594761..7eb7716d 100644 --- a/man/v1.2.2/nng_bus_open.3.html +++ b/man/v1.2.2/nng_bus_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_bus_open(3) - - - + + -

NAME

+

NAME

nng_bus_open - create bus socket

@@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

DESCRIPTION

-

The nng_bus0_open() function creates a bus version 0 -socket and returns it at the location pointed to by s.

+

The nng_bus0_open() function creates a bus version 0 +socket and returns it at the location pointed to by s.

-

The nng_bus0_open_raw() function creates a bus version 0 -socket in +

The nng_bus0_open_raw() function creates a bus version 0 +socket in raw mode, and returns it at the location pointed to by s.

@@ -586,12 +99,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

SEE ALSO

-

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

+

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

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_clock.3supp.html b/man/v1.2.2/nng_clock.3supp.html index 76d2c66d..d4392bca 100644 --- a/man/v1.2.2/nng_clock.3supp.html +++ b/man/v1.2.2/nng_clock.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_clock(3supp) - - - + + -

NAME

+

NAME

nng_clock - get time

@@ -567,7 +80,7 @@ but different programs may have different references.
This function is intended mostly to help with setting appropriate -timeouts using nng_cv_until(). +timeouts using nng_cv_until().
@@ -594,15 +107,16 @@ timeouts using nng_cv_until()SEE ALSO
-

nng_sleep_aio(3), -nng_strerror(3), -nng_cv_until(3supp), -nng_msleep(3supp), -nng_duration(5), -nng(7)

+

nng_sleep_aio(3), +nng_strerror(3), +nng_cv_until(3supp), +nng_msleep(3supp), +nng_duration(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_close.3.html b/man/v1.2.2/nng_close.3.html index f54a4c26..3706071f 100644 --- a/man/v1.2.2/nng_close.3.html +++ b/man/v1.2.2/nng_close.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_close(3) - - - + + -

NAME

+

NAME

nng_close - close socket

@@ -558,7 +71,7 @@ of that data. There is no automatic linger or flush to ensure that the socket send buffers have completely transmitted. It is recommended to wait a brief period after calling -nng_send() or similar functions, before calling this +nng_send() or similar functions, before calling this function. @@ -595,13 +108,14 @@ function.

SEE ALSO

-

nng_strerror(3), -nng_options(5), -nng_socket(5), -nng(7)

+

nng_strerror(3), +nng_options(5), +nng_socket(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/v1.2.2/nng_compat.3compat.html b/man/v1.2.2/nng_compat.3compat.html index eb5475d1..a00a9334 100644 --- a/man/v1.2.2/nng_compat.3compat.html +++ b/man/v1.2.2/nng_compat.3compat.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_compat(3compat) - - - + + -

NAME

+

NAME

nng_compat - compatibility with nanomsg 1.0

@@ -551,7 +64,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

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

@@ -563,14 +76,14 @@ most nanomsg 1.0 applications.

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

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

+to link with libnng instead of libnn.

@@ -580,8 +93,8 @@ to link with libnng instead of libnn @@ -596,7 +109,7 @@ This can be way to facilitate incremental transition to the new API.
While not recommended for long term use, the value returned by -nng_socket_id() can be used with these functions -just like a value returned by nn_socket(). +nng_socket_id() can be used with these functions +just like a value returned by nn_socket(). This can be way to facilitate incremental transition to the new API.
Some capabilities, protocols, and transports, will not be accessible using this API, as the compatible API has no provision for expression -of certain concepts introduced in the newer nng API. +of certain concepts introduced in the newer nng API.
@@ -662,7 +175,7 @@ instead of libnn, just like any other nng application.

-nn_socket() +nn_socket()

create socket

@@ -670,7 +183,7 @@ instead of libnn, just like any other nng application.

-nn_getsockopt() +nn_getsockopt()

get socket option

@@ -678,7 +191,7 @@ instead of libnn, just like any other nng application.

-nn_setsockopt() +nn_setsockopt()

set socket option

@@ -686,7 +199,7 @@ instead of libnn, just like any other nng application.

-nn_bind() +nn_bind()

accept connections from remote peers

@@ -694,7 +207,7 @@ instead of libnn, just like any other nng application.

-nn_connect() +nn_connect()

connect to remote peer

@@ -702,7 +215,7 @@ instead of libnn, just like any other nng application.

-nn_send() +nn_send()

send data

@@ -710,7 +223,7 @@ instead of libnn, just like any other nng application.

-nn_recv() +nn_recv()

receive data

@@ -718,7 +231,7 @@ instead of libnn, just like any other nng application.

-nn_shutdown() +nn_shutdown()

shut down endpoint

@@ -726,7 +239,7 @@ instead of libnn, just like any other nng application.

-nn_close() +nn_close()

close socket

@@ -734,7 +247,7 @@ instead of libnn, just like any other nng application.

-nn_poll() +nn_poll()

poll sockets

@@ -742,7 +255,7 @@ instead of libnn, just like any other nng application.

-nn_device() +nn_device()

create forwarding device

@@ -750,7 +263,7 @@ instead of libnn, just like any other nng application.

-nn_recvmsg() +nn_recvmsg()

receive message

@@ -758,7 +271,7 @@ instead of libnn, just like any other nng application.

-nn_sendmsg() +nn_sendmsg()

send message

@@ -766,7 +279,7 @@ instead of libnn, just like any other nng application.

-nn_cmsg() +nn_cmsg()

message control data

@@ -774,7 +287,7 @@ instead of libnn, just like any other nng application.

-nn_get_statistic() +nn_get_statistic()

get statistic (stub)

@@ -782,7 +295,7 @@ instead of libnn, just like any other nng application.

-nn_allocmsg() +nn_allocmsg()

allocate message

@@ -790,7 +303,7 @@ instead of libnn, just like any other nng application.

-nn_reallocmsg() +nn_reallocmsg()

reallocate message

@@ -798,7 +311,7 @@ instead of libnn, just like any other nng application.

-nn_freemsg() +nn_freemsg()

free message

@@ -806,7 +319,7 @@ instead of libnn, just like any other nng application.

-nn_errno() +nn_errno()

return most recent error

@@ -814,7 +327,7 @@ instead of libnn, just like any other nng application.

-nn_strerror() +nn_strerror()

return message for error

@@ -822,7 +335,7 @@ instead of libnn, just like any other nng application.

-nn_term() +nn_term()

terminate library

@@ -855,7 +368,7 @@ 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. @@ -913,11 +426,12 @@ Few applications should need to adjust the default values.

    SEE ALSO

    -

    libnng(3), -nng(7)

    +

    libnng(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx.5.html b/man/v1.2.2/nng_ctx.5.html index 4df5ed4b..6df3541f 100644 --- a/man/v1.2.2/nng_ctx.5.html +++ b/man/v1.2.2/nng_ctx.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx(5) - - - + +
  • SEE ALSO
    • -

    NAME

    +

    NAME

    nng_ctx - protocol context

    @@ -543,13 +56,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b which keeps the protocol state for some stateful protocols. The purpose of a separate context object is to permit applications to share a single socket, with its various underlying -dialers, -listeners, -and pipes, +dialers, +listeners, +and pipes, while still benefiting from separate state tracking.

    -

    For example, a req context will contain the request ID +

    For example, a req context will contain the request ID of any sent request, a timer to retry the request on failure, and so forth. A separate context on the same socket can have similar data, but corresponding to a completely different request.

    @@ -664,7 +177,7 @@ before it is opened, to prevent confusion with valid open contexts.

    The following program fragment demonstrates the use of contexts to implement -a concurrent rep service that simply echos messages back +a concurrent rep service that simply echos messages back to the sender.

    @@ -707,10 +220,10 @@ to the sender.

    Given the above fragment, the following example shows setting up the -service. It assumes that the socket has already been +service. It assumes that the socket has already been created and any transports set up as well with functions such as -nng_dial() -or nng_listen().

    +nng_dial() +or nng_listen().

    @@ -737,22 +250,23 @@ or nng_listen().

    SEE ALSO

    -

    libnng(3), -nng_ctx_close(3), -nng_ctx_open(3), -nng_ctx_getopt(3), -nng_ctx_id(3), -nng_ctx_recv(3), -nng_ctx_send(3), -nng_ctx_setopt(3), -nng_dialer(5), -nng_listener(5), -nng_socket(5), -nng_options(5), -nng(7)

    +

    libnng(3), +nng_ctx_close(3), +nng_ctx_open(3), +nng_ctx_getopt(3), +nng_ctx_id(3), +nng_ctx_recv(3), +nng_ctx_send(3), +nng_ctx_setopt(3), +nng_dialer(5), +nng_listener(5), +nng_socket(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_close.3.html b/man/v1.2.2/nng_ctx_close.3.html index 3faacb43..8dfb3809 100644 --- a/man/v1.2.2/nng_ctx_close.3.html +++ b/man/v1.2.2/nng_ctx_close.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_close(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_close - close context

    @@ -554,7 +67,7 @@ call is executed may also return with an NNG_ECLOSED result.

    		 Closing the socket associated with ctx -(using nng_close()) also closes this context. +(using nng_close()) also closes this context.
    @@ -590,13 +103,14 @@ Closing the socket associated with ctx

    SEE ALSO

    -

    nng_ctx_open(3), -nng_strerror(3), -nng_ctx(5), -nng(7)

    +

    nng_ctx_open(3), +nng_strerror(3), +nng_ctx(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_get.3.html b/man/v1.2.2/nng_ctx_get.3.html index ac4f629a..c6abfdd2 100644 --- a/man/v1.2.2/nng_ctx_get.3.html +++ b/man/v1.2.2/nng_ctx_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_get(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_get - get context option

    @@ -554,9 +67,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_ctx_get() functions are used to retrieve option values for -the context ctx. +the context ctx. The actual options that may be retrieved in this way vary. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    @@ -630,7 +143,7 @@ The value will be stored at ivalp.

    nng_ctx_get_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -643,9 +156,9 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_ctx_get_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_ctx_get_uint64()
    @@ -728,17 +241,18 @@ numbers, and similar.

    SEE ALSO

    -

    nng_ctx_set(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_ctx(5), -nng_options(5), -nng(7)

    +

    nng_ctx_set(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_ctx(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_getopt.3.html b/man/v1.2.2/nng_ctx_getopt.3.html index 92ade023..632bf7c0 100644 --- a/man/v1.2.2/nng_ctx_getopt.3.html +++ b/man/v1.2.2/nng_ctx_getopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_getopt(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_getopt - get context option

    @@ -558,7 +71,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -These functions are deprecated. Please see nng_ctx_get. +These functions are deprecated. Please see nng_ctx_get.
    @@ -566,9 +79,9 @@ These functions are deprecated. Please see nng_ct

    The nng_ctx_getopt() functions are used to retrieve option values for -the context ctx. +the context ctx. The actual options that may be retrieved in this way vary. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    @@ -642,7 +155,7 @@ The value will be stored at ivalp.

    nng_ctx_getopt_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -655,9 +168,9 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_ctx_getopt_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_ctx_getopt_uint64()
    @@ -740,17 +253,18 @@ numbers, and similar.

    SEE ALSO

    -

    nng_ctx_setopt(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_ctx(5), -nng_options(5), -nng(7)

    +

    nng_ctx_setopt(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_ctx(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_id.3.html b/man/v1.2.2/nng_ctx_id.3.html index 391c2b24..8de8fd0d 100644 --- a/man/v1.2.2/nng_ctx_id.3.html +++ b/man/v1.2.2/nng_ctx_id.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_id(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_id - return numeric context identifier

    @@ -548,7 +61,7 @@ Otherwise it returns -1.

    A context is considered valid if it was ever opened with -nng_ctx_open() function. +nng_ctx_open() function. Contexts that are allocated on the stack or statically should be initialized with the macro NNG_CTX_INITIALIZER to ensure that @@ -580,11 +93,12 @@ they cannot be confused with a valid context before they are opened.

    SEE ALSO

    -

    nng_ctx(5), -nng(7)

    +

    nng_ctx(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_open.3.html b/man/v1.2.2/nng_ctx_open.3.html index ca940c4c..b3e7c2dd 100644 --- a/man/v1.2.2/nng_ctx_open.3.html +++ b/man/v1.2.2/nng_ctx_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_open(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_open - create context

    @@ -555,7 +68,7 @@ Not every protocol supports creation of separate contexts.

    Contexts allow the independent and concurrent use of stateful operations using the same socket. -For example, two different contexts created on a rep +For example, two different contexts created on a rep socket can each receive requests, and send replies to them, without any regard to or interference with each other.

    @@ -618,20 +131,21 @@ nonsensical, and not supported.

    SEE ALSO

    -

    nng_ctx_close(3), -nng_ctx_getopt(3), -nng_ctx_recv(3), -nng_ctx_send(3), -nng_ctx_setopt(3), -nng_strerror(3), -nng_ctx(5), -nng_socket(5), -nng_rep(7), -nng_req(7), -nng(7)

    +

    nng_ctx_close(3), +nng_ctx_getopt(3), +nng_ctx_recv(3), +nng_ctx_send(3), +nng_ctx_setopt(3), +nng_strerror(3), +nng_ctx(5), +nng_socket(5), +nng_rep(7), +nng_req(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_recv.3.html b/man/v1.2.2/nng_ctx_recv.3.html index acaa28a3..7509813d 100644 --- a/man/v1.2.2/nng_ctx_recv.3.html +++ b/man/v1.2.2/nng_ctx_recv.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_recv(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_recv - receive message using context asynchronously

    @@ -536,15 +49,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_ctx_recv() receives a message using the -context s asynchronously.

    +

    The nng_ctx_recv() receives a message using the +context s asynchronously.

    When a message is successfully received by the context, it is stored in the aio by an internal call equivalent to -nng_aio_set_msg(), then the completion +nng_aio_set_msg(), then the completion callback on the aio is executed. -In this case, nng_aio_result() will +In this case, nng_aio_result() will return zero. The callback function is responsible for retrieving the message and disposing of it appropriately.

    @@ -566,7 +79,7 @@ case can lead to memory leaks.

    If for some reason the asynchronous receive cannot be completed successfully (including by being canceled or timing out), then the callback will still be executed, -but nng_aio_result() will be non-zero.

    +but nng_aio_result() will be non-zero.

    @@ -652,17 +165,18 @@ protocol, so examination of the protocol documentation is encouraged.

    SEE ALSO

    -

    nng_aio_get_msg(3), -nng_aio_set_msg(3), -nng_msg_alloc(3), -nng_strerror(3), -nng_aio(5), -nng_ctx(5), -nng_msg(5), -nng(7)

    +

    nng_aio_get_msg(3), +nng_aio_set_msg(3), +nng_msg_alloc(3), +nng_strerror(3), +nng_aio(5), +nng_ctx(5), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_send.3.html b/man/v1.2.2/nng_ctx_send.3.html index 630b2c84..1128bc0f 100644 --- a/man/v1.2.2/nng_ctx_send.3.html +++ b/man/v1.2.2/nng_ctx_send.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_ctx_send(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_send - send message using context asynchronously

    @@ -536,17 +49,17 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_ctx_send() sends a message using the -context ctx asynchronously.

    +

    The nng_ctx_send() sends a message using the +context ctx asynchronously.

    The message to send must have previously been set on the aio -using the nng_aio_set_msg() function. +using the nng_aio_set_msg() function. The function assumes “ownership” of the message.

    If the message was successfully queued for delivery to the socket, -then the aio will be completed, and nng_aio_result() +then the aio will be completed, and nng_aio_result() will return zero. In this case the socket will dispose of the message when it is finished with it.

    @@ -570,12 +83,12 @@ socket, or in flight over physical media.

    If the operation fails for any reason (including cancellation or timeout), then the aio callback will be executed and -nng_aio_result() will return a non-zero error status. +nng_aio_result() will return a non-zero error status. In this case, the callback has a responsibility to retrieve the message from -the aio with nng_aio_get_msg() and dispose of +the aio with nng_aio_get_msg() and dispose of it appropriately. (This may include retrying the send operation on the same or a different -socket, or deallocating the message with nng_msg_free().)

    +socket, or deallocating the message with nng_msg_free().)

    @@ -600,7 +113,7 @@ protocol, so examination of the protocol documentation is encouraged. Context send operations are asynchronous. If a synchronous operation is needed, one can be constructed by using a NULL callback on the aio and then waiting for the operation using -nng_aio_wait(). +nng_aio_wait().
    @@ -684,17 +197,18 @@ If a synchronous operation is needed, one can be constructed by using a

    SEE ALSO

    -

    nng_aio_get_msg(3), -nng_aio_set_msg(3), -nng_msg_alloc(3), -nng_strerror(3), -nng_aio(5), -nng_ctx(5), -nng_msg(5), -nng(7)

    +

    nng_aio_get_msg(3), +nng_aio_set_msg(3), +nng_msg_alloc(3), +nng_strerror(3), +nng_aio(5), +nng_ctx(5), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_set.3.html b/man/v1.2.2/nng_ctx_set.3.html index 55c5a442..bf8564a8 100644 --- a/man/v1.2.2/nng_ctx_set.3.html +++ b/man/v1.2.2/nng_ctx_set.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_set(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_set - set context option

    @@ -558,7 +71,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b     		-These functions are deprecated. Please see nng_ctx_set. +These functions are deprecated. Please see nng_ctx_set.
    @@ -626,7 +139,7 @@ The ival is passed to the option.

    nng_ctx_set_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_ctx_set_size()
    @@ -714,16 +227,17 @@ and similar.

    SEE ALSO

    -

    nng_ctx_get(3), -nng_socket_set(3), -nng_strerror(3), -nng_ctx(5), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_ctx_get(3), +nng_socket_set(3), +nng_strerror(3), +nng_ctx(5), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ctx_setopt.3.html b/man/v1.2.2/nng_ctx_setopt.3.html index f9e5ab6a..b35819a5 100644 --- a/man/v1.2.2/nng_ctx_setopt.3.html +++ b/man/v1.2.2/nng_ctx_setopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ctx_setopt(3) - - - + + -

    NAME

    +

    NAME

    nng_ctx_setopt - set context option

    @@ -558,7 +71,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_ctx_set. +These functions are deprecated. Please see nng_ctx_set. @@ -626,7 +139,7 @@ The ival is passed to the option.

    nng_ctx_setopt_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_ctx_setopt_size()
    @@ -714,16 +227,17 @@ and similar.

    SEE ALSO

    -

    nng_ctx_getopt(3), -nng_setopt(3), -nng_strerror(3), -nng_ctx(5), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_ctx_getopt(3), +nng_setopt(3), +nng_strerror(3), +nng_ctx(5), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_alloc.3supp.html b/man/v1.2.2/nng_cv_alloc.3supp.html index dc42a452..aaac5ae0 100644 --- a/man/v1.2.2/nng_cv_alloc.3supp.html +++ b/man/v1.2.2/nng_cv_alloc.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_alloc(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_alloc - allocate condition variable

    @@ -545,11 +58,11 @@ the mutex mtx, and returns it in cvp.

    Every condition variable is associated with a mutex, which must be owned when a thread waits for the condition using -nng_cv_wait() or -nng_cv_until(). +nng_cv_wait() or +nng_cv_until(). The mutex must also be owned when signaling the condition using the -nng_cv_wake() or -nng_cv_wake1() functions.

    +nng_cv_wake() or +nng_cv_wake1() functions.

    @@ -582,17 +95,18 @@ The mutex must also be owned when signaling the condition using the

    SEE ALSO

    -

    nng_cv_free(3supp), -nng_cv_until(3supp), -nng_cv_wait(3supp), -nng_cv_wake(3supp), -nng_cv_wake1(3supp), -nng_mtx_alloc(3supp), -nng_strerror(3), -nng(7)

    +

    nng_cv_free(3supp), +nng_cv_until(3supp), +nng_cv_wait(3supp), +nng_cv_wake(3supp), +nng_cv_wake1(3supp), +nng_mtx_alloc(3supp), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_free.3supp.html b/man/v1.2.2/nng_cv_free.3supp.html index 83367221..0f2709a5 100644 --- a/man/v1.2.2/nng_cv_free.3supp.html +++ b/man/v1.2.2/nng_cv_free.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_free(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_free - free condition variable

    @@ -561,11 +74,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_until.3supp.html b/man/v1.2.2/nng_cv_until.3supp.html index 7bd23312..fa920ba9 100644 --- a/man/v1.2.2/nng_cv_until.3supp.html +++ b/man/v1.2.2/nng_cv_until.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_until(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_until - wait for condition or timeout

    @@ -539,9 +52,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_cv_until() waits until either the condition variable cv is signaled -by another thread calling either nng_cv_wake() or -nng_cv_wake1(), or the system clock (as tracked -by nng_clock()) reaches when.

    +by another thread calling either nng_cv_wake() or +nng_cv_wake1(), or the system clock (as tracked +by nng_clock()) reaches when.

    The caller must have have ownership of the mutex that was used when @@ -619,17 +132,18 @@ tests for true.

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_cv_wait(3supp), -nng_cv_wake(3supp), -nng_cv_wake1(3supp), -nng_mtx_alloc(3supp), -nng_mtx_lock(3supp), -nng_mtx_unlock(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_cv_wait(3supp), +nng_cv_wake(3supp), +nng_cv_wake1(3supp), +nng_mtx_alloc(3supp), +nng_mtx_lock(3supp), +nng_mtx_unlock(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_wait.3supp.html b/man/v1.2.2/nng_cv_wait.3supp.html index 78692a64..0d9552b0 100644 --- a/man/v1.2.2/nng_cv_wait.3supp.html +++ b/man/v1.2.2/nng_cv_wait.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_wait(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_wait - wait for condition

    @@ -539,8 +52,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_cv_wait() waits for the condition variable cv to be signaled -by another thread calling either nng_cv_wake() or -nng_cv_wake1().

    +by another thread calling either nng_cv_wake() or +nng_cv_wake1().

    The caller must have have ownership of the mutex that was used when @@ -615,17 +128,18 @@ tests for true.

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_cv_until(3supp), -nng_cv_wake(3supp), -nng_cv_wake1(3supp), -nng_mtx_alloc(3supp), -nng_mtx_lock(3supp), -nng_mtx_unlock(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_cv_until(3supp), +nng_cv_wake(3supp), +nng_cv_wake1(3supp), +nng_mtx_alloc(3supp), +nng_mtx_lock(3supp), +nng_mtx_unlock(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_wake.3supp.html b/man/v1.2.2/nng_cv_wake.3supp.html index 31cf54d2..cc8cd33d 100644 --- a/man/v1.2.2/nng_cv_wake.3supp.html +++ b/man/v1.2.2/nng_cv_wake.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_wake(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_wake - wake all waiters

    @@ -538,8 +51,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_cv_wake() wakes any threads waiting for the condition variable cv -to be signaled in the nng_cv_wait() or -nng_cv_until() functions.

    +to be signaled in the nng_cv_wait() or +nng_cv_until() functions.

    The caller must have have ownership of the mutex that was used when @@ -568,7 +81,7 @@ will check, while holding the mutex. This function wakes all threads, which is generally safer but can lead to a problem known as the “thundering herd” when there are many waiters, as they are all woken simultaneously. -See nng_cv_wake1() for a solution to this problem. +See nng_cv_wake1() for a solution to this problem. @@ -595,17 +108,18 @@ See nng_cv_wake1() for a sol

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_cv_until(3supp), -nng_cv_wait(3supp), -nng_cv_wake1(3supp), -nng_mtx_alloc(3supp), -nng_mtx_lock(3supp), -nng_mtx_unlock(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_cv_until(3supp), +nng_cv_wait(3supp), +nng_cv_wake1(3supp), +nng_mtx_alloc(3supp), +nng_mtx_lock(3supp), +nng_mtx_unlock(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_cv_wake1.3supp.html b/man/v1.2.2/nng_cv_wake1.3supp.html index 1d4d2ee8..65780282 100644 --- a/man/v1.2.2/nng_cv_wake1.3supp.html +++ b/man/v1.2.2/nng_cv_wake1.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_cv_wake1(3supp) - - - + + -

    NAME

    +

    NAME

    nng_cv_wake1 - wake one waiter

    @@ -539,8 +52,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_cv_wake1() wakes at most one thread waiting for the condition variable cv -to be signaled in the nng_cv_wait() or -nng_cv_until() functions.

    +to be signaled in the nng_cv_wait() or +nng_cv_until() functions.

    The caller must have have ownership of the mutex that was used when @@ -569,7 +82,7 @@ will check, while holding the mutex. While this function avoids the “thundering herd” problem, the caller cannot predict which waiter will be woken, and so the design must ensure that it is sufficient that any waiter be woken. -When in doubt, it is safer to use nng_cv_wake(). +When in doubt, it is safer to use nng_cv_wake(). @@ -596,17 +109,18 @@ When in doubt, it is safer to use nng_cv

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_cv_until(3supp), -nng_cv_wait(3supp), -nng_cv_wake(3supp), -nng_mtx_alloc(3supp), -nng_mtx_lock(3supp), -nng_mtx_unlock(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_cv_until(3supp), +nng_cv_wait(3supp), +nng_cv_wake(3supp), +nng_mtx_alloc(3supp), +nng_mtx_lock(3supp), +nng_mtx_unlock(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_device.3.html b/man/v1.2.2/nng_device.3.html index d4030889..79d2a7c2 100644 --- a/man/v1.2.2/nng_device.3.html +++ b/man/v1.2.2/nng_device.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_device(3) - - - + + -

    NAME

    +

    NAME

    nng_device - message forwarding device

    @@ -543,7 +56,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_device() function forwards messages received from one -socket s1 to another socket s2, and vice versa.

    +socket s1 to another socket s2, and vice versa.

    This function is used to create forwarders, which can be used to create @@ -554,7 +67,7 @@ reliability, and isolation.

    Only raw mode sockets may be used with this function. These can be created using _raw forms of the various socket constructors, -such as nng_req0_open_raw().

    +such as nng_req0_open_raw().

    The nng_device() function does not return until one of the sockets @@ -567,8 +80,8 @@ is closed.

    the NNG_SOCKET_INITIALIZER special value. If this is the case, then the other socket must be valid, and must use a protocol that is bidirectional and can peer with itself (such as -pair or -bus.) +pair or +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.

    @@ -582,9 +95,9 @@ In this case sockets s1 and s2 must be “compatible” which is to say that they should represent the opposite halves of a two protocol pattern, or both be the same protocol for a single protocol pattern. -For example, if s1 is a pub socket, then s2 must -be a sub socket. -Or, if s1 is a bus socket, then s2 must also +For example, if s1 is a pub socket, then s2 must +be a sub socket. +Or, if s1 is a bus socket, then s2 must also be a bus socket.

    @@ -702,12 +215,13 @@ one occurs, or if one of the sockets is closed.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dial.3.html b/man/v1.2.2/nng_dial.3.html index c5c200b1..63948edf 100644 --- a/man/v1.2.2/nng_dial.3.html +++ b/man/v1.2.2/nng_dial.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dial(3) - - - + + -

    NAME

    +

    NAME

    nng_dial - create and start dialer

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_dial() function creates a newly initialized -nng_dialer object, +nng_dialer object, associated with socket s, and configured to dial the address specified by url, and starts it. If the value of dp is not NULL, then @@ -546,7 +59,7 @@ the newly created dialer is stored at the address indicated by dp.

    Dialers initiate a remote connection to a listener. Upon a successful -connection being established, they create a pipe, +connection being established, they create a pipe, add it to the socket, and then wait for that pipe to be closed. When the pipe is closed, the dialer attempts to re-establish the connection. Dialers will also periodically retry a connection automatically if an attempt @@ -562,7 +75,7 @@ to connect asynchronously fails.

    While it is convenient to think of dialers as “clients”, the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a req +For example, a req socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! @@ -599,8 +112,8 @@ it also generally makes diagnosing failures somewhat more difficult.

    Because the dialer is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using nng_dialer_create() and -nng_dialer_start() instead.

    +using nng_dialer_create() and +nng_dialer_start() instead.

    @@ -697,17 +210,18 @@ using nng_dialer_create() a

    SEE ALSO

    -

    nng_dialer_close(3), -nng_dialer_create(3) -nng_dialer_start(3), -nng_listen(3), -nng_strerror(3), -nng_dialer(5), -nng_pipe(5), -nng(7)

    +

    nng_dialer_close(3), +nng_dialer_create(3) +nng_dialer_start(3), +nng_listen(3), +nng_strerror(3), +nng_dialer(5), +nng_pipe(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer.5.html b/man/v1.2.2/nng_dialer.5.html index 60b14414..a35a9d25 100644 --- a/man/v1.2.2/nng_dialer.5.html +++ b/man/v1.2.2/nng_dialer.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer(5) - - - + + -

    NAME

    +

    NAME

    nng_dialer - dialer

    @@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_dialer is a handle to a “dialer” object, which is responsible for -creating a single nng_pipe at a time by +creating a single nng_pipe at a time by establishing an outgoing connection.

    @@ -550,9 +63,9 @@ destroyed.

    Dialer objects are created by the -nng_dialer_create() -or nng_dial() functions, and are always “owned” -by a single nng_socket.

    +nng_dialer_create() +or nng_dial() functions, and are always “owned” +by a single nng_socket.

    @@ -576,8 +89,8 @@ accurate type checks in functions passing values of this type. @@ -592,8 +105,8 @@ of both. @@ -602,7 +115,7 @@ challenging communications problems.

    Dialer objects may be destroyed by the -nng_dialer_close() function. +nng_dialer_close() function. They are also closed when their “owning” socket is closed.

    @@ -618,20 +131,21 @@ before it is opened, to prevent confusion with valid open dialers.

    SEE ALSO

    -

    nng_dial(3), -nng_dialer_close(3), -nng_dialer_create(3), -nng_dialer_getopt(3), -nng_dialer_id(3), -nng_dialer_setopt(3), -nng_dialer_start(3), -nng_listener(5), -nng_pipe(5), -nng_socket(5), -nng(7)

    +

    nng_dial(3), +nng_dialer_close(3), +nng_dialer_create(3), +nng_dialer_getopt(3), +nng_dialer_id(3), +nng_dialer_setopt(3), +nng_dialer_start(3), +nng_listener(5), +nng_pipe(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_close.3.html b/man/v1.2.2/nng_dialer_close.3.html index 8d8bce4b..acf473bf 100644 --- a/man/v1.2.2/nng_dialer_close.3.html +++ b/man/v1.2.2/nng_dialer_close.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_dialer_close(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_close - close dialer

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

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

    @@ -581,15 +94,16 @@ this function has returned.

    SEE ALSO

    -

    nng_close(3), -nng_dial(3), -nng_dialer_create(3) -nng_strerror(3), -nng_dialer(5), -nng(7)

    +

    nng_close(3), +nng_dial(3), +nng_dialer_create(3) +nng_strerror(3), +nng_dialer(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_create.3.html b/man/v1.2.2/nng_dialer_create.3.html index eaefa801..46a034ae 100644 --- a/man/v1.2.2/nng_dialer_create.3.html +++ b/man/v1.2.2/nng_dialer_create.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_dialer_create(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_create - create dialer

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_dialer_create() function creates a newly initialized -nng_dialer object, associated with socket s, +nng_dialer object, associated with socket s, and configured to connect to the address specified by url, and stores a pointer to at the location referenced by dialerp.

    @@ -562,7 +75,7 @@ fails.

    While it is convenient to think of dialers as “clients”, the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a req +For example, a req socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! @@ -571,11 +84,11 @@ It may even have some of each at the same time!

    The dialer is not started, but may be further configured with -the nng_dialer_setopt() family of functions.

    +the nng_dialer_setopt() family of functions.

    Once it is fully configured, the dialer may be started using the -nng_dialer_start() function.

    +nng_dialer_start() function.

    -A given nng_socket may have multiple dialer -objects, multiple listener objects, or even some +A given nng_socket may have multiple dialer +objects, multiple listener objects, or even some of both.
    The client/server relationship described by dialer/listener is completely orthogonal to any similar relationship in the protocols. -For example, a rep socket may use a dialer -to connect to a listener on an req socket. +For example, a rep socket may use a dialer +to connect to a listener on an req socket. This orthogonality can lead to innovative solutions to otherwise challenging communications problems.
    @@ -585,7 +98,7 @@ the nng_dialer_setopt() fam
    If no specific configuration is required, consider using the -simpler nng_dial() function instead. +simpler nng_dial() function instead.
    @@ -637,18 +150,19 @@ simpler nng_dial() function instead.

    SEE ALSO

    -

    nng_dial(3), -nng_dialer_close(3), -nng_dialer_getopt(3), -nng_dialer_setopt(3), -nng_dialer_start(3), -nng_listener_create(3) -nng_strerror(3), -nng_dialer(5), -nng(7)

    +

    nng_dial(3), +nng_dialer_close(3), +nng_dialer_getopt(3), +nng_dialer_setopt(3), +nng_dialer_start(3), +nng_listener_create(3) +nng_strerror(3), +nng_dialer(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_get.3.html b/man/v1.2.2/nng_dialer_get.3.html index 59f7658e..a4c08057 100644 --- a/man/v1.2.2/nng_dialer_get.3.html +++ b/man/v1.2.2/nng_dialer_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_get(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_get - get dialer option

    @@ -558,9 +71,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_dialer_get() functions are used to retrieve option values for -the dialer d. +the dialer d. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -625,7 +138,7 @@ The value will be stored at ivalp.

    nng_dialer_get_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -644,15 +157,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_dialer_get_addr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into the value referenced by sap.

    nng_dialer_get_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_dialer_get_uint64()
    @@ -735,19 +248,20 @@ numbers, and similar.

    SEE ALSO

    -

    nng_dialer_create(3) -nng_dialer_set(3) -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_dialer(5), -nng_duration(5), -nng_options(5), -nng_sockaddr(5), -nng(7)

    +

    nng_dialer_create(3) +nng_dialer_set(3) +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_dialer(5), +nng_duration(5), +nng_options(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_getopt.3.html b/man/v1.2.2/nng_dialer_getopt.3.html index 0dd56222..fca47ca7 100644 --- a/man/v1.2.2/nng_dialer_getopt.3.html +++ b/man/v1.2.2/nng_dialer_getopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_getopt(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_getopt - get dialer option

    @@ -562,7 +75,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_dialer_get. +These functions are deprecated. Please see nng_dialer_get. @@ -570,9 +83,9 @@ These functions are deprecated. Please see nng

    The nng_dialer_getopt() functions are used to retrieve option values for -the dialer d. +the dialer d. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -637,7 +150,7 @@ The value will be stored at ivalp.

    nng_dialer_getopt_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -656,15 +169,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_dialer_getopt_sockaddr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into the value referenced by sap.

    nng_dialer_getopt_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_dialer_getopt_uint64()
    @@ -747,19 +260,20 @@ numbers, and similar.

    SEE ALSO

    -

    nng_dialer_create(3) -nng_dialer_setopt(3) -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_dialer(5), -nng_duration(5), -nng_options(5), -nng_sockaddr(5), -nng(7)

    +

    nng_dialer_create(3) +nng_dialer_setopt(3) +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_dialer(5), +nng_duration(5), +nng_options(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_id.3.html b/man/v1.2.2/nng_dialer_id.3.html index bab6b7a8..e8e43d6c 100644 --- a/man/v1.2.2/nng_dialer_id.3.html +++ b/man/v1.2.2/nng_dialer_id.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_id(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_id - return numeric dialer identifier

    @@ -548,8 +61,8 @@ Otherwise it returns -1.

    A dialer is considered valid if it was ever created with the -nng_dialer_create() or -nng_dial() functions. +nng_dialer_create() or +nng_dial() functions. Dialers that are allocated on the stack or statically should be initialized with the macro NNG_DIALER_INITIALIZER to ensure that @@ -581,11 +94,12 @@ they cannot be confused with a valid dialer before they are created properly.

    SEE ALSO

    -

    nng_dialer(5), -nng(7)

    +

    nng_dialer(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_set.3.html b/man/v1.2.2/nng_dialer_set.3.html index b220d1a0..9fef8acb 100644 --- a/man/v1.2.2/nng_dialer_set.3.html +++ b/man/v1.2.2/nng_dialer_set.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_set(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_set - set dialer option

    @@ -557,9 +70,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_dialer_set() functions are used to configure options for -the dialer d. +the dialer d. The actual options that may be configured in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options are documented with the @@ -624,7 +137,7 @@ The ival is passed to the option.

    nng_dialer_set_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_dialer_set_ptr()
    @@ -632,7 +145,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -745,16 +258,17 @@ and such.

    SEE ALSO

    -

    nng_dialer_create(3) -nng_dialer_get(3) -nng_strerror(3), -nng_dialer(5), -nng_duration(5), -nng_options(5), -nng(7)

    +

    nng_dialer_create(3) +nng_dialer_get(3) +nng_strerror(3), +nng_dialer(5), +nng_duration(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_setopt.3.html b/man/v1.2.2/nng_dialer_setopt.3.html index 1f431639..f15dbc08 100644 --- a/man/v1.2.2/nng_dialer_setopt.3.html +++ b/man/v1.2.2/nng_dialer_setopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_setopt(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_setopt - set dialer option

    @@ -561,7 +74,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_dialer_set. +These functions are deprecated. Please see nng_dialer_set. @@ -569,9 +82,9 @@ These functions are deprecated. Please see nng

    The nng_dialer_setopt() functions are used to configure options for -the dialer d. +the dialer d. The actual options that may be configured in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options are documented with the @@ -636,7 +149,7 @@ The ival is passed to the option.

    nng_dialer_setopt_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_dialer_setopt_ptr()
    @@ -644,7 +157,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -757,16 +270,17 @@ and such.

    SEE ALSO

    -

    nng_dialer_create(3) -nng_dialer_getopt(3) -nng_strerror(3), -nng_dialer(5), -nng_duration(5), -nng_options(5), -nng(7)

    +

    nng_dialer_create(3) +nng_dialer_getopt(3) +nng_strerror(3), +nng_dialer(5), +nng_duration(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_dialer_start.3.html b/man/v1.2.2/nng_dialer_start.3.html index 72faa8d0..e0675044 100644 --- a/man/v1.2.2/nng_dialer_start.3.html +++ b/man/v1.2.2/nng_dialer_start.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_dialer_start(3) - - - + + -

    NAME

    +

    NAME

    nng_dialer_start - start dialer

    @@ -680,14 +193,15 @@ its configuration.

    SEE ALSO

    -

    nng_dial(3), -nng_dialer_create(3) -nng_strerror(3), -nng_dialer(5), -nng(7)

    +

    nng_dial(3), +nng_dialer_create(3) +nng_strerror(3), +nng_dialer(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_duration.5.html b/man/v1.2.2/nng_duration.5.html index 6664ec07..b24da811 100644 --- a/man/v1.2.2/nng_duration.5.html +++ b/man/v1.2.2/nng_duration.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_duration(5) - - - + + -

    NAME

    +

    NAME

    nng_duration - relative time in milliseconds

    @@ -567,11 +80,12 @@ This type is most often used in conjunction with timers and timeouts.

    SEE ALSO

    -

    nng_options(5), -nng(7)

    +

    nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_free.3.html b/man/v1.2.2/nng_free.3.html index c8c31b32..963037b2 100644 --- a/man/v1.2.2/nng_free.3.html +++ b/man/v1.2.2/nng_free.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_free(3) - - - + + -

    NAME

    +

    NAME

    nng_free - free memory

    @@ -537,8 +50,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_free() function deallocates a memory region of size size, -that was previously allocated by nng_alloc() or -nng_recv() with the NNG_FLAG_ALLOC flag.

    +that was previously allocated by nng_alloc() or +nng_recv() with the NNG_FLAG_ALLOC flag.

    @@ -562,7 +75,7 @@ used to allocate the memory. @@ -591,12 +104,13 @@ behavior, including corruption of application memory.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_getopt.3.html b/man/v1.2.2/nng_getopt.3.html index 99a7c8e1..ca51469d 100644 --- a/man/v1.2.2/nng_getopt.3.html +++ b/man/v1.2.2/nng_getopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_getopt(3) - - - + + -

    NAME

    +

    NAME

    nng_getopt - get socket option

    @@ -560,7 +73,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    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. -These functions are deprecated. Please see nng_socket_get. +These functions are deprecated. Please see nng_socket_get.
    @@ -568,9 +81,9 @@ These functions are deprecated. Please see nng

    The nng_getopt() functions are used to retrieve option values for -the socket s. +the socket s. The actual options that may be retrieved in this way vary. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    Additionally transport-specific options and protocol-specific options are @@ -633,7 +146,7 @@ The value will be stored at ivalp.

    nng_getopt_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -653,9 +166,9 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_getopt_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_getopt_uint64()
    @@ -738,20 +251,21 @@ numbers, and similar.

    SEE ALSO

    -

    nng_dialer_getopt(3), -nng_listener_getopt(3), -nng_pipe_getopt(3), -nng_setopt(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_dialer_getopt(3), +nng_listener_getopt(3), +nng_pipe_getopt(3), +nng_setopt(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_alloc.3http.html b/man/v1.2.2/nng_http_client_alloc.3http.html index d9f1e2ef..b01a0487 100644 --- a/man/v1.2.2/nng_http_client_alloc.3http.html +++ b/man/v1.2.2/nng_http_client_alloc.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_alloc(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_alloc - allocate HTTP client

    @@ -580,14 +93,15 @@ it in the location referenced by clientp.

    SEE ALSO

    -

    nng_http_client_connect(3http), -nng_http_client_free(3http), -nng_strerror(3), -nng_url_parse(3), -nng(7)

    +

    nng_http_client_connect(3http), +nng_http_client_free(3http), +nng_strerror(3), +nng_url_parse(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_connect.3http.html b/man/v1.2.2/nng_http_client_connect.3http.html index def19cd6..374c6fab 100644 --- a/man/v1.2.2/nng_http_client_connect.3http.html +++ b/man/v1.2.2/nng_http_client_connect.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_connect(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_connect - establish HTTP client connection

    @@ -545,13 +58,13 @@ connection from client to the server that was indicated in the URL that

    The result of the operation will be stored in the aio when the operation is complete, and will be obtainable via -nng_aio_result().

    +nng_aio_result().

    On success, a pointer to the underlying HTTP client (type nng_http_conn *) will be stored in the first output result of the aio, and can be obtained by -nng_aio_get_output() with an index of zero (0).

    +nng_aio_get_output() with an index of zero (0).

    @@ -652,18 +165,19 @@ obtained by

    SEE ALSO

    -

    nng_aio_get_output(3), -nng_aio_result(3), -nng_aio_wait(3), -nng_strerror(3), -nng_http_client_alloc(3http), -nng_http_conn_close(3http), -nng_http_conn_read(3http), -nng_http_conn_write(3http), -nng(7)

    +

    nng_aio_get_output(3), +nng_aio_result(3), +nng_aio_wait(3), +nng_strerror(3), +nng_http_client_alloc(3http), +nng_http_conn_close(3http), +nng_http_conn_read(3http), +nng_http_conn_write(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_free.3http.html b/man/v1.2.2/nng_http_client_free.3http.html index a591e83c..f45fb554 100644 --- a/man/v1.2.2/nng_http_client_free.3http.html +++ b/man/v1.2.2/nng_http_client_free.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_free(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_free - free HTTP client

    @@ -548,7 +61,7 @@ resources referenced by client.

    Any connections created by -nng_http_client_connect() are unaffected, +nng_http_client_connect() are unaffected, and so the caller must close those explicitly if desired. @@ -576,12 +89,13 @@ and so the caller must close those explicitly if desired.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_get_tls.3http.html b/man/v1.2.2/nng_http_client_get_tls.3http.html index 72605384..5e034ddf 100644 --- a/man/v1.2.2/nng_http_client_get_tls.3http.html +++ b/man/v1.2.2/nng_http_client_get_tls.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_get_tls(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_get_tls - get HTTP client TLS configuration

    @@ -542,10 +55,10 @@ saves a pointer to it in the address referenced by cfgp.

    The object will be returned with an extra hold (see -nng_tls_config_hold()) +nng_tls_config_hold()) placed on it on behalf of the caller. The caller should free this hold by calling -nng_tls_config_free() with it is done +nng_tls_config_free() with it is done with the TLS configuration.

    @@ -595,17 +108,18 @@ with the TLS configuration.

    SEE ALSO

    -

    nng_http_client_alloc(3http), -nng_http_client_connect(3http), -nng_http_client_set_tls(3http), -nng_tls_config_alloc(3tls), -nng_tls_config_free(3tls), -nng_tls_config_hold(3tls), -nng_strerror(3), -nng(7)

    +

    nng_http_client_alloc(3http), +nng_http_client_connect(3http), +nng_http_client_set_tls(3http), +nng_tls_config_alloc(3tls), +nng_tls_config_free(3tls), +nng_tls_config_hold(3tls), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_set_tls.3http.html b/man/v1.2.2/nng_http_client_set_tls.3http.html index faea18ab..cb957207 100644 --- a/man/v1.2.2/nng_http_client_set_tls.3http.html +++ b/man/v1.2.2/nng_http_client_set_tls.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_set_tls(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_set_tls - set HTTP client TLS configuration

    @@ -550,7 +63,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b This also invalidates any previously obtained values from -nng_http_client_get_tls(). +nng_http_client_get_tls(). @@ -563,7 +76,7 @@ This also invalidates any previously obtained values from Any connections established with -nng_http_client_connect() +nng_http_client_connect() will continue to use any TLS configuration that they were started with. @@ -608,15 +121,16 @@ will continue to use any TLS configuration that they were started with.

    SEE ALSO

    -

    nng_http_client_alloc(3http), -nng_http_client_connect(3http), -nng_http_client_get_tls(3http), -nng_tls_config_alloc(3tls), -nng_strerror(3), -nng(7)

    +

    nng_http_client_alloc(3http), +nng_http_client_connect(3http), +nng_http_client_get_tls(3http), +nng_tls_config_alloc(3tls), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_client_transact.3http.html b/man/v1.2.2/nng_http_client_transact.3http.html index 08937455..cc335b85 100644 --- a/man/v1.2.2/nng_http_client_transact.3http.html +++ b/man/v1.2.2/nng_http_client_transact.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_client_transact(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_client_transact - perform one HTTP transaction

    @@ -546,7 +59,7 @@ sending the request req res, and finally closes the connection that it created. The entire response is read, including any associated body, which can subsequently be obtained using -nng_http_res_get_data().

    +nng_http_res_get_data().

    This function is intended to make creation of client applications easier, @@ -555,7 +68,7 @@ entire HTTP transaction.

    A similar function, -nng_http_conn_transact(), +nng_http_conn_transact(), exists. That function behaves similarily, but uses an existing connection, which can be reused.

    @@ -594,7 +107,7 @@ trust-worthy servers.

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

    @@ -676,16 +189,17 @@ That result will either be zero or an error code.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_strerror(3), -nng_http_client_connect(3http), -nng_http_conn_transact(3http), -nng_http_res_get_data(3http), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_strerror(3), +nng_http_client_connect(3http), +nng_http_conn_transact(3http), +nng_http_res_get_data(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_close.3http.html b/man/v1.2.2/nng_http_conn_close.3http.html index 27c50f47..b54a58c4 100644 --- a/man/v1.2.2/nng_http_conn_close.3http.html +++ b/man/v1.2.2/nng_http_conn_close.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_conn_close(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_close - close HTTP connection

    @@ -565,13 +78,14 @@ including any disposing of any underlying file descriptors or related resources.

    SEE ALSO

    -

    nng_http_client_connect(3http), -nng_http_handler_alloc(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_client_connect(3http), +nng_http_handler_alloc(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_read.3http.html b/man/v1.2.2/nng_http_conn_read.3http.html index 7924ac59..ebc99e1c 100644 --- a/man/v1.2.2/nng_http_conn_read.3http.html +++ b/man/v1.2.2/nng_http_conn_read.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_conn_read(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_read - read from HTTP connection

    @@ -548,7 +61,7 @@ asynchronous I/O structure aio.

    -The nng_aio_set_iov() function must have been +The nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio. @@ -558,7 +71,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -566,7 +79,7 @@ That result will either be zero or an error code.

    read, or an error has occurred. Therefore, the number of bytes read may be less than requested. The actual number of bytes read can be determined with -nng_aio_count().

    +nng_aio_count().

    @@ -661,18 +174,19 @@ Most applications will never need to use this function.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_http_handler_alloc(3http), -nng_http_client_connect(3http), -nng_http_conn_read_all(3http), -nng_strerror(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_http_handler_alloc(3http), +nng_http_client_connect(3http), +nng_http_conn_read_all(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_read_all.3http.html b/man/v1.2.2/nng_http_conn_read_all.3http.html index 11cbf88a..151123b4 100644 --- a/man/v1.2.2/nng_http_conn_read_all.3http.html +++ b/man/v1.2.2/nng_http_conn_read_all.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_read_all(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_read_all - read all from HTTP connection

    @@ -548,7 +61,7 @@ asynchronous I/O structure aio.

    @@ -557,7 +70,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -569,7 +82,7 @@ completes successfully, then the entire requested data has been read.

    It is still possible for a partial read to complete in the event of an error. The actual number of bytes read can be determined with -nng_aio_count().

    +nng_aio_count().

    -The nng_aio_set_iov() function must have been +The nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio.
    @@ -664,17 +177,18 @@ from the relevant HTTP headers (typically Content-Length).

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_strerror(3), -nng_http_client_connect(3), -nng_http_conn_read(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_strerror(3), +nng_http_client_connect(3), +nng_http_conn_read(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_read_req.3http.html b/man/v1.2.2/nng_http_conn_read_req.3http.html index e8a77f51..f653a9af 100644 --- a/man/v1.2.2/nng_http_conn_read_req.3http.html +++ b/man/v1.2.2/nng_http_conn_read_req.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_read_req(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_read_req - read HTTP request

    @@ -552,7 +65,7 @@ of the related headers.

    Any HTTP entity/body data associated with the request is not read automatically. The caller should use -nng_http_conn_read_all() +nng_http_conn_read_all() to read the entity data, based on the details of the request itself. @@ -561,7 +74,7 @@ to read the entity data, based on the details of the request itself.

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

    @@ -635,15 +148,16 @@ That result will either be zero or an error code.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_strerror(3), -nng_http_client_connect(3http), -nng_http_conn_read_all(3http), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_strerror(3), +nng_http_client_connect(3http), +nng_http_conn_read_all(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_read_res.3http.html b/man/v1.2.2/nng_http_conn_read_res.3http.html index 46e5da3f..855d2c04 100644 --- a/man/v1.2.2/nng_http_conn_read_res.3http.html +++ b/man/v1.2.2/nng_http_conn_read_res.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_read_res(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_read_res - read HTTP response

    @@ -552,7 +65,7 @@ of the related headers.

    Any HTTP entity/body data associated with the response is not read automatically. The caller should use -nng_http_conn_read_all to read the entity +nng_http_conn_read_all to read the entity data, based on the details of the response itself. @@ -562,7 +75,7 @@ data, based on the details of the response itself.

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

    @@ -573,8 +86,8 @@ That result will either be zero or an error code.

    @@ -652,17 +165,18 @@ transaction.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_strerror(3), -nng_http_client_connect(3http), -nng_http_client_transact(3http), -nng_http_conn_transact(3http), -nng_http_conn_read_all(3http), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_strerror(3), +nng_http_client_connect(3http), +nng_http_client_transact(3http), +nng_http_conn_transact(3http), +nng_http_conn_read_all(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_transact.3http.html b/man/v1.2.2/nng_http_conn_transact.3http.html index fe7e41a2..b41192fc 100644 --- a/man/v1.2.2/nng_http_conn_transact.3http.html +++ b/man/v1.2.2/nng_http_conn_transact.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_transact(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_transact - perform one HTTP transaction on connection

    @@ -544,7 +57,7 @@ HTTP exchange over the connection conn, sending the request reqres. The entire response is read, including any associated body, which can subsequently be obtained using -nng_http_res_get_data().

    +nng_http_res_get_data().

    This function is intended to make creation of client applications easier, @@ -553,12 +66,12 @@ entire HTTP transaction.

    If an error occurs, the caller should close conn with -nng_http_conn_close(), as it may not +nng_http_conn_close(), as it may not necessarily be usable with other transactions.

    A similar function, -nng_http_client_transact(), +nng_http_client_transact(), exists. That function behaves similarily, but creates a connection on demand for the transaction, and disposes of it when finished.

    @@ -596,7 +109,7 @@ request interleaving.

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

    @@ -678,19 +191,20 @@ That result will either be zero or an error code.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_strerror(3), -nng_http_client_connect(3http), -nng_http_client_transact(3http), -nng_http_conn_read_res(3http), -nng_http_conn_read_all(3http), -nng_http_conn_write_req(3http), -nng_http_res_get_data(3http), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_strerror(3), +nng_http_client_connect(3http), +nng_http_client_transact(3http), +nng_http_conn_read_res(3http), +nng_http_conn_read_all(3http), +nng_http_conn_write_req(3http), +nng_http_res_get_data(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_write.3http.html b/man/v1.2.2/nng_http_conn_write.3http.html index 9927ed6c..4ea118da 100644 --- a/man/v1.2.2/nng_http_conn_write.3http.html +++ b/man/v1.2.2/nng_http_conn_write.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_write(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_write - write to HTTP connection

    @@ -548,7 +61,7 @@ asynchronous I/O structure aio.

    @@ -557,7 +70,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -565,7 +78,7 @@ That result will either be zero or an error code.

    written, or an error has occurred. Therefore, the number of bytes written may be less than requested. The actual number of bytes written can be determined with -nng_aio_count().

    +nng_aio_count().

    Consider using the -nng_http_client_transact() or -nng_http_conn_transact() functions, +nng_http_client_transact() or +nng_http_conn_transact() functions, which provide a simpler interface for performing a complete HTTP client transaction. -The nng_aio_set_iov() function must have been +The nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio.
    @@ -660,18 +173,19 @@ Most applications will never need to use this function.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_http_client_connect(3http), -nng_http_conn_write_all(3http), -nng_http_handler_alloc(3http), -nng_strerror(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_http_client_connect(3http), +nng_http_conn_write_all(3http), +nng_http_handler_alloc(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_write_all.3http.html b/man/v1.2.2/nng_http_conn_write_all.3http.html index 23261662..d715bf4e 100644 --- a/man/v1.2.2/nng_http_conn_write_all.3http.html +++ b/man/v1.2.2/nng_http_conn_write_all.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_conn_write_all(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_write_all - write all to HTTP connection

    @@ -548,7 +61,7 @@ asynchronous I/O structure aio.

    @@ -557,7 +70,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -569,7 +82,7 @@ been written.

    It is still possible for a partial write to complete in the event of an error. The actual number of bytes written can be determined with -nng_aio_count().

    +nng_aio_count().

    -The nng_aio_set_iov() function must have been +The nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio.
    @@ -592,8 +105,8 @@ body content. @@ -609,10 +122,10 @@ an Content-Length header, and possibly a Content-Type
    Usually an HTTP request or response will have been written immediately -prior to this with http_conn_write_req() or -http_conn_write_res(). +prior to this with http_conn_write_req() or +http_conn_write_res(). In that case the request or response should have also contained an Content-Length header, and possibly a Content-Type header. An easier solution to sending HTTP content data, is to include the content with the request or reply using a function like -nng_http_req_copy_data(). +nng_http_req_copy_data(). In that case, the body data will be written automatically by the -http_conn_write_req() or -http_conn_write_res() function. +http_conn_write_req() or +http_conn_write_res() function.
    @@ -696,23 +209,24 @@ In that case, the body data will be written automatically by the

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_http_client_connect(3http), -nng_http_conn_write(3http), -http_conn_write_req(3http), -http_conn_write_res(3http), -nng_http_req_copy_data(3http), -nng_http_req_set_data(3http), -nng_http_res_copy_data(3http), -nng_http_res_set_data(3http), -nng_strerror(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_http_client_connect(3http), +nng_http_conn_write(3http), +http_conn_write_req(3http), +http_conn_write_res(3http), +nng_http_req_copy_data(3http), +nng_http_req_set_data(3http), +nng_http_res_copy_data(3http), +nng_http_res_set_data(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_write_req.3http.html b/man/v1.2.2/nng_http_conn_write_req.3http.html index 905f718e..3adbe478 100644 --- a/man/v1.2.2/nng_http_conn_write_req.3http.html +++ b/man/v1.2.2/nng_http_conn_write_req.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_conn_write_req(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_write_req - write HTTP request

    @@ -543,13 +56,13 @@ the HTTP request req to the connection conn. The entire request is sent, including headers, and if present, the request body data. (The request body can be set with -nng_http_req_set_data() or -nng_http_req_copy_data().)

    +nng_http_req_set_data() or +nng_http_req_copy_data().)

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

    @@ -560,8 +73,8 @@ That result will either be zero or an error code.

    Consider using the -nng_http_client_transact() or -nng_http_conn_transact() functions, +nng_http_client_transact() or +nng_http_conn_transact() functions, which provide a simpler interface for performing a complete HTTP client transaction. @@ -639,17 +152,18 @@ transaction.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_http_client_connect(3http), -nng_http_client_transact(3http), -nng_http_conn_read_all(3http), -nng_http_conn_transact(3http), -nng_strerror(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_http_client_connect(3http), +nng_http_client_transact(3http), +nng_http_conn_read_all(3http), +nng_http_conn_transact(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_conn_write_res.3http.html b/man/v1.2.2/nng_http_conn_write_res.3http.html index 89fc9b58..d100430c 100644 --- a/man/v1.2.2/nng_http_conn_write_res.3http.html +++ b/man/v1.2.2/nng_http_conn_write_res.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_conn_write_res(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_conn_write_res - write HTTP response

    @@ -547,13 +60,13 @@ the HTTP response res to the connection conn. The entire response is sent, including headers, and if present, the response body data. (The response body can be set with -nng_http_res_set_data() or -nng_http_res_copy_data().)

    +nng_http_res_set_data() or +nng_http_res_copy_data().)

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

    @@ -575,8 +88,8 @@ then the connection is immediately after sending the response.

    Consider using the -nng_http_client_transact() or -nng_http_conn_transact() functions, +nng_http_client_transact() or +nng_http_conn_transact() functions, which provide a simpler interface for performing a complete HTTP client transaction. @@ -655,17 +168,18 @@ transaction.

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_result(3), -nng_http_client_connect(3http), -nng_http_client_transact(3http), -nng_http_conn_read_all(3http), -nng_http_conn_transact(3http), -nng_strerror(3), -nng(7)

    +

    nng_aio_alloc(3), +nng_aio_result(3), +nng_http_client_connect(3http), +nng_http_client_transact(3http), +nng_http_conn_read_all(3http), +nng_http_conn_transact(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_alloc.3http.html b/man/v1.2.2/nng_http_handler_alloc.3http.html index a283d3b7..f0b28d08 100644 --- a/man/v1.2.2/nng_http_handler_alloc.3http.html +++ b/man/v1.2.2/nng_http_handler_alloc.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_alloc(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_alloc - allocate HTTP server handler

    @@ -574,14 +87,14 @@ 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 +nng_http_handler_set_method()), and optionally a 'Host' header it can be matched against (see -nng_http_handler_set_host()).

    +nng_http_handler_set_host()).

    In some cases, a handler may reference a logical tree rather (directory) rather than just a single element. -(See nng_http_handler_set_tree()).

    +(See nng_http_handler_set_tree()).

    Custom Handler

    @@ -589,11 +102,11 @@ rather than just a single element.

    The generic (first) form of this creates a handler that uses a user-supplied function to process HTTP requests. This function uses the asynchronous I/O framework. -The function takes a pointer to an nng_aio structure.

    +The function takes a pointer to an nng_aio structure.

    The aio will be passed with the following input values (retrieved with -nng_aio_get_input()):

    +nng_aio_get_input()):

    @@ -613,10 +126,10 @@ The function takes a pointer to an nng_aio

    The handler should create an nng_http_res * response (such as via -nng_http_res_alloc() or -nng_http_res_alloc_error()) and store that +nng_http_res_alloc() or +nng_http_res_alloc_error()) and store that in as the first output (index 0) with -nng_aio_set_output().

    +nng_aio_set_output().

    Alternatively, the handler may send the HTTP response (and any associated @@ -624,7 +137,7 @@ body data) itself using the connection. In that case the output at index 0 of the aio should be NULL.

    -

    Finally, using the nng_aio_finish() function, the +

    Finally, using the nng_aio_finish() function, the aio should be completed successfully. If any non-zero status is returned back to the caller instead, then a generic 500 response will be created and @@ -632,7 +145,7 @@ sent, if possible, and the connection will be closed.

    The aio may be scheduled for deferred completion using the -nng_aio_defer() function.

    +nng_aio_defer() function.

    @@ -642,7 +155,7 @@ sent, if possible, and the connection will be closed.

    @@ -702,7 +215,7 @@ URI appended.

    @@ -619,14 +132,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_del_header(3http), -nng_http_req_get_header(3http), -nng_http_req_set_header(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_del_header(3http), +nng_http_req_get_header(3http), +nng_http_req_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_alloc.3http.html b/man/v1.2.2/nng_http_req_alloc.3http.html index 4774c35d..498230e2 100644 --- a/man/v1.2.2/nng_http_req_alloc.3http.html +++ b/man/v1.2.2/nng_http_req_alloc.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_req_alloc(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_alloc - allocate HTTP request structure

    @@ -551,7 +64,7 @@ to perform an HTTP/1.1 GET operation using the URL specified in It is possible to specify NULL for the URL. In this case the URI for the request must be specified by a subsequent call -to nng_http_req_set_uri(). +to nng_http_req_set_uri().
    The callback function should NOT call -nng_aio_begin(), +nng_aio_begin(), as that will already have been done by the server framework.
    -Use nng_http_handler_set_tree() +Use nng_http_handler_set_tree() to redirect an entire tree. For example, it is possible to redirect an entire HTTP site to another HTTPS site by specifying / as the path and then using the base @@ -785,24 +298,25 @@ sent the data, with Content-Length of size bytes,

    SEE ALSO

    -

    nng_aio_defer(3), -nng_aio_finish(3), -nng_aio_get_input(3), -nng_aio_set_output(3), -nng_http_handler_collect_body(3http), -nng_http_handler_free(3http), -nng_http_handler_set_host(3http), -nng_http_handler_set_method(3http), -nng_http_handler_set_tree(3http), -nng_http_res_alloc(3http), -nng_http_res_alloc_error(3http), -nng_http_server_add_handler(3http), -nng_strerror(3), -nng_aio(5), -nng(7)

    -
    -
    - - +

    nng_aio_defer(3), +nng_aio_finish(3), +nng_aio_get_input(3), +nng_aio_set_output(3), +nng_http_handler_collect_body(3http), +nng_http_handler_free(3http), +nng_http_handler_set_host(3http), +nng_http_handler_set_method(3http), +nng_http_handler_set_tree(3http), +nng_http_res_alloc(3http), +nng_http_res_alloc_error(3http), +nng_http_server_add_handler(3http), +nng_strerror(3), +nng_aio(5), +nng(7)

    + + + + + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_collect_body.3http.html b/man/v1.2.2/nng_http_handler_collect_body.3http.html index f95be7c6..945f0f8a 100644 --- a/man/v1.2.2/nng_http_handler_collect_body.3http.html +++ b/man/v1.2.2/nng_http_handler_collect_body.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_collect_body(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_collect_body - set HTTP handler to collect request body

    @@ -543,7 +56,7 @@ it to the nng_http_req before the handler is called.

    Subsequently the data can be retrieved by the handler from the request with the -nng_http_req_get_data() function.

    +nng_http_req_get_data() function.

    The collection is enabled if want is true. @@ -637,13 +150,14 @@ create few limitations.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_free.3http.html b/man/v1.2.2/nng_http_handler_free.3http.html index 9407534f..52ba81fa 100644 --- a/man/v1.2.2/nng_http_handler_free.3http.html +++ b/man/v1.2.2/nng_http_handler_free.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_free(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_free - free HTTP server handler

    @@ -575,12 +88,13 @@ when the server itself is deallocated.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_get_data.3http.html b/man/v1.2.2/nng_http_handler_get_data.3http.html index f8736539..eb325327 100644 --- a/man/v1.2.2/nng_http_handler_get_data.3http.html +++ b/man/v1.2.2/nng_http_handler_get_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_get_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_get_data - return extra data for HTTP handler

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_handler_get_data() function returns the data previously stored on handler using the function -nng_http_handler_set_data().

    +nng_http_handler_set_data().

    @@ -563,13 +76,14 @@ stored on handler using the function

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_set_data.3http.html b/man/v1.2.2/nng_http_handler_set_data.3http.html index 2f5c2054..127cb5df 100644 --- a/man/v1.2.2/nng_http_handler_set_data.3http.html +++ b/man/v1.2.2/nng_http_handler_set_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_set_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_set_data - set extra data for HTTP handler

    @@ -541,7 +54,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_handler_set_data() function is used to set an additional data for the handler. The stored data can be retrieved later in the handler function using -nng_http_handler_get_data().

    +nng_http_handler_get_data().

    Additionally, when the handler is deallocated, if dtor is not NULL, @@ -588,13 +101,14 @@ this function is deallocate any resources associated with data.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_set_host.3http.html b/man/v1.2.2/nng_http_handler_set_host.3http.html index d6d53643..1c723c9e 100644 --- a/man/v1.2.2/nng_http_handler_set_host.3http.html +++ b/man/v1.2.2/nng_http_handler_set_host.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_set_host(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_set_host - set host for HTTP handler

    @@ -613,12 +126,13 @@ the hostname or IP address, and ignores any trailing port number.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_set_method.3http.html b/man/v1.2.2/nng_http_handler_set_method.3http.html index ff9ca3a1..ab65bdce 100644 --- a/man/v1.2.2/nng_http_handler_set_method.3http.html +++ b/man/v1.2.2/nng_http_handler_set_method.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_set_method(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_set_method - set HTTP handler method

    @@ -573,7 +86,7 @@ insist that the actual method sent over the wire be capitalized.

    The handler may always examine the actual method used using the -nng_http_req_get_method() function.

    +nng_http_req_get_method() function.

    @@ -614,13 +127,14 @@ insist that the actual method sent over the wire be capitalized.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_handler_set_tree.3http.html b/man/v1.2.2/nng_http_handler_set_tree.3http.html index c353636d..ed72faa6 100644 --- a/man/v1.2.2/nng_http_handler_set_tree.3http.html +++ b/man/v1.2.2/nng_http_handler_set_tree.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_handler_set_tree(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_handler_set_tree - set HTTP handler to match trees

    @@ -593,13 +106,14 @@ service address (path) supports dynamically generated children.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_hijack.3http.html b/man/v1.2.2/nng_http_hijack.3http.html index 4515f4df..3aace524 100644 --- a/man/v1.2.2/nng_http_hijack.3http.html +++ b/man/v1.2.2/nng_http_hijack.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_hijack(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_hijack - hijack HTTP server connection

    @@ -548,7 +61,7 @@ some other purpose, and should not be used any further by the server.

    This function is most useful when called from a handler function. -(See nng_http_handler_alloc().)

    +(See nng_http_handler_alloc().)

    @@ -561,7 +74,7 @@ It is the responsibility of the caller to dispose of the underlying connection when it is no longer needed. Furthermore, the HTTP server will no longer send any responses to the hijacked connection, so the caller should do that as well if appropriate. -(See nng_http_conn_write_res().) +(See nng_http_conn_write_res().)
    @@ -627,13 +140,14 @@ Most applications will never need to use this function.

    SEE ALSO

    -

    nng_strerror(3), -nng_http_conn_write_res(3http), -nng_http_handler_alloc(3http), -nng(7)

    +

    nng_strerror(3), +nng_http_conn_write_res(3http), +nng_http_handler_alloc(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_add_header.3http.html b/man/v1.2.2/nng_http_req_add_header.3http.html index c7d672eb..245c0fc1 100644 --- a/man/v1.2.2/nng_http_req_add_header.3http.html +++ b/man/v1.2.2/nng_http_req_add_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_add_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_add_header - add HTTP request header

    @@ -568,7 +81,7 @@ identically to a single header with multiple comma-delimited values.     		-See nng_http_req_set_header() if +See nng_http_req_set_header() if replacement of an existing header rather than appending to it is desired.
    @@ -595,28 +108,29 @@ to nng_http_req_set_uri()SEE ALSO
    -

    nng_http_conn_read_req(3http), -nng_http_conn_write_req(3http), -nng_http_req_add_header(3http), -nng_http_req_copy_data(3http), -nng_http_req_del_header(3http), -nng_http_req_free(3http), -nng_http_req_get_header(3http), -nng_http_req_get_method(3http), -nng_http_req_get_uri(3http), -nng_http_req_get_version(3http), -nng_http_req_reset(3http), -nng_http_req_set_data(3http), -nng_http_req_set_method(3http), -nng_http_req_set_uri(3http), -nng_http_req_set_version(3http), -nng_http_res_alloc(3http), -nng_url_parse(3) -nng_strerror(3), -nng(7)

    -
    -
    -
    -
    +

    nng_http_conn_read_req(3http), +nng_http_conn_write_req(3http), +nng_http_req_add_header(3http), +nng_http_req_copy_data(3http), +nng_http_req_del_header(3http), +nng_http_req_free(3http), +nng_http_req_get_header(3http), +nng_http_req_get_method(3http), +nng_http_req_get_uri(3http), +nng_http_req_get_version(3http), +nng_http_req_reset(3http), +nng_http_req_set_data(3http), +nng_http_req_set_method(3http), +nng_http_req_set_uri(3http), +nng_http_req_set_version(3http), +nng_http_res_alloc(3http), +nng_url_parse(3) +nng_strerror(3), +nng(7)

    + + + + + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_copy_data.3http.html b/man/v1.2.2/nng_http_req_copy_data.3http.html index 79a6b30f..d31c0c02 100644 --- a/man/v1.2.2/nng_http_req_copy_data.3http.html +++ b/man/v1.2.2/nng_http_req_copy_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_copy_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_copy_data - copy HTTP request body

    @@ -543,7 +56,7 @@ The copy will be deallocated automatically when req is freed.

    The copied body data will be automatically sent with the request when it -is sent using nng_http_conn_write_req().

    +is sent using nng_http_conn_write_req().

    This also updates the relevant Content-Length header of req.

    @@ -569,7 +82,7 @@ transfer-encoding. To avoid copying data, the -nng_http_req_set_data() may be used instead. +nng_http_req_set_data() may be used instead. @@ -625,14 +138,15 @@ It is a good idea to also set the Content-Type header.

    SEE ALSO

    -

    nng_http_conn_write_req(3http), -nng_http_req_alloc(3http), -nng_http_req_set_data(3http), -nng_http_req_set_header(3http), -nng(7)

    +

    nng_http_conn_write_req(3http), +nng_http_req_alloc(3http), +nng_http_req_set_data(3http), +nng_http_req_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_del_header.3http.html b/man/v1.2.2/nng_http_req_del_header.3http.html index 6a7992ff..6fdbcc29 100644 --- a/man/v1.2.2/nng_http_req_del_header.3http.html +++ b/man/v1.2.2/nng_http_req_del_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_del_header - delete HTTP request header

    @@ -585,14 +98,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_add_header(3http), -nng_http_req_del_header(3http), -nng_http_req_get_header(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_add_header(3http), +nng_http_req_del_header(3http), +nng_http_req_get_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_free.3http.html b/man/v1.2.2/nng_http_req_free.3http.html index a96d36f2..4cb66d67 100644 --- a/man/v1.2.2/nng_http_req_free.3http.html +++ b/man/v1.2.2/nng_http_req_free.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_free(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_free - free HTTP request structure

    @@ -548,7 +61,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b Instead of freeing and reallocating request structures, it is possible -to reuse req with nng_http_req_reset(). +to reuse req with nng_http_req_reset(). @@ -575,12 +88,13 @@ to reuse req with nng_ht

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_reset(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_reset(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_get_data.3http.html b/man/v1.2.2/nng_http_req_get_data.3http.html index 65b91100..1fb2d87c 100644 --- a/man/v1.2.2/nng_http_req_get_data.3http.html +++ b/man/v1.2.2/nng_http_req_get_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_get_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_get_data - get HTTP request body

    @@ -577,13 +90,14 @@ when the request is freed.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_copy_data(3http), -nng_http_req_copy_data(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_copy_data(3http), +nng_http_req_copy_data(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_get_header.3http.html b/man/v1.2.2/nng_http_req_get_header.3http.html index a7c4474c..a039dcdd 100644 --- a/man/v1.2.2/nng_http_req_get_header.3http.html +++ b/man/v1.2.2/nng_http_req_get_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_get_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_get_header - return HTTP request header

    @@ -569,13 +82,14 @@ equivalent, whereas the value Host: will not find anything.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_add_header(3http), -nng_http_req_set_header(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_add_header(3http), +nng_http_req_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_get_method.3http.html b/man/v1.2.2/nng_http_req_get_method.3http.html index a7645fa1..3129f8c3 100644 --- a/man/v1.2.2/nng_http_req_get_method.3http.html +++ b/man/v1.2.2/nng_http_req_get_method.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_get_method(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_get_method - return HTTP request method

    @@ -563,12 +76,13 @@ The value will be a string, such as "GET" or "POST".

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_get_uri.3http.html b/man/v1.2.2/nng_http_req_get_uri.3http.html index 5ba330fb..709f887f 100644 --- a/man/v1.2.2/nng_http_req_get_uri.3http.html +++ b/man/v1.2.2/nng_http_req_get_uri.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_get_method(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_get_uri - return HTTP request URI

    @@ -565,12 +78,13 @@ with those optional components appended, such as /api/get_info.cgi?name=ga

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_get_version.3http.html b/man/v1.2.2/nng_http_req_get_version.3http.html index a6dfa709..4fa51945 100644 --- a/man/v1.2.2/nng_http_req_get_version.3http.html +++ b/man/v1.2.2/nng_http_req_get_version.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_get_version(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_get_version - return HTTP request protocol version

    @@ -562,12 +75,13 @@ protocol version associated with the request req, such as "HTTP/1.1".SEE ALSO
    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_reset.3http.html b/man/v1.2.2/nng_http_req_reset.3http.html index 86cb93a3..e8804665 100644 --- a/man/v1.2.2/nng_http_req_reset.3http.html +++ b/man/v1.2.2/nng_http_req_reset.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_reset(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_reset - reset HTTP request structure

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_req_reset() function resets the request req so that it is just as if it had been freshly allocated with -nng_http_req_alloc() with a NULL URL.

    +nng_http_req_alloc() with a NULL URL.

    @@ -549,7 +62,7 @@ is just as if it had been freshly allocated with
    Before using this with an HTTP operation, the URI must be set using -nng_http_req_set_uri(). +nng_http_req_set_uri().
    @@ -576,12 +89,13 @@ Before using this with an HTTP operation, the URI must be set using

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_set_data.3http.html b/man/v1.2.2/nng_http_req_set_data.3http.html index 9e9a0519..199841da 100644 --- a/man/v1.2.2/nng_http_req_set_data.3http.html +++ b/man/v1.2.2/nng_http_req_set_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_set_data - set HTTP request body

    @@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_req_set_data() sets the HTTP body associated with the request req to body, and the size of the body to size. This body data will be automatically sent with the request when it -is sent using nng_http_conn_write_req().

    +is sent using nng_http_conn_write_req().

    This also updates the relevant Content-Length header of req.

    @@ -571,7 +84,7 @@ until the req is deallocated.

    To have a local copy allocated with req that will be automatically deallocated when req is freed, -see nng_http_req_copy_data(). +see nng_http_req_copy_data(). @@ -627,14 +140,15 @@ It is a good idea to also set the Content-Type header.

    SEE ALSO

    -

    nng_http_conn_write_req(3http), -nng_http_req_alloc(3http), -nng_http_req_copy_data(3http), -nng_http_req_set_header(3http), -nng(7)

    +

    nng_http_conn_write_req(3http), +nng_http_req_alloc(3http), +nng_http_req_copy_data(3http), +nng_http_req_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_set_header.3http.html b/man/v1.2.2/nng_http_req_set_header.3http.html index 80329200..6360e9df 100644 --- a/man/v1.2.2/nng_http_req_set_header.3http.html +++ b/man/v1.2.2/nng_http_req_set_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_set_header - set HTTP request header

    @@ -550,7 +63,7 @@ Any previous header with the same key is replaced.

    -See nng_http_req_add_header() to +See nng_http_req_add_header() to add additional headers with the same key without replacing them. @@ -601,14 +114,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_add_header(3http), -nng_http_req_del_header(3http), -nng_http_req_get_header(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_add_header(3http), +nng_http_req_del_header(3http), +nng_http_req_get_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_set_method.3http.html b/man/v1.2.2/nng_http_req_set_method.3http.html index 0880499d..2f251905 100644 --- a/man/v1.2.2/nng_http_req_set_method.3http.html +++ b/man/v1.2.2/nng_http_req_set_method.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_method(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_set_method - set HTTP request method

    @@ -587,12 +100,13 @@ be upper case.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_set_uri.3http.html b/man/v1.2.2/nng_http_req_set_uri.3http.html index 9b98b4f3..7d92c56f 100644 --- a/man/v1.2.2/nng_http_req_set_uri.3http.html +++ b/man/v1.2.2/nng_http_req_set_uri.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_uri(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_set_uri - set HTTP request URI

    @@ -565,7 +78,7 @@ No validation or canonicalization of the uri is performed. -The nng_url_parse() function can be used to +The nng_url_parse() function can be used to perform validation and canonicalization. The u_requri member will contain a suitable value that can be used with this function. @@ -612,13 +125,14 @@ contain a suitable value that can be used with this function.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_get_uri(3http), -nng_url_parse(3), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_get_uri(3http), +nng_url_parse(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_req_set_version.3http.html b/man/v1.2.2/nng_http_req_set_version.3http.html index 0f62c3fd..ab7dd1e2 100644 --- a/man/v1.2.2/nng_http_req_set_version.3http.html +++ b/man/v1.2.2/nng_http_req_set_version.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_req_set_version(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_req_set_version - set HTTP request protocol version

    @@ -611,12 +124,13 @@ Specifying any other version may result in unspecified behavior.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_add_header.3http.html b/man/v1.2.2/nng_http_res_add_header.3http.html index ae94d16f..7438ba75 100644 --- a/man/v1.2.2/nng_http_res_add_header.3http.html +++ b/man/v1.2.2/nng_http_res_add_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_add_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_add_header - add HTTP response header

    @@ -569,7 +82,7 @@ identically to a single header with multiple comma-delimited values. -See nng_http_res_set_header() if +See nng_http_res_set_header() if replacement of an existing header rather than appending to it is desired. @@ -619,14 +132,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_del_header(3http), -nng_http_res_get_header(3http), -nng_http_res_set_header(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_del_header(3http), +nng_http_res_get_header(3http), +nng_http_res_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_alloc.3http.html b/man/v1.2.2/nng_http_res_alloc.3http.html index 7f2e444c..e69c8111 100644 --- a/man/v1.2.2/nng_http_res_alloc.3http.html +++ b/man/v1.2.2/nng_http_res_alloc.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_alloc(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_alloc - allocate HTTP response structure

    @@ -551,7 +64,7 @@ and HTTP protocol version `"HTTP/1.1`".

    When an error response is needed, consider using -nng_http_res_alloc_error() instead. +nng_http_res_alloc_error() instead. @@ -595,28 +108,29 @@ When an error response is needed, consider using

    SEE ALSO

    -

    nng_http_conn_read_res(3http), -nng_http_conn_write_res(3http), -nng_http_req_alloc(3http), -nng_http_res_alloc_error(3http), -nng_http_res_add_header(3http), -nng_http_res_copy_data(3http), -nng_http_res_del_header(3http), -nng_http_res_free(3http), -nng_http_res_get_header(3http), -nng_http_res_get_reason(3http), -nng_http_res_get_status(3http), -nng_http_res_get_version(3http), -nng_http_res_reset(3http), -nng_http_res_set_data(3http), -nng_http_res_set_reason(3http), -nng_http_res_set_status(3http), -nng_http_res_set_version(3http), -nng_strerror(3), -nng(7)

    -
    -
    - - +

    nng_http_conn_read_res(3http), +nng_http_conn_write_res(3http), +nng_http_req_alloc(3http), +nng_http_res_alloc_error(3http), +nng_http_res_add_header(3http), +nng_http_res_copy_data(3http), +nng_http_res_del_header(3http), +nng_http_res_free(3http), +nng_http_res_get_header(3http), +nng_http_res_get_reason(3http), +nng_http_res_get_status(3http), +nng_http_res_get_version(3http), +nng_http_res_reset(3http), +nng_http_res_set_data(3http), +nng_http_res_set_reason(3http), +nng_http_res_set_status(3http), +nng_http_res_set_version(3http), +nng_strerror(3), +nng(7)

    + + + + + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_alloc_error.3http.html b/man/v1.2.2/nng_http_res_alloc_error.3http.html index b039b760..7af5f210 100644 --- a/man/v1.2.2/nng_http_res_alloc_error.3http.html +++ b/man/v1.2.2/nng_http_res_alloc_error.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_alloc_error(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_alloc_error - allocate HTTP error response

    @@ -598,15 +111,16 @@ This is the simplest way to generate an error response.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_free(3http), -nng_http_res_set_reason(3http), -nng_http_res_set_status(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_free(3http), +nng_http_res_set_reason(3http), +nng_http_res_set_status(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_copy_data.3http.html b/man/v1.2.2/nng_http_res_copy_data.3http.html index 89381083..69e18a44 100644 --- a/man/v1.2.2/nng_http_res_copy_data.3http.html +++ b/man/v1.2.2/nng_http_res_copy_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_copy_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_copy_data - copy HTTP response body

    @@ -543,7 +56,7 @@ The copy will be deallocated automatically when res is freed.

    The copied body data will be automatically sent with the response when it -is sent using nng_http_conn_write_res().

    +is sent using nng_http_conn_write_res().

    This also updates the relevant Content-Length header of res.

    @@ -569,7 +82,7 @@ transfer-encoding. To avoid copying data, the -nng_http_res_set_data() may be used instead. +nng_http_res_set_data() may be used instead. @@ -625,14 +138,15 @@ It is a good idea to also set the Content-Type header.

    SEE ALSO

    -

    nng_http_conn_write_res(3http), -nng_http_res_alloc(3http), -nng_http_res_set_data(3http), -nng_http_res_set_header(3http), -nng(7)

    +

    nng_http_conn_write_res(3http), +nng_http_res_alloc(3http), +nng_http_res_set_data(3http), +nng_http_res_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_del_header.3http.html b/man/v1.2.2/nng_http_res_del_header.3http.html index aae9a77d..39e5e696 100644 --- a/man/v1.2.2/nng_http_res_del_header.3http.html +++ b/man/v1.2.2/nng_http_res_del_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_set_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_header - set HTTP response header

    @@ -584,14 +97,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_add_header(3http), -nng_http_res_del_header(3http), -nng_http_res_get_header(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_add_header(3http), +nng_http_res_del_header(3http), +nng_http_res_get_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_free.3http.html b/man/v1.2.2/nng_http_res_free.3http.html index c2fc9377..aaf27cf8 100644 --- a/man/v1.2.2/nng_http_res_free.3http.html +++ b/man/v1.2.2/nng_http_res_free.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_free(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_free - free HTTP response structure

    @@ -548,7 +61,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b Instead of freeing and reallocating response structures, it is possible -to reuse res with nng_http_res_reset(). +to reuse res with nng_http_res_reset(). @@ -575,12 +88,13 @@ to reuse res with nng_ht

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_reset(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_reset(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_get_data.3http.html b/man/v1.2.2/nng_http_res_get_data.3http.html index 682fdceb..ccc00a67 100644 --- a/man/v1.2.2/nng_http_res_get_data.3http.html +++ b/man/v1.2.2/nng_http_res_get_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_get_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_get_data - get HTTP response body

    @@ -577,13 +90,14 @@ when the request is freed.

    SEE ALSO

    -

    nng_http_req_alloc(3http), -nng_http_req_copy_data(3http), -nng_http_req_copy_data(3http), -nng(7)

    +

    nng_http_req_alloc(3http), +nng_http_req_copy_data(3http), +nng_http_req_copy_data(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_get_header.3http.html b/man/v1.2.2/nng_http_res_get_header.3http.html index 8ff96126..f5a19967 100644 --- a/man/v1.2.2/nng_http_res_get_header.3http.html +++ b/man/v1.2.2/nng_http_res_get_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_get_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_get_header - return HTTP response header

    @@ -569,13 +82,14 @@ equivalent, whereas the value Host: will not find anything.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_add_header(3http), -nng_http_res_set_header(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_add_header(3http), +nng_http_res_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_get_reason.3http.html b/man/v1.2.2/nng_http_res_get_reason.3http.html index 0e851138..9fd757fa 100644 --- a/man/v1.2.2/nng_http_res_get_reason.3http.html +++ b/man/v1.2.2/nng_http_res_get_reason.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_get_reason(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_get_reason - return HTTP response reason

    @@ -541,7 +54,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b “reason phrase” associated with the response res. This is a human-readable explanation of the status code that would be obtained from -nng_http_res_get_status().

    +nng_http_res_get_status().

    @@ -565,13 +78,14 @@ would be obtained from

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_get_status(3http), -nng_http_res_set_reason(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_get_status(3http), +nng_http_res_set_reason(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_get_status.3http.html b/man/v1.2.2/nng_http_res_get_status.3http.html index a3cdc69d..fc1af623 100644 --- a/man/v1.2.2/nng_http_res_get_status.3http.html +++ b/man/v1.2.2/nng_http_res_get_status.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_get_status(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_get_status - return HTTP status code

    @@ -618,7 +131,7 @@ HTTP status codes are available.

    When displaying status information to users (or logging such information), consider also including the “reason phrase” obtained with -nng_http_res_get_reason(). +nng_http_res_get_reason(). @@ -645,13 +158,14 @@ consider also including the “reason phrase” obtained with

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_get_reason(3http), -nng_http_res_set_status(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_get_reason(3http), +nng_http_res_set_status(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_get_version.3http.html b/man/v1.2.2/nng_http_res_get_version.3http.html index 76b067c4..ad9b4988 100644 --- a/man/v1.2.2/nng_http_res_get_version.3http.html +++ b/man/v1.2.2/nng_http_res_get_version.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_get_version(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_get_version - return HTTP response protocol version

    @@ -562,12 +75,13 @@ protocol version associated with the request res, such as "HTTP/1.1".SEE ALSO
    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_reset.3http.html b/man/v1.2.2/nng_http_res_reset.3http.html index d654b217..323a3d8f 100644 --- a/man/v1.2.2/nng_http_res_reset.3http.html +++ b/man/v1.2.2/nng_http_res_reset.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_reset(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_reset - reset HTTP response structure

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_res_reset() function resets the response res so that it is just as if it had been freshly allocated with -nng_http_res_alloc().

    +nng_http_res_alloc().

    @@ -563,11 +76,12 @@ is just as if it had been freshly allocated with

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_set_data.3http.html b/man/v1.2.2/nng_http_res_set_data.3http.html index f82a9320..4279af60 100644 --- a/man/v1.2.2/nng_http_res_set_data.3http.html +++ b/man/v1.2.2/nng_http_res_set_data.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_set_data(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_data - set HTTP response body

    @@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_res_set_data() sets the HTTP body associated with the response res to body, and the size of the body to size. This body data will be automatically sent with the response when it -is sent using nng_http_conn_write_res().

    +is sent using nng_http_conn_write_res().

    This also updates the relevant Content-Length header of res.

    @@ -571,7 +84,7 @@ until the res is deallocated.

    To have a local copy allocated with res that will be automatically deallocated when res is freed, -see nng_http_res_copy_data(). +see nng_http_res_copy_data(). @@ -627,14 +140,15 @@ It is a good idea to also set the Content-Type header.

    SEE ALSO

    -

    nng_http_conn_write_res(3http), -nng_http_res_alloc(3http), -nng_http_res_copy_data(3http), -nng_http_res_set_header(3http), -nng(7)

    +

    nng_http_conn_write_res(3http), +nng_http_res_alloc(3http), +nng_http_res_copy_data(3http), +nng_http_res_set_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_set_header.3http.html b/man/v1.2.2/nng_http_res_set_header.3http.html index 4429bbea..8bbafc38 100644 --- a/man/v1.2.2/nng_http_res_set_header.3http.html +++ b/man/v1.2.2/nng_http_res_set_header.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_set_header(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_header - set HTTP response header

    @@ -550,7 +63,7 @@ Any previous header with the same key is replaced.

    -See nng_http_res_add_header() to +See nng_http_res_add_header() to add additional headers with the same key without replacing them. @@ -601,14 +114,15 @@ equivalent, whereas the value Host: is not a legal header key.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_res_add_header(3http), -nng_http_res_del_header(3http), -nng_http_res_get_header(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_res_add_header(3http), +nng_http_res_del_header(3http), +nng_http_res_get_header(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_set_reason.3http.html b/man/v1.2.2/nng_http_res_set_reason.3http.html index bdae8766..b937897d 100644 --- a/man/v1.2.2/nng_http_res_set_reason.3http.html +++ b/man/v1.2.2/nng_http_res_set_reason.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_res_set_reason(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_reason - set HTTP response reason

    @@ -543,7 +56,7 @@ associated with the response res to reason.

    If the value of reason is NULL (the default), then a default reason phrase is supplied based upon the value of the status code (see -nng_http_res_set_status()).

    +nng_http_res_set_status()).

    @@ -600,13 +113,14 @@ The reason is never parsed automatically, but it can be a hint for huma

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_req_get_reason(3http), -nng_http_req_set_status(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_req_get_reason(3http), +nng_http_req_set_status(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_set_status.3http.html b/man/v1.2.2/nng_http_res_set_status.3http.html index f49fd8f7..fd68c970 100644 --- a/man/v1.2.2/nng_http_res_set_status.3http.html +++ b/man/v1.2.2/nng_http_res_set_status.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_res_set_status(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_status - set HTTP response status

    @@ -625,7 +138,7 @@ use of these status codes.

    @@ -662,13 +175,14 @@ This will help any humans who may have to diagnose a failure.

    SEE ALSO

    -

    nng_http_res_alloc(3http), -nng_http_req_get_status(3http), -nng_http_req_set_reason(3http), -nng(7)

    +

    nng_http_res_alloc(3http), +nng_http_req_get_status(3http), +nng_http_req_set_reason(3http), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_res_set_version.3http.html b/man/v1.2.2/nng_http_res_set_version.3http.html index 0f0aa79c..7efba794 100644 --- a/man/v1.2.2/nng_http_res_set_version.3http.html +++ b/man/v1.2.2/nng_http_res_set_version.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_res_set_version(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_res_set_version - set HTTP response protocol version

    @@ -611,12 +124,13 @@ Specifying any other version may result in unspecified behavior.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_add_handler.3http.html b/man/v1.2.2/nng_http_server_add_handler.3http.html index a7237bdb..26324251 100644 --- a/man/v1.2.2/nng_http_server_add_handler.3http.html +++ b/man/v1.2.2/nng_http_server_add_handler.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_add_handler(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_add_handler - add HTTP server handler

    @@ -550,7 +63,7 @@ deallocated, the handler and any of its resources will also be deallocated.

    Handlers that are added to a server may be subsequently removed using the -nng_http_server_del_handler() function.

    +nng_http_server_del_handler() function.

    @@ -599,14 +112,15 @@ deallocated, the handler and any of its resources will also be deallocated.

    SEE ALSO

    -

    nng_http_handler_alloc(3http), -nng_http_server_del_handler(3http), -nng_http_server_hold(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_handler_alloc(3http), +nng_http_server_del_handler(3http), +nng_http_server_hold(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_del_handler.3http.html b/man/v1.2.2/nng_http_server_del_handler.3http.html index a1179a5e..9605521a 100644 --- a/man/v1.2.2/nng_http_server_del_handler.3http.html +++ b/man/v1.2.2/nng_http_server_del_handler.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_del_handler(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_del_handler - delete HTTP server handler

    @@ -583,13 +96,14 @@ of the caller to dispose of the handler, or add it to another server instance.SEE ALSO
    -

    nng_http_handler_free(3http), -nng_http_server_add_handler(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_handler_free(3http), +nng_http_server_add_handler(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_get_tls.3http.html b/man/v1.2.2/nng_http_server_get_tls.3http.html index 21c3efd9..dca3d684 100644 --- a/man/v1.2.2/nng_http_server_get_tls.3http.html +++ b/man/v1.2.2/nng_http_server_get_tls.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_get_tls(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_get_tls - get HTTP server TLS configuration

    @@ -542,10 +55,10 @@ saves a pointer to it in the address referenced by cfgp.

    The object will be returned with an extra hold (see -nng_tls_config_hold()) +nng_tls_config_hold()) placed on it on behalf of the caller. The caller should free this hold by calling -nng_tls_config_free() with it is done +nng_tls_config_free() with it is done with the TLS configuration.

    @@ -595,17 +108,18 @@ with the TLS configuration.

    SEE ALSO

    -

    nng_http_server_hold(3http), -nng_http_server_set_tls(3http), -nng_http_server_start(3http), -nng_tls_config_alloc(3tls), -nng_tls_config_free(3tls), -nng_tls_config_hold(3tls), -nng_strerror(3), -nng(7)

    +

    nng_http_server_hold(3http), +nng_http_server_set_tls(3http), +nng_http_server_start(3http), +nng_tls_config_alloc(3tls), +nng_tls_config_free(3tls), +nng_tls_config_hold(3tls), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_hold.3http.html b/man/v1.2.2/nng_http_server_hold.3http.html index 9db439a6..371f53c7 100644 --- a/man/v1.2.2/nng_http_server_hold.3http.html +++ b/man/v1.2.2/nng_http_server_hold.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_hold(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_hold - get and hold HTTP server instance

    @@ -551,7 +64,7 @@ with an initial reference count of one (1).

    The server instance is not started, and can have additional configuration applied to it before it is later started with -nng_http_server_start().

    +nng_http_server_start().

    It is a good idea to also set the “reason phrase” with -nng_http_set_reason(). +nng_http_set_reason(). This will help any humans who may have to diagnose a failure.
    @@ -608,15 +121,16 @@ It is recommended to use canonical IP addresses or names in the

    SEE ALSO

    -

    nng_http_server_add_handler(3http), -nng_http_server_release(3http), -nng_http_server_stop(3http), -nng_url_parse(3) -nng_strerror(3), -nng(7)

    +

    nng_http_server_add_handler(3http), +nng_http_server_release(3http), +nng_http_server_stop(3http), +nng_url_parse(3) +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_release.3http.html b/man/v1.2.2/nng_http_server_release.3http.html index 6407cef6..0a7cb8ef 100644 --- a/man/v1.2.2/nng_http_server_release.3http.html +++ b/man/v1.2.2/nng_http_server_release.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_release(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_release - release HTTP server instance

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_server_release() releases an instance of an HTTP server that was previously held with -nng_http_server_hold().

    +nng_http_server_hold().

    This effectively drops the reference count on the server instance. When @@ -583,12 +96,13 @@ times than it has been held.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_res_error.3http.html b/man/v1.2.2/nng_http_server_res_error.3http.html index c140a69a..29cd4196 100644 --- a/man/v1.2.2/nng_http_server_res_error.3http.html +++ b/man/v1.2.2/nng_http_server_res_error.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_res_error(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_res_error - use HTTP server error page

    @@ -540,17 +53,17 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_server_res_error() sets the body of response to server's error page, which may have been customized using the -nng_http_server_error_file() +nng_http_server_error_file() or -nng_http_server_error_page() +nng_http_server_error_page() functions.

    The status code of the response should have already been set, either implicitly by allocating it with -nng_http_res_alloc_error(), +nng_http_res_alloc_error(), or by calling -nng_http_res_set_status().

    +nng_http_res_set_status().

    Any content body previously set for response will be overridden by @@ -595,15 +108,16 @@ this function.

    SEE ALSO

    -

    nng_http_res_alloc_error(3http), -nng_http_server_hold(3http), -nng_http_server_set_error_file(3http), -nng_http_server_set_error_page(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_res_alloc_error(3http), +nng_http_server_hold(3http), +nng_http_server_set_error_file(3http), +nng_http_server_set_error_page(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_set_error_file.3http.html b/man/v1.2.2/nng_http_server_set_error_file.3http.html index 6179f84b..9ad21501 100644 --- a/man/v1.2.2/nng_http_server_set_error_file.3http.html +++ b/man/v1.2.2/nng_http_server_set_error_file.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_set_error_file(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_set_error_file - set custom HTTP error file

    @@ -547,10 +60,10 @@ the file located at path, which should be an HTML file.

    The custom HTML content will be used when the server is returning an internally generated error response, or is returning an error response that was allocated with the -nng_http_res_alloc_error() +nng_http_res_alloc_error() function. This HTML content will also be used if the application calls the -nng_http_server_res_error(). +nng_http_server_res_error(). The last custom error page set for code by either this function or xref:`nng_http_server_set_error_page.3http.adoc[nng_http_server_error_page()] will be used.

    @@ -638,15 +151,16 @@ be called again to update the error page.

    SEE ALSO

    -

    nng_http_res_alloc_error(3http), -nng_http_server_hold(3http), -nng_http_server_res_error(3http), -nng_http_server_set_error_page(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_res_alloc_error(3http), +nng_http_server_hold(3http), +nng_http_server_res_error(3http), +nng_http_server_set_error_page(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_set_error_page.3http.html b/man/v1.2.2/nng_http_server_set_error_page.3http.html index bc2a7dda..df3d99d5 100644 --- a/man/v1.2.2/nng_http_server_set_error_page.3http.html +++ b/man/v1.2.2/nng_http_server_set_error_page.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_set_error_page(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_set_error_page - set custom HTTP error page

    @@ -546,12 +59,12 @@ The body content of the HTTP responses will contain html.

    The custom HTML content will be used when the server is returning an internally generated error response, or is returning an error response that was allocated with the -nng_http_res_alloc_error() +nng_http_res_alloc_error() function. This HTML content will also be used if the application calls the -nng_http_server_res_error(). +nng_http_server_res_error(). The last custom error page set for code by either this function or -nng_http_server_error_file() +nng_http_server_error_file() will be used.

    @@ -611,15 +124,16 @@ after this function returns.

    SEE ALSO

    -

    nng_http_res_alloc_error(3http), -nng_http_server_hold(3http), -nng_http_server_res_error(3http), -nng_http_server_set_error_file(3http), -nng_strerror(3), -nng(7)

    +

    nng_http_res_alloc_error(3http), +nng_http_server_hold(3http), +nng_http_server_res_error(3http), +nng_http_server_set_error_file(3http), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_set_tls.3http.html b/man/v1.2.2/nng_http_server_set_tls.3http.html index 099f3348..32ebf8ce 100644 --- a/man/v1.2.2/nng_http_server_set_tls.3http.html +++ b/man/v1.2.2/nng_http_server_set_tls.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_http_server_set_tls(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_set_tls - set HTTP server TLS configuration

    @@ -551,14 +64,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    This also invalidates any previously obtained values from -nng_http_server_get_tls(). +nng_http_server_get_tls().

    If the server is already running (i.e. it has been started with -nng_http_server_start()) then this will +nng_http_server_start()) then this will fail with NNG_EBUSY.

    @@ -569,7 +82,7 @@ fail with NNG_EBUSY.

    Generally, the cfg must have a configured private key, set with -nng_tls_config_own_cert() or similar. +nng_tls_config_own_cert() or similar. @@ -621,15 +134,16 @@ Generally, the cfg must have a configured private key, set with

    SEE ALSO

    -

    nng_http_server_get_tls(3http), -nng_http_server_hold(3http), -nng_http_server_start(3http), -nng_tls_config_alloc(3tls), -nng_strerror(3), -nng(7)

    +

    nng_http_server_get_tls(3http), +nng_http_server_hold(3http), +nng_http_server_start(3http), +nng_tls_config_alloc(3tls), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_start.3http.html b/man/v1.2.2/nng_http_server_start.3http.html index 5489c43e..00049795 100644 --- a/man/v1.2.2/nng_http_server_start.3http.html +++ b/man/v1.2.2/nng_http_server_start.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_server_start(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_start - start HTTP server

    @@ -596,15 +109,16 @@ connections and handling HTTP requests.

    SEE ALSO

    -

    nng_http_server_hold(3http), -nng_http_server_release(3http), -nng_http_server_stop(3http), -nng_url_parse(3) -nng_strerror(3), -nng(7)

    +

    nng_http_server_hold(3http), +nng_http_server_release(3http), +nng_http_server_stop(3http), +nng_url_parse(3) +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_http_server_stop.3http.html b/man/v1.2.2/nng_http_server_stop.3http.html index 7adab183..7a6acac2 100644 --- a/man/v1.2.2/nng_http_server_stop.3http.html +++ b/man/v1.2.2/nng_http_server_stop.3http.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_http_server_stop(3http) - - - + + -

    NAME

    +

    NAME

    nng_http_server_stop - stop HTTP server

    @@ -538,11 +51,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_http_server_stop() undoes the effect of -nng_http_server_start().

    +nng_http_server_start().

    Each call by -nng_http_server_start() acts as reference +nng_http_server_start() acts as reference count, and should be matched by a call to nng_http_server_stop(). When the reference count drops to zero, then the server is actually stopped, and existing open connections to it are closed.

    @@ -558,10 +71,10 @@ and existing open connections to it are closed.

    Once the server instance is actually stopped, it cannot be started again, -and any future calls to nng_http_server_hold() +and any future calls to nng_http_server_hold() will return a new instance of the server. It is expected that the caller will follow this function call with a call to -nng_http_server_release(). +nng_http_server_release(). @@ -588,13 +101,14 @@ It is expected that the caller will follow this function call with a call to

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_inproc.7.html b/man/v1.2.2/nng_inproc.7.html index 673e9c54..282d34a6 100644 --- a/man/v1.2.2/nng_inproc.7.html +++ b/man/v1.2.2/nng_inproc.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_inproc(7) - - - + + -

    NAME

    +

    NAME

    nng_inproc - intra-process transport

    @@ -579,9 +92,9 @@ that URI.

    Socket Address

    -

    When using an nng_sockaddr structure, +

    When using an nng_sockaddr structure, the actual structure is of type -nng_sockaddr_inproc.

    +nng_sockaddr_inproc.

    @@ -612,12 +125,13 @@ and thus it makes no sense to spend cycles protecting a program from itself.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_inproc_register.3.html b/man/v1.2.2/nng_inproc_register.3.html index 6baa1429..5ff2e5ea 100644 --- a/man/v1.2.2/nng_inproc_register.3.html +++ b/man/v1.2.2/nng_inproc_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_inproc_register(3) - - - + + -

    NAME

    +

    NAME

    nng_inproc_register - register inproc transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_inproc(5), -nng(7)

    +

    nng_inproc(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_iov.5.html b/man/v1.2.2/nng_iov.5.html index e18b7b74..2b6f7703 100644 --- a/man/v1.2.2/nng_iov.5.html +++ b/man/v1.2.2/nng_iov.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_iov(5) - - - + + -

    NAME

    +

    NAME

    nng_iov - scatter/gather element

    @@ -546,8 +59,8 @@ one part of memory, and a user payload from another.

    The operations that do this typically store an array of these in -an nng_aio structure using the -nng_aio_set_iov() function.

    +an nng_aio structure using the +nng_aio_set_iov() function.

    The following structure members are present:

    @@ -571,12 +84,13 @@ referenced by this scatter/gather element.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ipc.7.html b/man/v1.2.2/nng_ipc.7.html index b2e99930..4bb41e95 100644 --- a/man/v1.2.2/nng_ipc.7.html +++ b/man/v1.2.2/nng_ipc.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ipc(7) - - - + + -

    NAME

    +

    NAME

    nng_ipc - IPC transport

    @@ -615,8 +128,8 @@ longer than 128 bytes, including the ipc:// prefix.

    Socket Address

    -

    When using an nng_sockaddr structure, -the actual structure is of type nng_sockaddr_ipc.

    +

    When using an nng_sockaddr structure, +the actual structure is of type nng_sockaddr_ipc.

    @@ -663,13 +176,14 @@ where supported by the underlying platform.

    SEE ALSO

    -

    nng_sockaddr(5), -nng_ipc_options(5), -nng_options(5), -nng(7)

    +

    nng_sockaddr(5), +nng_ipc_options(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ipc_options.5.html b/man/v1.2.2/nng_ipc_options.5.html index 1e8ef07e..91f106ea 100644 --- a/man/v1.2.2/nng_ipc_options.5.html +++ b/man/v1.2.2/nng_ipc_options.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ipc_options(5) - - - + + -

    NAME

    +

    NAME

    nng_ipc_options - IPC-specific options

    @@ -726,17 +239,18 @@ when appropriate for the context:

    SEE ALSO

    -

    nng_ipc_dialer_getopt(3ipc), -nng_ipc_dialer_setopt(3ipc), -nng_ipc_getopt(3ipc), -nng_ipc_listener_getopt(3ipc), -nng_ipc_listener_setopt(3ipc), -nng_ipc_setopt(3ipc), -nng_options(5) -nng(7)

    +

    nng_ipc_dialer_getopt(3ipc), +nng_ipc_dialer_setopt(3ipc), +nng_ipc_getopt(3ipc), +nng_ipc_listener_getopt(3ipc), +nng_ipc_listener_setopt(3ipc), +nng_ipc_setopt(3ipc), +nng_options(5) +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ipc_register.3.html b/man/v1.2.2/nng_ipc_register.3.html index b5e21be6..b4974206 100644 --- a/man/v1.2.2/nng_ipc_register.3.html +++ b/man/v1.2.2/nng_ipc_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ipc_register(3) - - - + + -

    NAME

    +

    NAME

    nng_ipc_register - register ipc transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_ipc(5), -nng(7)

    +

    nng_ipc(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listen.3.html b/man/v1.2.2/nng_listen.3.html index ee84628c..b1870a2e 100644 --- a/man/v1.2.2/nng_listen.3.html +++ b/man/v1.2.2/nng_listen.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listen(3) - - - + + -

    NAME

    +

    NAME

    nng_listen - create and start listener

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_listen() function creates a newly initialized -nng_listener object, associated with socket s, +nng_listener object, associated with socket s, and configured to listen at the address specified by url, and starts it. If the value of lp is not NULL, then the newly created listener is stored at the address indicated by lp.

    @@ -545,7 +58,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 -nng_pipe object being created and attached to the socket s. +nng_pipe object being created and attached to the socket s. Unlike dialers, listeners generally can create many pipes, which may be open concurrently.

    @@ -562,7 +75,7 @@ pipes, which may be open concurrently.

    While it is convenient to think of listeners as “servers”, the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a req +For example, a req socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! @@ -572,8 +85,8 @@ It may even have some of each at the same time!

    Because the listener is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using nng_listener_create() and -nng_listener_start() instead.

    +using nng_listener_create() and +nng_listener_start() instead.

    The created listener will continue to accept new connections, associating @@ -642,16 +155,17 @@ their pipes with the socket, until either it or the socket s is closed.

    SEE ALSO

    -

    nng_dial(3), -nng_listener_close(3), -nng_listener_create(3) -nng_listener_start(3), -nng_strerror(3), -nng_listener(5), -nng(7)

    +

    nng_dial(3), +nng_listener_close(3), +nng_listener_create(3) +nng_listener_start(3), +nng_strerror(3), +nng_listener(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener.5.html b/man/v1.2.2/nng_listener.5.html index 9f9fe1fb..ed286110 100644 --- a/man/v1.2.2/nng_listener.5.html +++ b/man/v1.2.2/nng_listener.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener(5) - - - + + -

    NAME

    +

    NAME

    nng_listener - listener

    @@ -540,15 +53,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_listener is a handle to a “listener” object, which is responsible for -creating nng_pipe objects by accepting incoming connections. +creating nng_pipe objects by accepting incoming connections. A given listener object may create many pipes at the same time, much like an HTTP server can have many connections to multiple clients simultaneously.

    Listener objects are created by the -nng_listener_create() -or nng_listen() functions, and are always “owned” -by a single nng_socket.

    +nng_listener_create() +or nng_listen() functions, and are always “owned” +by a single nng_socket.

    @@ -572,8 +85,8 @@ accurate type checks in functions passing values of this type. @@ -588,8 +101,8 @@ of both. @@ -598,7 +111,7 @@ challenging communications problems.

    Listener objects may be destroyed by the -nng_listener_close() function. +nng_listener_close() function. They are also closed when their “owning” socket is closed.

    @@ -614,20 +127,21 @@ before it is opened, to prevent confusion with valid open listener.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_close(3), -nng_listener_create(3), -nng_listener_getopt(3), -nng_listener_id(3), -nng_listener_setopt(3), -nng_listener_start(3), -nng_dialer(5), -nng_pipe(5), -nng_socket(5), -nng(7)

    +

    nng_listen(3), +nng_listener_close(3), +nng_listener_create(3), +nng_listener_getopt(3), +nng_listener_id(3), +nng_listener_setopt(3), +nng_listener_start(3), +nng_dialer(5), +nng_pipe(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_close.3.html b/man/v1.2.2/nng_listener_close.3.html index 202c7e77..d33724c0 100644 --- a/man/v1.2.2/nng_listener_close.3.html +++ b/man/v1.2.2/nng_listener_close.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_listener_close(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_close - close listener

    @@ -581,15 +94,16 @@ is closed.

    SEE ALSO

    -

    nng_close(3), -nng_listen(3), -nng_listener_create(3) -nng_strerror(3), -nng_listener(5), -nng(7)

    +

    nng_close(3), +nng_listen(3), +nng_listener_create(3) +nng_strerror(3), +nng_listener(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_create.3.html b/man/v1.2.2/nng_listener_create.3.html index 62f598c7..65decfcc 100644 --- a/man/v1.2.2/nng_listener_create.3.html +++ b/man/v1.2.2/nng_listener_create.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_listener_create(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_create - create listener

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_listener_create() function creates a newly initialized -nng_listener object, associated with socket s, +nng_listener object, associated with socket s, and configured to listen at the address specified by url, and stores a pointer to at the location referenced by listenerp.

    @@ -558,7 +71,7 @@ which may be open concurrently.

    While it is convenient to think of listeners as “servers”, the relationship between the listener or dialer is orthogonal to any server or client status that might be associated with a given protocol. -For example, a req socket might have associated dialers, +For example, a req socket might have associated dialers, but might also have associated listeners. It may even have some of each at the same time! @@ -567,12 +80,12 @@ It may even have some of each at the same time!

    The listener is not started, but may be further configured with -the nng_listener_setopt() family of +the nng_listener_setopt() family of functions.

    Once it is fully configured, the listener may be started using the -nng_listener_start() function.

    +nng_listener_start() function.

    -A given nng_socket may have multiple listener -objects, multiple dialer objects, or even some +A given nng_socket may have multiple listener +objects, multiple dialer objects, or even some of both.
    The client/server relationship described by dialer/listener is completely orthogonal to any similar relationship in the protocols. -For example, a rep socket may use a dialer -to connect to a listener on an req socket. +For example, a rep socket may use a dialer +to connect to a listener on an req socket. This orthogonality can lead to innovative solutions to otherwise challenging communications problems.
    @@ -582,7 +95,7 @@ functions.

    If no specific configuration is required, consider using the -simpler nng_listen() function instead. +simpler nng_listen() function instead.
    @@ -634,18 +147,19 @@ simpler nng_listen() function inst

    SEE ALSO

    -

    nng_dialer_create(3) -nng_listen(3), -nng_listener_close(3), -nng_listener_getopt(3), -nng_listener_setopt(3), -nng_listener_start(3), -nng_strerror(3), -nng_listener(5), -nng(7)

    +

    nng_dialer_create(3) +nng_listen(3), +nng_listener_close(3), +nng_listener_getopt(3), +nng_listener_setopt(3), +nng_listener_start(3), +nng_strerror(3), +nng_listener(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_get.3.html b/man/v1.2.2/nng_listener_get.3.html index 12f5dafe..8b9700a9 100644 --- a/man/v1.2.2/nng_listener_get.3.html +++ b/man/v1.2.2/nng_listener_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_get(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_get - get listener option

    @@ -558,9 +71,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_listener_get() functions are used to retrieve option values for -the listener l. +the listener l. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -625,7 +138,7 @@ The value will be stored at ivalp.

    nng_listener_get_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds.

    nng_listener_get_ptr()
    @@ -642,15 +155,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_listener_get_addr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into the value referenced by sap.

    nng_listener_get_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_listener_get_uint64()
    @@ -733,21 +246,22 @@ numbers, and similar.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_create(3) -nng_listener_set(3) -nng_socket_get(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_listener(5), -nng_options(5), -nng_sockaddr(5), -nng(7)

    +

    nng_listen(3), +nng_listener_create(3) +nng_listener_set(3) +nng_socket_get(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_listener(5), +nng_options(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_getopt.3.html b/man/v1.2.2/nng_listener_getopt.3.html index 407780f2..7d749969 100644 --- a/man/v1.2.2/nng_listener_getopt.3.html +++ b/man/v1.2.2/nng_listener_getopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_getopt(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_getopt - get listener option

    @@ -562,7 +75,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_listener_get. +These functions are deprecated. Please see nng_listener_get. @@ -570,9 +83,9 @@ These functions are deprecated. Please see n

    The nng_listener_getopt() functions are used to retrieve option values for -the listener l. +the listener l. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -637,7 +150,7 @@ The value will be stored at ivalp.

    nng_listener_getopt_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds.

    nng_listener_getopt_ptr()
    @@ -654,15 +167,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_listener_getopt_sockaddr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into the value referenced by sap.

    nng_listener_getopt_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_listener_getopt_uint64()
    @@ -745,21 +258,22 @@ numbers, and similar.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_create(3) -nng_listener_setopt(3) -nng_getopt(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_listener(5), -nng_options(5), -nng_sockaddr(5), -nng(7)

    +

    nng_listen(3), +nng_listener_create(3) +nng_listener_setopt(3) +nng_getopt(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_listener(5), +nng_options(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_id.3.html b/man/v1.2.2/nng_listener_id.3.html index f309cbf9..ee138b61 100644 --- a/man/v1.2.2/nng_listener_id.3.html +++ b/man/v1.2.2/nng_listener_id.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_id(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_id - return numeric listener identifier

    @@ -548,8 +61,8 @@ Otherwise it returns -1.

    A listener is considered valid if it was ever created with the -nng_listener_create() or -nng_listen() functions. +nng_listener_create() or +nng_listen() functions. listeners that are allocated on the stack or statically should be initialized with the macro NNG_LISTENER_INITIALIZER to ensure that @@ -581,11 +94,12 @@ they cannot be confused with a valid listener before they are created properly.

    SEE ALSO

    -

    nng_listener(5), -nng(7)

    +

    nng_listener(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_set.3.html b/man/v1.2.2/nng_listener_set.3.html index ef93a359..a0eed810 100644 --- a/man/v1.2.2/nng_listener_set.3.html +++ b/man/v1.2.2/nng_listener_set.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_set(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_set - set listener option

    @@ -557,9 +70,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_listener_set() functions are used to configure options for -the listener l. +the listener l. The actual options that may be configured in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -620,7 +133,7 @@ The ival is passed to the option.

    nng_listener_set_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_listener_set_ptr()
    @@ -628,7 +141,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -741,18 +254,19 @@ and similar.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_create(3) -nng_listener_get(3) -nng_socket_set(3), -nng_strerror(3), -nng_duration(5), -nng_listener(5), -nng_options(5), -nng(7)

    +

    nng_listen(3), +nng_listener_create(3) +nng_listener_get(3) +nng_socket_set(3), +nng_strerror(3), +nng_duration(5), +nng_listener(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_setopt.3.html b/man/v1.2.2/nng_listener_setopt.3.html index 9c9f05c3..0d13fdcb 100644 --- a/man/v1.2.2/nng_listener_setopt.3.html +++ b/man/v1.2.2/nng_listener_setopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_setopt(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_setopt - set listener option

    @@ -561,7 +74,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_listener_set. +These functions are deprecated. Please see nng_listener_set. @@ -569,9 +82,9 @@ These functions are deprecated. Please see n

    The nng_listener_setopt() functions are used to configure options for -the listener l. +the listener l. The actual options that may be configured in this way -vary, and many are documented in nng_options(5).

    +vary, and many are documented in nng_options(5).

    Additionally some transport-specific options and protocol-specific options @@ -632,7 +145,7 @@ The ival is passed to the option.

    nng_listener_setopt_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_listener_setopt_ptr()
    @@ -640,7 +153,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -753,18 +266,19 @@ and similar.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_create(3) -nng_listener_getopt(3) -nng_setopt(3), -nng_strerror(3), -nng_duration(5), -nng_listener(5), -nng_options(5), -nng(7)

    +

    nng_listen(3), +nng_listener_create(3) +nng_listener_getopt(3) +nng_setopt(3), +nng_strerror(3), +nng_duration(5), +nng_listener(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_listener_start.3.html b/man/v1.2.2/nng_listener_start.3.html index 080ca96b..bb869fec 100644 --- a/man/v1.2.2/nng_listener_start.3.html +++ b/man/v1.2.2/nng_listener_start.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_listener_start(3) - - - + + -

    NAME

    +

    NAME

    nng_listener_start - start listener

    @@ -542,7 +55,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    This causes the listener to bind to the address it was created with, and to start accepting connections from remote dialers. -Each new connection results in an nng_pipe object, +Each new connection results in an nng_pipe object, which will be attached to the listener’s socket.

    @@ -591,14 +104,15 @@ its configuration.

    SEE ALSO

    -

    nng_listen(3), -nng_listener_create(3) -nng_listener(5), -nng_strerror(3), -nng(7)

    +

    nng_listen(3), +nng_listener_create(3) +nng_listener(5), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg.5.html b/man/v1.2.2/nng_msg.5.html index 543684b9..35489300 100644 --- a/man/v1.2.2/nng_msg.5.html +++ b/man/v1.2.2/nng_msg.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg(5) - - - + + -

    NAME

    +

    NAME

    nng_msg - message

    @@ -547,7 +60,7 @@ related information.

    -Using the message-oriented functions in the nng API is +Using the message-oriented functions in the nng API is a good way to reduce the likelihood of data copies and improve application performance. @@ -555,8 +68,8 @@ performance.
    -

    Messages are allocated using the nng_msg_alloc() -function, and are deallocated using the nng_msg_free() +

    Messages are allocated using the nng_msg_alloc() +function, and are deallocated using the nng_msg_free() function.

    @@ -572,23 +85,24 @@ by making use of scratch areas at the beginning and end of the message.

    SEE ALSO

    -

    nng_aio_get_msg(3), -nng_aio_set_msg(3), -nng_msg_alloc(3), -nng_msg_body(3), -nng_msg_dup(3), -nng_msg_free(3), -nng_msg_header(3), -nng_msg_header_len(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_recvmsg(3), -nng_sendmsg(3), -nng_strerror(3), -nng(7)

    +

    nng_aio_get_msg(3), +nng_aio_set_msg(3), +nng_msg_alloc(3), +nng_msg_body(3), +nng_msg_dup(3), +nng_msg_free(3), +nng_msg_header(3), +nng_msg_header_len(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_recvmsg(3), +nng_sendmsg(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_alloc.3.html b/man/v1.2.2/nng_msg_alloc.3.html index f401171e..b5499daf 100644 --- a/man/v1.2.2/nng_msg_alloc.3.html +++ b/man/v1.2.2/nng_msg_alloc.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_alloc(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_alloc - allocate a message

    @@ -572,19 +85,20 @@ They are used with receive and transmit functions.

    SEE ALSO

    -

    nng_msg_free(3), -nng_msg_body(3), -nng_msg_dup(3), -nng_msg_header(3), -nng_msg_header_len(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_free(3), +nng_msg_body(3), +nng_msg_dup(3), +nng_msg_header(3), +nng_msg_header_len(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_append.3.html b/man/v1.2.2/nng_msg_append.3.html index bf56800b..462c0bea 100644 --- a/man/v1.2.2/nng_msg_append.3.html +++ b/man/v1.2.2/nng_msg_append.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_append(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_append - append to message body

    @@ -576,20 +89,21 @@ network-byte order (big-endian).

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_body(3), -nng_msg_chop(3), -nng_msg_free(3), -nng_msg_insert(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_msg_trim(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_body(3), +nng_msg_chop(3), +nng_msg_free(3), +nng_msg_insert(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_msg_trim(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_body.3.html b/man/v1.2.2/nng_msg_body.3.html index 5eff841c..43a53059 100644 --- a/man/v1.2.2/nng_msg_body.3.html +++ b/man/v1.2.2/nng_msg_body.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_body(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_body - return message body

    @@ -549,12 +62,12 @@ content of the message msg.

    The value returned by this is invalidated by a call to any of the functions that modify the message itself. Such functions are -nng_msg_free(), -nng_msg_realloc(), -any of the nng_msg_trim(), -nng_msg_chop(), -nng_msg_append(), -or nng_msg_insert() variants. +nng_msg_free(), +nng_msg_realloc(), +any of the nng_msg_trim(), +nng_msg_chop(), +nng_msg_append(), +or nng_msg_insert() variants. @@ -581,19 +94,20 @@ or nng_msg_insert() variants.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_append(3), -nng_msg_chop(3), -nng_msg_free(3), -nng_msg_insert(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_msg_trim(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_append(3), +nng_msg_chop(3), +nng_msg_free(3), +nng_msg_insert(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_msg_trim(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_chop.3.html b/man/v1.2.2/nng_msg_chop.3.html index f06f8304..25d19eb3 100644 --- a/man/v1.2.2/nng_msg_chop.3.html +++ b/man/v1.2.2/nng_msg_chop.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_chop(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_chop - remove data from end of message body

    @@ -577,20 +90,21 @@ after converting them from network-byte order (big-endian) to native byte order.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_append(3), -nng_msg_body(3), -nng_msg_free(3), -nng_msg_insert(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_msg_trim(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_append(3), +nng_msg_body(3), +nng_msg_free(3), +nng_msg_insert(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_msg_trim(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_clear.3.html b/man/v1.2.2/nng_msg_clear.3.html index c0b83860..f83bba78 100644 --- a/man/v1.2.2/nng_msg_clear.3.html +++ b/man/v1.2.2/nng_msg_clear.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_clear(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_clear - clear message body content

    @@ -560,11 +73,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_msg(5), -nng(7)

    +

    nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_dup.3.html b/man/v1.2.2/nng_msg_dup.3.html index cd387b76..28914fc2 100644 --- a/man/v1.2.2/nng_msg_dup.3.html +++ b/man/v1.2.2/nng_msg_dup.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_dup(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_dup - duplicate a message

    @@ -573,14 +86,15 @@ different amount of unused space than the original message.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_free(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_free(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_free.3.html b/man/v1.2.2/nng_msg_free.3.html index 1ecc2c0d..1086aa80 100644 --- a/man/v1.2.2/nng_msg_free.3.html +++ b/man/v1.2.2/nng_msg_free.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_free(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_free - free a message

    @@ -560,13 +73,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_realloc(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_realloc(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_get_pipe.3.html b/man/v1.2.2/nng_msg_get_pipe.3.html index 87ef2c1c..f49f5562 100644 --- a/man/v1.2.2/nng_msg_get_pipe.3.html +++ b/man/v1.2.2/nng_msg_get_pipe.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_get_pipe(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_get_pipe - get pipe for message

    @@ -536,7 +49,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_msg_get_pipe() returns the nng_pipe object +

    The nng_msg_get_pipe() returns the nng_pipe object associated with message msg. On receive, this is the pipe from which a message was received. On transmit, this would be the pipe that the message should be delivered @@ -559,7 +72,7 @@ Not all protocols support overriding the destination pipe. from which the message was received. This can be used to provide different behaviors for different peers, such as a higher level of authentication for peers located on an untrusted network. -The nng_pipe_getopt() function +The nng_pipe_getopt() function is useful in this situation.

    @@ -587,13 +100,14 @@ no specific pipe is associated with the message.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_set_pipe(3), -nng_pipe_getopt(3), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_set_pipe(3), +nng_pipe_getopt(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header.3.html b/man/v1.2.2/nng_msg_header.3.html index f0937940..91dec56c 100644 --- a/man/v1.2.2/nng_msg_header.3.html +++ b/man/v1.2.2/nng_msg_header.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header - return message header

    @@ -589,19 +102,20 @@ functions that modify the message or the header content.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_body(3), -nng_msg_free(3), -nng_msg_header_append(3), -nng_msg_header_chop(3), -nng_msg_header_insert(3) -nng_msg_header_len(3), -nng_msg_header_trim(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_body(3), +nng_msg_free(3), +nng_msg_header_append(3), +nng_msg_header_chop(3), +nng_msg_header_insert(3) +nng_msg_header_len(3), +nng_msg_header_trim(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_append.3.html b/man/v1.2.2/nng_msg_header_append.3.html index e54e8985..841e8200 100644 --- a/man/v1.2.2/nng_msg_header_append.3.html +++ b/man/v1.2.2/nng_msg_header_append.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_append(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_append - append to message header

    @@ -578,18 +91,19 @@ network-byte order (big-endian).

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_header(3), -nng_msg_header_chop(3), -nng_msg_header_insert(3), -nng_msg_header_len(3), -nng_msg_header_trim(3), -nng_msg_free(3), -nng_strerror(3), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_header(3), +nng_msg_header_chop(3), +nng_msg_header_insert(3), +nng_msg_header_len(3), +nng_msg_header_trim(3), +nng_msg_free(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_chop.3.html b/man/v1.2.2/nng_msg_header_chop.3.html index b054ca73..a8255510 100644 --- a/man/v1.2.2/nng_msg_header_chop.3.html +++ b/man/v1.2.2/nng_msg_header_chop.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_chop(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_chop - remove data from end of message header

    @@ -578,18 +91,19 @@ byte order.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_header(3), -nng_msg_header_append(3), -nng_msg_header_insert(3), -nng_msg_header_len(3), -nng_msg_header_trim(3), -nng_msg_free(3), -nng_strerror(3), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_header(3), +nng_msg_header_append(3), +nng_msg_header_insert(3), +nng_msg_header_len(3), +nng_msg_header_trim(3), +nng_msg_free(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_clear.3.html b/man/v1.2.2/nng_msg_header_clear.3.html index 5be08e1c..8506d2fa 100644 --- a/man/v1.2.2/nng_msg_header_clear.3.html +++ b/man/v1.2.2/nng_msg_header_clear.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_clear(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_clear - clear message header

    @@ -560,12 +73,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_insert.3.html b/man/v1.2.2/nng_msg_header_insert.3.html index 105175b2..cee6c27f 100644 --- a/man/v1.2.2/nng_msg_header_insert.3.html +++ b/man/v1.2.2/nng_msg_header_insert.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_insert(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_insert - prepend to message header

    @@ -577,19 +90,20 @@ network-byte order (big-endian).

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_header(3), -nng_msg_header_append(3), -nng_msg_header_chop(3), -nng_msg_header_len(3), -nng_msg_header_trim(3), -nng_msg_free(3), -nng_msg_realloc(3), -nng_strerror(3), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_header(3), +nng_msg_header_append(3), +nng_msg_header_chop(3), +nng_msg_header_len(3), +nng_msg_header_trim(3), +nng_msg_free(3), +nng_msg_realloc(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_len.3.html b/man/v1.2.2/nng_msg_header_len.3.html index 2e2d7845..2a4d683e 100644 --- a/man/v1.2.2/nng_msg_header_len.3.html +++ b/man/v1.2.2/nng_msg_header_len.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_len(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_len - return message header length

    @@ -560,13 +73,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_header(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_header(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_header_trim.3.html b/man/v1.2.2/nng_msg_header_trim.3.html index a7d57ec9..f9aacf6b 100644 --- a/man/v1.2.2/nng_msg_header_trim.3.html +++ b/man/v1.2.2/nng_msg_header_trim.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_header_trim(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_header_trim - remove data from start of message header

    @@ -578,19 +91,20 @@ byte order.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_header(3), -nng_msg_header_append(3), -nng_msg_header_chop(3), -nng_msg_header_insert(3), -nng_msg_header_len(3), -nng_msg_free(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_header(3), +nng_msg_header_append(3), +nng_msg_header_chop(3), +nng_msg_header_insert(3), +nng_msg_header_len(3), +nng_msg_free(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_insert.3.html b/man/v1.2.2/nng_msg_insert.3.html index f996e130..84337bff 100644 --- a/man/v1.2.2/nng_msg_insert.3.html +++ b/man/v1.2.2/nng_msg_insert.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_insert(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_insert - prepend to message body

    @@ -591,20 +104,21 @@ content themselves, in order to benefit from this capability.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_append(3), -nng_msg_body(3), -nng_msg_chop(3), -nng_msg_free(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_msg_trim(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_append(3), +nng_msg_body(3), +nng_msg_chop(3), +nng_msg_free(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_msg_trim(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_len.3.html b/man/v1.2.2/nng_msg_len.3.html index c8239a02..24a2b24b 100644 --- a/man/v1.2.2/nng_msg_len.3.html +++ b/man/v1.2.2/nng_msg_len.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_len(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_len - return message body length

    @@ -560,13 +73,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_body(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_body(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_realloc.3.html b/man/v1.2.2/nng_msg_realloc.3.html index 4acb4597..463f8450 100644 --- a/man/v1.2.2/nng_msg_realloc.3.html +++ b/man/v1.2.2/nng_msg_realloc.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_realloc(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_realloc - reallocate a message

    @@ -550,11 +63,11 @@ 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 +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() +needs to grow due to this function or nng_msg_append() no actual memory allocations need to take place. @@ -605,20 +118,21 @@ may have changed, particularly if the message size is increasing.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_append(3), -nng_msg_body(3), -nng_msg_chop(3), -nng_msg_free(3), -nng_msg_insert(3), -nng_msg_len(3), -nng_msg_trim(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_append(3), +nng_msg_body(3), +nng_msg_chop(3), +nng_msg_free(3), +nng_msg_insert(3), +nng_msg_len(3), +nng_msg_trim(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_set_pipe.3.html b/man/v1.2.2/nng_msg_set_pipe.3.html index bc7876e1..76034844 100644 --- a/man/v1.2.2/nng_msg_set_pipe.3.html +++ b/man/v1.2.2/nng_msg_set_pipe.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_set_pipe(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_set_pipe - set pipe for message

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_msg_set_pipe() sets the pipe associated with message m to p. This is most often useful when used with protocols that support directing a message to a specific peer. -For example the pair version 1 protocol can do +For example the pair version 1 protocol can do this when NNG_OPT_PAIR1_POLY mode is set.

    @@ -576,14 +89,15 @@ Not all protocols support overriding the destination pipe.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_get_pipe(3), -nng_pipe_getopt(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_get_pipe(3), +nng_pipe_getopt(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msg_trim.3.html b/man/v1.2.2/nng_msg_trim.3.html index d376bc90..ccf27b33 100644 --- a/man/v1.2.2/nng_msg_trim.3.html +++ b/man/v1.2.2/nng_msg_trim.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msg_trim(3) - - - + + -

    NAME

    +

    NAME

    nng_msg_trim - remove data from start of message body

    @@ -578,20 +91,21 @@ byte order.

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_msg_append(3), -nng_msg_body(3), -nng_msg_chop(3), -nng_msg_free(3), -nng_msg_insert(3), -nng_msg_len(3), -nng_msg_realloc(3), -nng_strerror(3), -nng_msg(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_msg_append(3), +nng_msg_body(3), +nng_msg_chop(3), +nng_msg_free(3), +nng_msg_insert(3), +nng_msg_len(3), +nng_msg_realloc(3), +nng_strerror(3), +nng_msg(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_msleep.3supp.html b/man/v1.2.2/nng_msleep.3supp.html index 2a3b3000..9383aa30 100644 --- a/man/v1.2.2/nng_msleep.3supp.html +++ b/man/v1.2.2/nng_msleep.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_msleep(3supp) - - - + + -

    NAME

    +

    NAME

    nng_msleep - sleep milliseconds

    @@ -575,14 +88,15 @@ underlying system.

    SEE ALSO

    -

    nng_sleep_aio(3), -nng_strerror(3), -nng_clock(3supp), -nng_duration(5), -nng(7)

    +

    nng_sleep_aio(3), +nng_strerror(3), +nng_clock(3supp), +nng_duration(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_mtx_alloc.3supp.html b/man/v1.2.2/nng_mtx_alloc.3supp.html index aa767114..3f9f4595 100644 --- a/man/v1.2.2/nng_mtx_alloc.3supp.html +++ b/man/v1.2.2/nng_mtx_alloc.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_mtx_alloc(3supp) - - - + + -

    NAME

    +

    NAME

    nng_mtx_alloc - allocate mutex

    @@ -584,15 +97,16 @@ where only a single thread of execution is permitted to “own” the se

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_mtx_free(3supp), -nng_mtx_lock(3supp), -nng_mtx_unlock(3supp), -nng_strerror(3), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_mtx_free(3supp), +nng_mtx_lock(3supp), +nng_mtx_unlock(3supp), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_mtx_free.3supp.html b/man/v1.2.2/nng_mtx_free.3supp.html index af3b9e77..a31869ca 100644 --- a/man/v1.2.2/nng_mtx_free.3supp.html +++ b/man/v1.2.2/nng_mtx_free.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_mtx_free(3supp) - - - + + -

    NAME

    +

    NAME

    nng_mtx_free - free mutex

    @@ -562,11 +75,12 @@ The mutex must not be locked when this function is called.

    SEE ALSO

    -

    nng_mtx_alloc(3supp), -nng(7)

    +

    nng_mtx_alloc(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_mtx_lock.3supp.html b/man/v1.2.2/nng_mtx_lock.3supp.html index 357cc56d..0f1eb5fa 100644 --- a/man/v1.2.2/nng_mtx_lock.3supp.html +++ b/man/v1.2.2/nng_mtx_lock.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_mtx_lock(3supp) - - - + + -

    NAME

    +

    NAME

    nng_mtx_lock - lock mutex

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_mtx_lock() acquires exclusive ownership of the mutex mtx. If the lock is already owned, this function will wait until the current -owner releases it with nng_mtx_unlock().

    +owner releases it with nng_mtx_unlock().

    If multiple threads are waiting for the lock, the order of acquisition @@ -605,13 +118,14 @@ easily from mutexes and condition variables.

    SEE ALSO

    -

    nng_cv_alloc(3supp), -nng_mtx_alloc(3supp), -nng_mtx_unlock(3supp), -nng(7)

    +

    nng_cv_alloc(3supp), +nng_mtx_alloc(3supp), +nng_mtx_unlock(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_mtx_unlock.3supp.html b/man/v1.2.2/nng_mtx_unlock.3supp.html index 47f7b524..4361b378 100644 --- a/man/v1.2.2/nng_mtx_unlock.3supp.html +++ b/man/v1.2.2/nng_mtx_unlock.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_mtx_unlock(3supp) - - - + + -

    NAME

    +

    NAME

    nng_mtx_unlock - unlock mutex

    @@ -538,7 +51,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

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

    +was previously acquired via nng_mtx_lock().

    @@ -576,12 +89,13 @@ in undefined behavior.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_options.5.html b/man/v1.2.2/nng_options.5.html index 974f2905..157559c9 100644 --- a/man/v1.2.2/nng_options.5.html +++ b/man/v1.2.2/nng_options.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_options(5) - - - + + -

    NAME

    +

    NAME

    nng_options - socket, dialer, listener, and pipe options

    @@ -560,25 +73,25 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b retrieved on objects in the nng library.

    -

    Sockets (nng_socket objects) use the functions -nng_getopt() -and nng_setopt() to set and retrieve option values.

    +

    Sockets (nng_socket objects) use the functions +nng_getopt() +and nng_setopt() to set and retrieve option values.

    -

    Dialers (nng_dialer objects) use the functions -nng_dialer_getopt() and -nng_dialer_setopt() to set and retrieve option +

    Dialers (nng_dialer objects) use the functions +nng_dialer_getopt() and +nng_dialer_setopt() to set and retrieve option values.

    -

    Listeners (nng_listener objects) use the functions -nng_listener_getopt() -and nng_listener_setopt() to set and +

    Listeners (nng_listener objects) use the functions +nng_listener_getopt() +and nng_listener_setopt() to set and retrieve option values.

    -

    Pipes (nng_pipe objects) can only retrieve option values using -the nng_pipe_getopt() function.

    +

    Pipes (nng_pipe objects) can only retrieve option values using +the nng_pipe_getopt() function.

    Other object types may have additional methods to access these options.

    @@ -605,7 +118,7 @@ description of the option.

    NNG_OPT_LOCADDR
    -

    (nng_sockaddr) +

    (nng_sockaddr) This read-only option may be used on listeners, dialers and connected pipes, and represents the local address used for communication. NOTE: Not all transports support this option, and some transports may support it on @@ -632,7 +145,7 @@ in “cooked” mode.

    Raw mode sockets generally do not have any protocol-specific semantics applied to them; instead the application is expected to perform such semantics itself. -(For example, in “cooked” mode a rep socket would +(For example, in “cooked” mode a rep socket would automatically copy message headers from a received message to the corresponding reply, whereas in “raw” mode this is not done.) See Raw Mode for more details.

    @@ -645,7 +158,7 @@ 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 @@ -660,7 +173,7 @@ The option is irrelevant for listeners.

    -(nng_duration) +(nng_duration) This is the maximum amount of time (milliseconds) to wait before attempting to establish a connection after a previous attempt has failed. @@ -729,7 +242,7 @@ returned file descriptor.

    @@ -745,7 +258,7 @@ where they are in use. While this option may help applications integrate into existing polling loops, it is more efficient, and often easier, to use the asynchronous I/O objects instead. -See nng_aio_alloc(). +See nng_aio_alloc().
    This option is incompatible with -nng_ctx contexts and should not be used on a socket +nng_ctx contexts and should not be used on a socket where they are in use.
    @@ -802,7 +315,7 @@ Some transports may have further message size restrictions.

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

    @@ -813,7 +326,7 @@ time, receive operations will fail with a return value of NNG_ETIMEDOUT
    NNG_OPT_REMADDR
    -

    (nng_sockaddr) +

    (nng_sockaddr) This read-only option may be used on dialers and connected pipes, and represents the address of a remote peer. Not all transports support this option.

    @@ -839,7 +352,7 @@ This value must be an integer between 0 and 8192, inclusive.

    Not all protocols support buffering sent messages; -generally multicast protocols like pub will +generally multicast protocols like pub will simply discard messages when they cannot be delivered immediately. @@ -890,7 +403,7 @@ returned file descriptor; use should be limited to polling system calls only. This option is incompatible with -nng_ctx contexts and should not be used on a socket +nng_ctx contexts and should not be used on a socket where they are in use. @@ -906,7 +419,7 @@ where they are in use. While this option may help applications integrate into existing polling loops, it is more efficient, and often easier, to use the asynchronous I/O objects instead. -See nng_aio_alloc(). +See nng_aio_alloc(). @@ -920,7 +433,7 @@ See nng_aio_alloc().

    -(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 @@ -950,7 +463,7 @@ in the library itself.

    (int) This is the maximum number of “hops” a message may traverse across -a nng_device() forwarders. +a nng_device() forwarders. The intention here is to prevent forwarding loops in device chains. When this is supported, it can have a value between 1 and 255, inclusive.

    @@ -1055,20 +568,21 @@ the socket.

    SEE ALSO

    -

    nng_dialer_getopt(3), -nng_dialer_setopt(3), -nng_getopt(3), -nng_listener_getopt(3), -nng_listener_setopt(3), -nng_pipe_getopt(3), -nng_setopt(3), -nng_ipc_options(5), -nng_tcp_options(5), -nng_tls_options(5), -nng(7)

    +

    nng_dialer_getopt(3), +nng_dialer_setopt(3), +nng_getopt(3), +nng_listener_getopt(3), +nng_listener_setopt(3), +nng_pipe_getopt(3), +nng_setopt(3), +nng_ipc_options(5), +nng_tcp_options(5), +nng_tls_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_opts_parse.3supp.html b/man/v1.2.2/nng_opts_parse.3supp.html index 5e6199d2..dd6f0088 100644 --- a/man/v1.2.2/nng_opts_parse.3supp.html +++ b/man/v1.2.2/nng_opts_parse.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_opts_parse(3supp) - - - + + -

    NAME

    +

    NAME

    nng_opts_parse - parse command line options

    @@ -774,11 +287,12 @@ no more options are available to be parsed, or an error number otherwise.

    SEE ALSO

    -

    nng_strerror(3), -nng(7)

    +

    nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pair.7.html b/man/v1.2.2/nng_pair.7.html index 9e1ad5da..f4e210d4 100644 --- a/man/v1.2.2/nng_pair.7.html +++ b/man/v1.2.2/nng_pair.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pair(7) - - - + + -

    NAME

    +

    NAME

    nng_pair - pair protocol

    @@ -559,7 +72,7 @@ Using this mode requires some additional sophistication in the application.

    Socket Operations

    -

    The nng_pair_open() functions create a pair socket.

    +

    The nng_pair_open() functions create a pair socket.

    Normally, this pattern will block when attempting to send a message if @@ -574,11 +87,11 @@ no peer is able to receive the message.

    Even though this mode may appear to be "reliable", because back-pressure prevents discarding messages most of the time, there are topologies involving -devices (see nng_device()) or raw mode sockets +devices (see nng_device()) or raw mode sockets (see NNG_OPT_RAW) where messages may be discarded. Applications that require reliable delivery semantics should consider using -req sockets, or +req sockets, or implement their own acknowledgment layer on top of pair sockets. @@ -613,7 +126,7 @@ including the legacy nanomsg li

    Version 1 of the protocol offers improved protection against loops when -used with nng_device(). +used with nng_device(). It also offers polyamorous mode for forming multiple partnerships on a single socket.

    @@ -642,12 +155,12 @@ peer.

    support many one-to-one connections. In this mode, the application must choose the remote peer to receive an outgoing message by setting the -nng_pipe to use for the outgoing message with -the nng_msg_set_pipe() function.

    +nng_pipe to use for the outgoing message with +the nng_msg_set_pipe() function.

    Most often the value of the outgoing pipe will be obtained from an incoming -message using the nng_msg_get_pipe() function, +message using the nng_msg_get_pipe() function, such as when replying to an incoming message.

    @@ -698,12 +211,13 @@ received by a new node.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pair_open.3.html b/man/v1.2.2/nng_pair_open.3.html index f6a88629..816223b4 100644 --- a/man/v1.2.2/nng_pair_open.3.html +++ b/man/v1.2.2/nng_pair_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pair_open(3) - - - + + -

    NAME

    +

    NAME

    nng_pair_open - create pair socket

    @@ -550,13 +63,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_pair0_open() and nng_pair1_open() functions -create a pair version 0 or version 1 -socket and return it at the location pointed to by s.

    +create a pair version 0 or version 1 +socket and return it at the location pointed to by s.

    The nng_pair0_open_raw() and nng_pair1_open_raw() functions -create a pair version 0 or version 1 -socket in +create a pair version 0 or version 1 +socket in raw mode and return it at the location pointed to by s.

    @@ -598,12 +111,13 @@ create a pair version 0 or version 1

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe.5.html b/man/v1.2.2/nng_pipe.5.html index bd11a75a..1752d1d0 100644 --- a/man/v1.2.2/nng_pipe.5.html +++ b/man/v1.2.2/nng_pipe.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe(5) - - - + + -

    NAME

    +

    NAME

    nng_pipe - communications pipe

    @@ -577,13 +90,13 @@ message delivery.
    -

    Pipe objects are created by dialers (nng_dialer objects) -and listeners (nng_listener objects), which can be +

    Pipe objects are created by dialers (nng_dialer objects) +and listeners (nng_listener objects), which can be thought of as “owning” the pipe.

    Pipe objects may be destroyed by the -nng_pipe_close() function. +nng_pipe_close() function. They are also closed when their “owning” dialer or listener is closed, or when the remote peer closes the underlying connection.

    @@ -608,20 +121,21 @@ before it is opened, to prevent confusion with valid open pipes.

    SEE ALSO

    -

    nng_msg_get_pipe(3), -nng_pipe_close(3), -nng_pipe_getopt(3), -nng_pipe_dialer(3), -nng_pipe_id(3), -nng_pipe_listener(3), -nng_pipe_socket(3), -nng_dialer(5), -nng_listener(5), -nng_options(5), -nng(7)

    +

    nng_msg_get_pipe(3), +nng_pipe_close(3), +nng_pipe_getopt(3), +nng_pipe_dialer(3), +nng_pipe_id(3), +nng_pipe_listener(3), +nng_pipe_socket(3), +nng_dialer(5), +nng_listener(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_close.3.html b/man/v1.2.2/nng_pipe_close.3.html index c4e7eabf..cffd9e70 100644 --- a/man/v1.2.2/nng_pipe_close.3.html +++ b/man/v1.2.2/nng_pipe_close.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_close(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_close - close pipe

    @@ -588,13 +101,14 @@ remote peer closes the underlying connection.

    SEE ALSO

    -

    nng_strerror(3), -nng_options(5), -nng_pipe(5), -nng(7)

    +

    nng_strerror(3), +nng_options(5), +nng_pipe(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_dialer.3.html b/man/v1.2.2/nng_pipe_dialer.3.html index eaeddd66..0d1d62e5 100644 --- a/man/v1.2.2/nng_pipe_dialer.3.html +++ b/man/v1.2.2/nng_pipe_dialer.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_dialer(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_dialer - return dialer that created pipe

    @@ -536,10 +49,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pipe_dialer() function returns the nng_dialer +

    The nng_pipe_dialer() function returns the nng_dialer that created the pipe p. If the pipe was not created by a dialer, then the returned value will -have an identifier (nng_dialer_id()) of -1.

    +have an identifier (nng_dialer_id()) of -1.

    @@ -565,12 +78,13 @@ not created by a dialer, in which case a value initialized with

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_get.3.html b/man/v1.2.2/nng_pipe_get.3.html index 5cfd4fd2..cb6b2d2d 100644 --- a/man/v1.2.2/nng_pipe_get.3.html +++ b/man/v1.2.2/nng_pipe_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_get(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_get - get pipe option

    @@ -558,9 +71,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_pipe_get() functions are used to retrieve option values for -the pipe p. +the pipe p. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5). +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.

    @@ -573,8 +86,8 @@ documented with the transports and protocols themselves.

    All “options” on a pipe are read-only values. Modification of options may be done before the pipe is created using -nng_listener_set() or -nng_dialer_set(). +nng_listener_set() or +nng_dialer_set(). @@ -641,7 +154,7 @@ The value will be stored at ivalp.

    nng_pipe_get_ms()

    This function is used to retrieve time durations -(nng_duration) in milliseconds, which are stored in +(nng_duration) in milliseconds, which are stored in durp.

    nng_pipe_get_ptr()
    @@ -658,15 +171,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_pipe_get_addr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into sap.

    nng_pipe_get_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_pipe_get_uint64()
    @@ -749,21 +262,22 @@ related to identifiers, network numbers, and similar.

    SEE ALSO

    -

    nng_dialer_set(3) -nng_socket_get(3), -nng_listener_set(3) -nng_msg_get_pipe(3) -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_options(5), -nng_pipe(5), -nng_sockaddr(5), -nng(7)

    +

    nng_dialer_set(3) +nng_socket_get(3), +nng_listener_set(3) +nng_msg_get_pipe(3) +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_options(5), +nng_pipe(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_getopt.3.html b/man/v1.2.2/nng_pipe_getopt.3.html index d54b26bd..9201a1a1 100644 --- a/man/v1.2.2/nng_pipe_getopt.3.html +++ b/man/v1.2.2/nng_pipe_getopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_getopt(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_getopt - get pipe option

    @@ -562,7 +75,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_pipe_get. +These functions are deprecated. Please see nng_pipe_get. @@ -570,9 +83,9 @@ These functions are deprecated. Please see nng_p

    The nng_pipe_getopt() functions are used to retrieve option values for -the pipe p. +the pipe p. The actual options that may be retrieved in this way -vary, and many are documented in nng_options(5). +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.

    @@ -585,8 +98,8 @@ documented with the transports and protocols themselves.

    All “options” on a pipe are read-only values. Modification of options may be done before the pipe is created using -nng_listener_setopt() or -nng_dialer_setopt(). +nng_listener_setopt() or +nng_dialer_setopt(). @@ -653,7 +166,7 @@ The value will be stored at ivalp.

    nng_pipe_getopt_ms()

    This function is used to retrieve time durations -(nng_duration) in milliseconds, which are stored in +(nng_duration) in milliseconds, which are stored in durp.

    nng_pipe_getopt_ptr()
    @@ -670,15 +183,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_pipe_getopt_sockaddr()
    -

    This function is used to retrieve an nng_sockaddr +

    This function is used to retrieve an nng_sockaddr into sap.

    nng_pipe_getopt_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_pipe_getopt_uint64()
    @@ -761,21 +274,22 @@ related to identifiers, network numbers, and similar.

    SEE ALSO

    -

    nng_dialer_setopt(3) -nng_getopt(3), -nng_listener_setopt(3) -nng_msg_get_pipe(3) -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_options(5), -nng_pipe(5), -nng_sockaddr(5), -nng(7)

    +

    nng_dialer_setopt(3) +nng_getopt(3), +nng_listener_setopt(3) +nng_msg_get_pipe(3) +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_options(5), +nng_pipe(5), +nng_sockaddr(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_id.3.html b/man/v1.2.2/nng_pipe_id.3.html index 1bc13404..7bc7a2e7 100644 --- a/man/v1.2.2/nng_pipe_id.3.html +++ b/man/v1.2.2/nng_pipe_id.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_id(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_id - return numeric pipe identifier

    @@ -579,11 +92,12 @@ they cannot be confused with a valid pipe.

    SEE ALSO

    -

    nng_pipe(5), -nng(7)

    +

    nng_pipe(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_listener.3.html b/man/v1.2.2/nng_pipe_listener.3.html index a56c641e..62ca9157 100644 --- a/man/v1.2.2/nng_pipe_listener.3.html +++ b/man/v1.2.2/nng_pipe_listener.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_listener(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_listener - return listener that created pipe

    @@ -536,10 +49,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pipe_listener() function returns the nng_listener +

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

    +have an identifier (nng_listener_id()) of -1.

    @@ -565,12 +78,13 @@ not created by a listener, in which case a value initialized with

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_notify.3.html b/man/v1.2.2/nng_pipe_notify.3.html index 8f2f2685..c772b2ed 100644 --- a/man/v1.2.2/nng_pipe_notify.3.html +++ b/man/v1.2.2/nng_pipe_notify.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_notify(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_notify - register pipe notification callback

    @@ -545,7 +58,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_pipe_notify() function registers the callback function cb -to be called whenever a pipe the pipe event specified by +to be called whenever a pipe the pipe event specified by ev occurs on the socket s. The callback cb will be passed arg as its final argument.

    @@ -563,7 +76,7 @@ Registering a callback implicitly unregisters any previously registered.

    This event occurs after a connection and negotiation has completed, but before the pipe is added to the socket. -If the pipe is closed (using nng_pipe_close()) at +If the pipe is closed (using nng_pipe_close()) at this point, the socket will never see the pipe, and no further events will occur for the given pipe.

    @@ -591,7 +104,7 @@ possible communicate using this pipe.

    The callback cb may close a pipe for any reason by simply closing -it using nng_pipe_close(). +it using nng_pipe_close(). This might be done before the pipe is added to the socket (during NNG_PIPE_EV_ADD_PRE), for example, if the remote peer is not authorized. @@ -654,14 +167,15 @@ This function ignores invalid values for ev.

    SEE ALSO

    -

    nng_pipe_close(3), -nng_pipe_getopt(3), -nng_pipe(5), -nng_socket(5), -nng(7)

    +

    nng_pipe_close(3), +nng_pipe_getopt(3), +nng_pipe(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pipe_socket.3.html b/man/v1.2.2/nng_pipe_socket.3.html index a1e37d77..ed670899 100644 --- a/man/v1.2.2/nng_pipe_socket.3.html +++ b/man/v1.2.2/nng_pipe_socket.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pipe_socket(3) - - - + + -

    NAME

    +

    NAME

    nng_pipe_socket - return owning socket for pipe

    @@ -536,7 +49,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pipe_socket() function returns the nng_socket +

    The nng_pipe_socket() function returns the nng_socket that owns the pipe p.

    @@ -574,12 +87,13 @@ which case it will not be usable with other functions.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pub.7.html b/man/v1.2.2/nng_pub.7.html index f9fdfa1c..41747851 100644 --- a/man/v1.2.2/nng_pub.7.html +++ b/man/v1.2.2/nng_pub.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_pub(7) - - - + + -

    NAME

    +

    NAME

    nng_pub - publisher protocol

    @@ -548,7 +61,7 @@ they have subscribed.

    The pub protocol is the publisher side, and the -sub protocol is the subscriber side.

    +sub protocol is the subscriber side.

    @@ -574,7 +87,7 @@ Applications should construct their messages accordingly.

    Socket Operations

    -

    The nng_pub0_open() functions create a publisher socket. +

    The nng_pub0_open() functions create a publisher socket. This socket may be used to send messages, but is unable to receive them. Attempts to receive messages will result in NNG_ENOTSUP.

    @@ -604,12 +117,13 @@ Attempts to receive messages will result in NNG_ENOTSUP.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pub_open.3.html b/man/v1.2.2/nng_pub_open.3.html index f63c1c32..a2c3948a 100644 --- a/man/v1.2.2/nng_pub_open.3.html +++ b/man/v1.2.2/nng_pub_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_pub_open(3) - - - + + -

    NAME

    +

    NAME

    nng_pub_open - create pub socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pub0_open() function creates a pub version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_pub0_open() function creates a pub version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_pub0_open_raw() function creates a pub version 0 -socket in +

    The nng_pub0_open_raw() function creates a pub version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -586,13 +99,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_socket(5), -nng_pub(7), -nng_sub(7), -nng(7)

    +

    nng_socket(5), +nng_pub(7), +nng_sub(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pull.7.html b/man/v1.2.2/nng_pull.7.html index 9b4df238..f3a49d40 100644 --- a/man/v1.2.2/nng_pull.7.html +++ b/man/v1.2.2/nng_pull.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_pull(7) - - - + + -

    NAME

    +

    NAME

    nng_pull - pull protocol

    @@ -541,7 +54,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The pull protocol is one half of a pipeline pattern. -The other half is the push protocol.

    +The other half is the push protocol.

    In the pipeline pattern, pushers distribute messages to pullers. @@ -554,7 +67,7 @@ This property makes this pattern useful in load-balancing scenarios.

    Socket Operations

    -

    The nng_pull0_open() functions create a puller socket. +

    The nng_pull0_open() functions create a puller socket. This socket may be used to receive messages, but is unable to send them. Attempts to send messages will result in NNG_ENOTSUP.

    @@ -590,12 +103,13 @@ order in which messages are handled is undefined.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_pull_open.3.html b/man/v1.2.2/nng_pull_open.3.html index cd5f179b..6d962951 100644 --- a/man/v1.2.2/nng_pull_open.3.html +++ b/man/v1.2.2/nng_pull_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_pull_open(3) - - - + + -

    NAME

    +

    NAME

    nng_pull_open - create pull socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_pull0_open() function creates a pull version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_pull0_open() function creates a pull version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_pull0_open_raw() function creates a pull version 0 -socket in +

    The nng_pull0_open_raw() function creates a pull version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -586,13 +99,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_socket(5), -nng_pull(7), -nng_push(7), -nng(7)

    +

    nng_socket(5), +nng_pull(7), +nng_push(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_push.7.html b/man/v1.2.2/nng_push.7.html index 2477c45e..13f0b8dd 100644 --- a/man/v1.2.2/nng_push.7.html +++ b/man/v1.2.2/nng_push.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_push(7) - - - + + -

    NAME

    +

    NAME

    nng_push - push protocol

    @@ -541,7 +54,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The push protocol is one half of a pipeline pattern. -The other side is the pull protocol.

    +The other side is the pull protocol.

    In the pipeline pattern, pushers distribute messages to pullers. @@ -553,7 +66,7 @@ This property makes this pattern useful in load-balancing scenarios.

    Socket Operations

    -

    The nng_push0_open() call creates a pusher socket. +

    The nng_push0_open() call creates a pusher socket. This socket may be used to send messages, but is unable to receive them. Attempts to receive messages will result in NNG_ENOTSUP.

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

    SEE ALSO

    -

    nng_push(3), -nng_pull(7), -nng_req(7), -nng(7)

    +

    nng_push(3), +nng_pull(7), +nng_req(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_push_open.3.html b/man/v1.2.2/nng_push_open.3.html index b36d477d..2dc54046 100644 --- a/man/v1.2.2/nng_push_open.3.html +++ b/man/v1.2.2/nng_push_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_push_open(3) - - - + + -

    NAME

    +

    NAME

    nng_push_open - create push socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_push0_open() function creates a push version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_push0_open() function creates a push version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_push0_open_raw() function creates a push version 0 -socket in +

    The nng_push0_open_raw() function creates a push version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -586,13 +99,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_socket(5), -nng_pull(7), -nng_push(7), -nng(7)

    +

    nng_socket(5), +nng_pull(7), +nng_push(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_random.3supp.html b/man/v1.2.2/nng_random.3supp.html index 2093bbba..6a251cc5 100644 --- a/man/v1.2.2/nng_random.3supp.html +++ b/man/v1.2.2/nng_random.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_random(3supp) - - - + + -

    NAME

    +

    NAME

    nng_random - get random number

    @@ -565,10 +78,11 @@ number facilities when available.

    SEE ALSO

    -

    nng(7)

    +

    nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_recv.3.html b/man/v1.2.2/nng_recv.3.html index fb56e4c7..5b9451f7 100644 --- a/man/v1.2.2/nng_recv.3.html +++ b/man/v1.2.2/nng_recv.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_recv(3) - - - + + -

    NAME

    +

    NAME

    nng_recv - recv data

    @@ -556,12 +69,12 @@ 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 +(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().

    +the nng_free() function or passing the message (also +with the NNG_FLAG_ALLOC flag) in a call to nng_send().

    @@ -581,11 +94,11 @@ updated with the actual message body length copied into data.

    The semantics of what receiving a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a req socket a message may only be received -after a request has been sent, and a sub socket +(For example, with a req socket a message may only be received +after a request has been sent, and a sub socket may only receive messages corresponding to topics to which it has subscribed.) Furthermore, some protocols may not support receiving data at all, such as -pub. +pub. @@ -691,15 +204,16 @@ a response using the same flag.

    SEE ALSO

    -

    nng_alloc(3), -nng_free(3), -nng_recvmsg(3), -nng_send(3), -nng_strerror(3), -nng(7)

    +

    nng_alloc(3), +nng_free(3), +nng_recvmsg(3), +nng_send(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_recv_aio.3.html b/man/v1.2.2/nng_recv_aio.3.html index d6a19e2a..f9fe4b51 100644 --- a/man/v1.2.2/nng_recv_aio.3.html +++ b/man/v1.2.2/nng_recv_aio.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_recv_aio(3) - - - + + -

    NAME

    +

    NAME

    nng_recv_aio - receive message asynchronously

    @@ -536,15 +49,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_recv_aio() receives a message using the -socket s asynchronously.

    +

    The nng_recv_aio() receives a message using the +socket s asynchronously.

    When a message is successfully received by the socket, it is stored in the aio by an internal call equivalent to -nng_aio_set_msg(), then the completion +nng_aio_set_msg(), then the completion callback on the aio is executed. -In this case, nng_aio_result() will +In this case, nng_aio_result() will return zero. The callback function is responsible for retrieving the message and disposing of it appropriately.

    @@ -566,7 +79,7 @@ case can lead to memory leaks.

    If for some reason the asynchronous receive cannot be completed successfully (including by being canceled or timing out), then the callback will still be executed, -but nng_aio_result() will be non-zero.

    +but nng_aio_result() will be non-zero.

    @@ -577,12 +90,12 @@ but nng_aio_result() will be n @@ -659,17 +172,18 @@ are replies to requests, until they have first sent a request.)

    SEE ALSO

    -

    nng_aio_get_msg(3), -nng_aio_set_msg(3), -nng_msg_alloc(3), -nng_strerror(3), -nng_aio(5), -nng_msg(5), -nng_socket(5), -nng(7)

    +

    nng_aio_get_msg(3), +nng_aio_set_msg(3), +nng_msg_alloc(3), +nng_strerror(3), +nng_aio(5), +nng_msg(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_recvmsg.3.html b/man/v1.2.2/nng_recvmsg.3.html index 8da3dfa5..ba8ac81e 100644 --- a/man/v1.2.2/nng_recvmsg.3.html +++ b/man/v1.2.2/nng_recvmsg.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_recvmsg(3) - - - + + -

    NAME

    +

    NAME

    nng_recvmsg - recv message

    @@ -547,7 +60,7 @@ received message at the location pointed to by msgp.

    The semantics of what receiving a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a pub socket the data is broadcast, so that +(For example, with a pub socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -nng_recv() or a similar function.) +nng_recv() or a similar function.) Furthermore, some protocols may not support receiving (such as -pub) or may require other conditions. -(For example, req sockets cannot normally receive data, which +pub) or may require other conditions. +(For example, req sockets cannot normally receive data, which are replies to requests, until they have first sent a request.)
    Using this function gives access to the message structure, and thus may -offer more functionality than the simpler nng_recv() function. +offer more functionality than the simpler nng_recv() function.
    @@ -574,11 +87,11 @@ by the socket s, 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. -(For example, with an req socket a message may only be received -after a request has been sent, and an sub socket +(For example, with an req socket a message may only be received +after a request has been sent, and an sub socket may only receive messages corresponding to topics to which it has subscribed.) Furthermore, some protocols may not support receiving data at all, such as -pub. +pub. @@ -662,14 +175,15 @@ Furthermore, some protocols may not support receiving data at all, such as

    SEE ALSO

    -

    nng_msg_free(3), -nng_recv(3), -nng_sendmsg(3), -nng_strerror(3), -nng(7)

    +

    nng_msg_free(3), +nng_recv(3), +nng_sendmsg(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_rep.7.html b/man/v1.2.2/nng_rep.7.html index df95c721..d7f1a12b 100644 --- a/man/v1.2.2/nng_rep.7.html +++ b/man/v1.2.2/nng_rep.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_rep(7) - - - + + -

    NAME

    +

    NAME

    nng_rep - reply protocol

    @@ -561,12 +74,12 @@ a reply is received.

    The rep protocol is the replier side, and the -req protocol is the requester side.

    +req protocol is the requester side.

    Socket Operations

    -

    The nng_rep0_open() functions create a replier socket. +

    The nng_rep0_open() functions create a replier socket. This socket may be used to receive messages (requests), and then to send replies.

    @@ -588,8 +101,8 @@ Any additional concurrent receive operations will result in NNG_ESTATE

    Context Operations

    -

    This protocol supports the creation of contexts for concurrent -use cases using nng_ctx_open().

    +

    This protocol supports the creation of contexts for concurrent +use cases using nng_ctx_open().

    Each context may have at most one outstanding request, and operates @@ -616,7 +129,7 @@ a separate socket.

    The rep protocol uses a backtrace in the header. -This is more fully documented in the req manual.

    +This is more fully documented in the req manual.

    @@ -626,12 +139,13 @@ This is more fully documented in the req

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_rep_open.3.html b/man/v1.2.2/nng_rep_open.3.html index 49d6d379..de91be5f 100644 --- a/man/v1.2.2/nng_rep_open.3.html +++ b/man/v1.2.2/nng_rep_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_rep_open(3) - - - + + -

    NAME

    +

    NAME

    nng_rep_open - create rep socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_rep0_open() function creates a rep version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_rep0_open() function creates a rep version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_rep0_open_raw() function creates a rep version 0 -socket +

    The nng_rep0_open_raw() function creates a rep version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -586,13 +99,14 @@ in raw mode and returns it at the location poi

    SEE ALSO

    -

    nng_socket(5), -nng_rep(7), -nng_req(7), -nng(7)

    +

    nng_socket(5), +nng_rep(7), +nng_req(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_req.7.html b/man/v1.2.2/nng_req.7.html index 4a2befa0..68dce809 100644 --- a/man/v1.2.2/nng_req.7.html +++ b/man/v1.2.2/nng_req.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_req(7) - - - + + -

    NAME

    +

    NAME

    nng_req - request protocol

    @@ -590,7 +103,7 @@ and it will generally attempt to spread work requests to different peer repliers -This property, when combined with nng_device() +This property, when combined with nng_device() can help provide a degree of load-balancing. @@ -598,12 +111,12 @@ can help provide a degree of load-balancing.

    The req protocol is the requester side, and the -rep protocol is the replier side.

    +rep protocol is the replier side.

    Socket Operations

    -

    The nng_req0_open() functions create a requester socket. +

    The nng_req0_open() functions create a requester socket. This socket may be used to send messages (requests), and then to receive replies.

    @@ -630,8 +143,8 @@ that has already been placed on the wire.

    Context Operations

    -

    This protocol supports the creation of contexts for concurrent -use cases using nng_ctx_open().

    +

    This protocol supports the creation of contexts for concurrent +use cases using nng_ctx_open().

    The NNG_OPT_REQ_RESENDTIME value may be configured differently @@ -663,7 +176,7 @@ a separate socket.

    NNG_OPT_REQ_RESENDTIME
    -

    (nng_duration) +

    (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. @@ -690,7 +203,7 @@ significant bit clear.

    When a request message is received by a forwarding node (see -nng_device()), the forwarding node prepends a +nng_device()), the forwarding node prepends a 32-bit peer ID (which must have the most significant bit clear), which is the forwarder’s way of identifying the directly connected peer from which it received the message. @@ -724,15 +237,16 @@ request ID it originally used for the request.

    SEE ALSO

    -

    nng_ctx_open(3), -nng_device(3), -nng_req_open(3), -nng_ctx(5), -nng(7), -nng_rep(7)

    +

    nng_ctx_open(3), +nng_device(3), +nng_req_open(3), +nng_ctx(5), +nng(7), +nng_rep(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_req_open.3.html b/man/v1.2.2/nng_req_open.3.html index 1a6c7cca..e72b20f2 100644 --- a/man/v1.2.2/nng_req_open.3.html +++ b/man/v1.2.2/nng_req_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_req_open(3) - - - + + -

    NAME

    +

    NAME

    nng_req_open - create req socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_req0_open() function creates a req version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_req0_open() function creates a req version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_req0_open_raw() function creates a req version 0 -socket in +

    The nng_req0_open_raw() function creates a req version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -587,14 +100,15 @@ and returns it at the location pointed to by s.

    SEE ALSO

    -

    nng_options(5), -nng_socket(5), -nng_rep(7), -nng_req(7), -nng(7)

    +

    nng_options(5), +nng_socket(5), +nng_rep(7), +nng_req(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_respondent.7.html b/man/v1.2.2/nng_respondent.7.html index b86b1a5a..3d983f60 100644 --- a/man/v1.2.2/nng_respondent.7.html +++ b/man/v1.2.2/nng_respondent.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_respondent(7) - - - + + -

    NAME

    +

    NAME

    nng_respondent - respondent protocol

    @@ -564,12 +77,12 @@ discovery problems.

    The respondent protocol is the respondent side, and the -surveyor protocol is the surveyor side.

    +surveyor protocol is the surveyor side.

    Socket Operations

    -

    The nng_respondent0_open() functions create a +

    The nng_respondent0_open() functions create a respondent socket. This socket may be used to receive messages, and then to send replies. A reply can only be sent after receiving a survey, and generally the @@ -586,8 +99,8 @@ ignore all these restrictions.

    Context Operations

    -

    This protocol supports the creation of contexts for concurrent -use cases using nng_ctx_open().

    +

    This protocol supports the creation of contexts for concurrent +use cases using nng_ctx_open().

    Incoming surveys will be routed to and received by only one context. @@ -620,7 +133,7 @@ production version.)

    The respondent protocol uses a backtrace in the header. -This is more fully documented in the surveyor manual.

    +This is more fully documented in the surveyor manual.

    @@ -629,12 +142,13 @@ This is more fully documented in the surveyor

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_respondent_open.3.html b/man/v1.2.2/nng_respondent_open.3.html index 71550f3e..fe9db98b 100644 --- a/man/v1.2.2/nng_respondent_open.3.html +++ b/man/v1.2.2/nng_respondent_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_respondent_open(3) - - - + + -

    NAME

    +

    NAME

    nng_respondent_open - create respondent socket

    @@ -540,14 +53,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_respondent0_open() function creates a -respondent -version 0 socket and returns it at the location +respondent +version 0 socket and returns it at the location pointed to by s.

    The nng_respondent0_open_raw() function creates a -respondent -version 0 socket in +respondent +version 0 socket in raw mode and returns it at the location pointed to by s.

    @@ -589,13 +102,14 @@ version 0 socket in

    SEE ALSO

    -

    nng_socket(5), -nng_respondent(7), -nng_surveyor(7), -nng(7)

    +

    nng_socket(5), +nng_respondent(7), +nng_surveyor(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_send.3.html b/man/v1.2.2/nng_send.3.html index e813341b..ad6fca14 100644 --- a/man/v1.2.2/nng_send.3.html +++ b/man/v1.2.2/nng_send.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_send(3) - - - + + -

    NAME

    +

    NAME

    nng_send - send data

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_send() function sends a message containing the data of -length size using the socket s.

    +length size using the socket s.

    @@ -548,12 +61,12 @@ length size using the sockets The semantics of what sending a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with an pub socket the data is broadcast, so that +(For example, with an pub socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -nng_recv() or a similar function.) +nng_recv() or a similar function.) Furthermore, some protocols may not support sending data (such as -sub) or may require other conditions. -(For example, rep sockets cannot normally send data, +sub) or may require other conditions. +(For example, rep sockets cannot normally send data, which are responses to requests, until they have first received a request.) @@ -575,12 +88,12 @@ 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 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. +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.

    @@ -610,7 +123,7 @@ Regardless of the presence or absence of NNG_FLAG_NONBLOCK, there m 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, -such as with pub sockets, which are best-effort delivery only. +such as with pub sockets, which are best-effort delivery only.
    @@ -718,16 +231,17 @@ or trans-dimensional mutation of the program’s author.

    SEE ALSO

    -

    nng_alloc(3), -nng_free(3), -nng_recv(3), -nng_sendmsg(3), -nng_strerror(3), -nng_socket(5), -nng(7)

    +

    nng_alloc(3), +nng_free(3), +nng_recv(3), +nng_sendmsg(3), +nng_strerror(3), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_send_aio.3.html b/man/v1.2.2/nng_send_aio.3.html index 06580b70..6858f3bf 100644 --- a/man/v1.2.2/nng_send_aio.3.html +++ b/man/v1.2.2/nng_send_aio.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_send_aio(3) - - - + + -

    NAME

    +

    NAME

    nng_send_aio - send message asynchronously

    @@ -536,17 +49,17 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_send_aio() sends a message using the -socket s asynchronously.

    +

    The nng_send_aio() sends a message using the +socket s asynchronously.

    The message to send must have previously been set on the aio -using the nng_aio_set_msg() function. +using the nng_aio_set_msg() function. The function assumes “ownership” of the message.

    If the message was successfully queued for delivery to the socket, -then the aio will be completed, and nng_aio_result() +then the aio will be completed, and nng_aio_result() will return zero. In this case the socket will dispose of the message when it is finished with it.

    @@ -570,13 +83,13 @@ socket, or in flight over physical media.

    If the operation fails for any reason (including cancellation or timeout), then the aio callback will be executed and -nng_aio_result() +nng_aio_result() will return a non-zero error status. In this case, the callback has a responsibility to retrieve the message from the aio with -nng_aio_get_msg() and dispose of it appropriately. +nng_aio_get_msg() and dispose of it appropriately. (This may include retrying the send operation on the same or a different -socket, or deallocating the message with nng_msg_free().)

    +socket, or deallocating the message with nng_msg_free().)

    @@ -587,12 +100,12 @@ socket, or deallocating the message with nn @@ -677,17 +190,18 @@ are responses to requests, until they have first received a request.)

    SEE ALSO

    -

    nng_aio_get_msg(3), -nng_aio_set_msg(3), -nng_msg_alloc(3), -nng_strerror(3), -nng_aio(5), -nng_msg(5), -nng_socket(5), -nng(7)

    +

    nng_aio_get_msg(3), +nng_aio_set_msg(3), +nng_msg_alloc(3), +nng_strerror(3), +nng_aio(5), +nng_msg(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sendmsg.3.html b/man/v1.2.2/nng_sendmsg.3.html index 21bad4d9..cdd51ce7 100644 --- a/man/v1.2.2/nng_sendmsg.3.html +++ b/man/v1.2.2/nng_sendmsg.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sendmsg(3) - - - + + -

    NAME

    +

    NAME

    nng_sendmsg - send message

    @@ -557,7 +70,7 @@ another socket, or simply trying again later.

    The semantics of what sending a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a pub socket the data is broadcast, so that +(For example, with a pub socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -nng_recv() or a similar function.) +nng_recv() or a similar function.) Furthermore, some protocols may not support sending (such as -sub) or may require other conditions. -(For example, rep sockets cannot normally send data, which +sub) or may require other conditions. +(For example, rep sockets cannot normally send data, which are responses to requests, until they have first received a request.)
    Using this function gives access to the message structure, and may -offer more functionality than the simpler nng_send() function. +offer more functionality than the simpler nng_send() function.
    @@ -571,12 +84,12 @@ offer more functionality than the simpler nng_s The semantics of what sending a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with a pub socket the data is broadcast, so that +(For example, with a pub socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -nng_recv() or a similar function.) +nng_recv() or a similar function.) Furthermore, some protocols may not support sending (such as -sub) or may require other conditions. -(For example, rep sockets cannot normally send data, which +sub) or may require other conditions. +(For example, rep sockets cannot normally send data, which are responses to requests, until they have first received a request.) @@ -610,7 +123,7 @@ Regardless of the presence or absence of NNG_FLAG_NONBLOCK, there m 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, -such as with pub sockets, which are best-effort delivery only. +such as with pub sockets, which are best-effort delivery only. @@ -702,16 +215,17 @@ such as with pub sockets, which are best-

    SEE ALSO

    -

    nng_msg_alloc(3), -nng_recvmsg(3), -nng_send(3), -nng_strerror(3), -nng_msg(5), -nng_socket(5), -nng(7)

    +

    nng_msg_alloc(3), +nng_recvmsg(3), +nng_send(3), +nng_strerror(3), +nng_msg(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_setopt.3.html b/man/v1.2.2/nng_setopt.3.html index d6fd9c5b..248bf4f9 100644 --- a/man/v1.2.2/nng_setopt.3.html +++ b/man/v1.2.2/nng_setopt.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_setopt(3) - - - + + -

    NAME

    +

    NAME

    nng_setopt - set socket option

    @@ -560,7 +73,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -These functions are deprecated. Please see nng_socket_set. +These functions are deprecated. Please see nng_socket_set. @@ -571,7 +84,7 @@ The nng_setopt() functions are used to configure options for the socket s. The actual options that may be configured in this way vary, and are specified by opt. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    Additionally some transport-specific and protocol-specific options are @@ -620,7 +133,7 @@ The ival is passed to the option.

    nng_setopt_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_setopt_ptr()
    @@ -628,7 +141,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -733,16 +246,17 @@ and similar.

    SEE ALSO

    -

    nng_getopt(3), -nng_dialer_setopt(3), -nng_listener_setopt(3), -nng_strerror(3), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_getopt(3), +nng_dialer_setopt(3), +nng_listener_setopt(3), +nng_strerror(3), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sleep_aio.3.html b/man/v1.2.2/nng_sleep_aio.3.html index c041de8f..0f10a8cb 100644 --- a/man/v1.2.2/nng_sleep_aio.3.html +++ b/man/v1.2.2/nng_sleep_aio.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sleep_aio(3) - - - + + -

    NAME

    +

    NAME

    nng_sleep_aio - sleep asynchronously

    @@ -548,7 +61,7 @@ If the sleep finishes completely, the result will always be zero.

    If a timeout is set on aio using -nng_aio_set_timeout(), and it is shorter +nng_aio_set_timeout(), and it is shorter than msec, then the sleep will wake up early, with a result code of NNG_ETIMEDOUT. @@ -577,16 +90,17 @@ then the sleep will wake up early, with a result code of NNG_ETIMEDOUTSEE ALSO
    -

    nng_aio_abort(3), -nng_aio_alloc(3), -nng_aio_set_timeout(3), -nng_strerror(3), -nng_aio(5), -nng_duration(5), -nng(7)

    +

    nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio_set_timeout(3), +nng_strerror(3), +nng_aio(5), +nng_duration(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr.5.html b/man/v1.2.2/nng_sockaddr.5.html index ab602ad1..07059860 100644 --- a/man/v1.2.2/nng_sockaddr.5.html +++ b/man/v1.2.2/nng_sockaddr.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr - socket address

    @@ -560,8 +73,8 @@ addresses, IPC paths, and so forth.

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

    @@ -594,7 +107,7 @@ specific member should be used.

    NNG_AF_INPROC -

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

    +

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

    @@ -602,7 +115,7 @@ specific member should be used.

    NNG_AF_IPC -

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

    +

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

    @@ -626,7 +139,7 @@ specific member should be used.

    NNG_AF_ZT -

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

    +

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

    @@ -640,15 +153,16 @@ specific member should be used.

    SEE ALSO

    -

    nng_sockaddr_in(5), -nng_sockaddr_in6(5), -nng_sockaddr_inproc(5), -nng_sockaddr_ipc(5), -nng_sockaddr_zt(5), -nng(7)

    +

    nng_sockaddr_in(5), +nng_sockaddr_in6(5), +nng_sockaddr_inproc(5), +nng_sockaddr_ipc(5), +nng_sockaddr_zt(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr_in.5.html b/man/v1.2.2/nng_sockaddr_in.5.html index 85402b46..3116572d 100644 --- a/man/v1.2.2/nng_sockaddr_in.5.html +++ b/man/v1.2.2/nng_sockaddr_in.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr_in(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr_in - IPv4 socket address

    @@ -543,13 +56,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    -An nng_sockaddr_in is the flavor of nng_sockaddr +An nng_sockaddr_in is the flavor of nng_sockaddr used to represent TCP (and sometimes UDP) addresses, including the Internet Protocol (IP) address and port number.

    This structure is used with IPv4 addresses. -A different structure, nng_sockaddr_in6, is used +A different structure, nng_sockaddr_in6, is used for IPv6 addresses.

    @@ -607,13 +120,14 @@ This field appears similar to BSD sockaddr_in, but it is

    SEE ALSO

    -

    nng_sockaddr(5), -nng_sockaddr_in6(5), -nng_tcp(7), -nng(7)

    +

    nng_sockaddr(5), +nng_sockaddr_in6(5), +nng_tcp(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr_in6.5.html b/man/v1.2.2/nng_sockaddr_in6.5.html index 139c9075..c8986a7b 100644 --- a/man/v1.2.2/nng_sockaddr_in6.5.html +++ b/man/v1.2.2/nng_sockaddr_in6.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr_in6(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr_in6 - IPv6 socket address

    @@ -543,13 +56,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    -An nng_sockaddr_in6 is the flavor of nng_sockaddr +An nng_sockaddr_in6 is the flavor of nng_sockaddr used to represent TCP (and sometimes UDP) addresses, including the Internet Protocol (IP) address and port number.

    This structure is used with IPv6 addresses. -A different structure, nng_sockaddr_in, is used +A different structure, nng_sockaddr_in, is used for IPv4 addresses.

    @@ -607,13 +120,14 @@ This field appears similar to BSD sockaddr_in6, but it is

    SEE ALSO

    -

    nng_sockaddr(5), -nng_sockaddr_in(5), -nng_tcp(7), -nng(7)

    +

    nng_sockaddr(5), +nng_sockaddr_in(5), +nng_tcp(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr_inproc.5.html b/man/v1.2.2/nng_sockaddr_inproc.5.html index 764bf21f..9114550b 100644 --- a/man/v1.2.2/nng_sockaddr_inproc.5.html +++ b/man/v1.2.2/nng_sockaddr_inproc.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr_inproc(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr_inproc - inproc socket address

    @@ -542,9 +55,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    -An nng_sockaddr_inproc is the flavor of nng_sockaddr +An nng_sockaddr_inproc is the flavor of nng_sockaddr used to represent addresses associated with intra-process communication -using the inproc transport.

    +using the inproc transport.

    The following structure members are present:

    @@ -584,12 +97,13 @@ Furthermore, the size is guaranteed to be at least 128.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr_ipc.5.html b/man/v1.2.2/nng_sockaddr_ipc.5.html index 2d559523..97e541c7 100644 --- a/man/v1.2.2/nng_sockaddr_ipc.5.html +++ b/man/v1.2.2/nng_sockaddr_ipc.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr_ipc(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr_ipc - IPC socket address

    @@ -542,9 +55,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    -An nng_sockaddr_ipc is the flavor of nng_sockaddr +An nng_sockaddr_ipc is the flavor of nng_sockaddr used to represent addresses associated with IPC communication -using the ipc transport.

    +using the ipc transport.

    The following structure members are present:

    @@ -616,12 +129,13 @@ longer than 128 bytes, including the ipc:// prefix.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sockaddr_zt.5.html b/man/v1.2.2/nng_sockaddr_zt.5.html index 17675dc7..51a6e872 100644 --- a/man/v1.2.2/nng_sockaddr_zt.5.html +++ b/man/v1.2.2/nng_sockaddr_zt.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_sockaddr_zt(5) - - - + + -

    NAME

    +

    NAME

    nng_sockaddr_zt - ZeroTier socket address

    @@ -544,10 +57,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    -An nng_sockaddr_zt is the flavor of nng_sockaddr +An nng_sockaddr_zt is the flavor of nng_sockaddr used to represent ZeroTier addresses, including the port number used by the -zt transport.

    +zt transport.

    @@ -589,7 +102,7 @@ caller’s own node number be used.

    sa_port

    This field holds the “port number” used by the -zt transport to distinguish different +zt transport to distinguish different sockets. This value in native byte order. A zero value here indicates that a port number should be chosen @@ -619,12 +132,13 @@ the Scalability Protocols binding for them.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_socket.5.html b/man/v1.2.2/nng_socket.5.html index 7d956dd1..82e497f3 100644 --- a/man/v1.2.2/nng_socket.5.html +++ b/man/v1.2.2/nng_socket.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_socket(5) - - - + + -

    NAME

    +

    NAME

    nng_socket - socket handle

    @@ -541,9 +54,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_socket is a handle to an underlying “socket” object. All communication between the application and remote Scalability Protocol peers is done through sockets. -A given socket can have multiple dialers (nng_dialer) -and/or listeners (nng_listener), and multiple -pipes (nng_pipe), and +A given socket can have multiple dialers (nng_dialer) +and/or listeners (nng_listener), and multiple +pipes (nng_pipe), and may be connected to multiple transports at the same time. However, a given socket will have exactly one “protocol” associated with it, and is responsible for any state machines or other protocol-specific logic.

    @@ -565,9 +78,9 @@ accurate type checks in functions passing values of this type.

    Each nng_socket is created by a protocol-specific constructor, such as -nng_rep_open(). +nng_rep_open(). When the socket is no longer needed, it can be closed with -nng_close().

    +nng_close().

    Initialization

    @@ -590,18 +103,19 @@ before it is opened, to prevent confusion with valid open sockets.

    SEE ALSO

    -

    libnng(3), -nng_close(3), -nng_getopt(3), -nng_setopt(3), -nng_socket_id(3), -nng_dialer(5), -nng_listener(5), -nng_options(5), -nng(7)

    +

    libnng(3), +nng_close(3), +nng_getopt(3), +nng_setopt(3), +nng_socket_id(3), +nng_dialer(5), +nng_listener(5), +nng_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_socket_get.3.html b/man/v1.2.2/nng_socket_get.3.html index b52cc871..7fb02eb8 100644 --- a/man/v1.2.2/nng_socket_get.3.html +++ b/man/v1.2.2/nng_socket_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_socket_get(3) - - - + + -

    NAME

    +

    NAME

    nng_socket_get - get socket option

    @@ -558,9 +71,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_socket_get() functions are used to retrieve option values for -the socket s. +the socket s. The actual options that may be retrieved in this way vary. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    Additionally transport-specific options and protocol-specific options are @@ -623,7 +136,7 @@ The value will be stored at ivalp.

    nng_socket_get_ms()
    -

    This function is used to retrieve time durations +

    This function is used to retrieve time durations (such as timeouts), stored in durp as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -643,9 +156,9 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_socket_get_string()

    This function is used to retrieve a string into strp. -This string is created from the source using nng_strdup() +This string is created from the source using nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_socket_get_uint64()
    @@ -728,20 +241,21 @@ numbers, and similar.

    SEE ALSO

    -

    nng_dialer_get(3), -nng_listener_get(3), -nng_pipe_get(3), -nng_socket_set(3), -nng_strdup(3), -nng_strerror(3), -nng_strfree(3), -nng_duration(5), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_dialer_get(3), +nng_listener_get(3), +nng_pipe_get(3), +nng_socket_set(3), +nng_strdup(3), +nng_strerror(3), +nng_strfree(3), +nng_duration(5), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_socket_id.3.html b/man/v1.2.2/nng_socket_id.3.html index b32265c3..2d4d2207 100644 --- a/man/v1.2.2/nng_socket_id.3.html +++ b/man/v1.2.2/nng_socket_id.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_socket_id(3) - - - + + -

    NAME

    +

    NAME

    nng_socket_id - return numeric socket identifier

    @@ -548,7 +61,7 @@ Otherwise it returns -1.

    @@ -577,14 +90,15 @@ of NNG_STAT_SCOPE will have children.

    SEE ALSO

    -

    libnng(3), -nng_stat_next(3), -nng_stats_get(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stat_next(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_desc.3.html b/man/v1.2.2/nng_stat_desc.3.html index f4b36aa5..c60fb305 100644 --- a/man/v1.2.2/nng_stat_desc.3.html +++ b/man/v1.2.2/nng_stat_desc.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_desc(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_desc - get statistic description

    @@ -588,14 +101,15 @@ At this time, only English descriptions are provided.

    SEE ALSO

    -

    libnng(3), -nng_stats_name(3), -nng_stats_get(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_name(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_name.3.html b/man/v1.2.2/nng_stat_name.3.html index 02482948..d3f26f67 100644 --- a/man/v1.2.2/nng_stat_name.3.html +++ b/man/v1.2.2/nng_stat_name.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_name(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_name - get statistic name

    @@ -574,13 +87,14 @@ The global root statistic will have the empty string ("") as it’s name.

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_next.3.html b/man/v1.2.2/nng_stat_next.3.html index 87c8ff02..9e685c3f 100644 --- a/man/v1.2.2/nng_stat_next.3.html +++ b/man/v1.2.2/nng_stat_next.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_next(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_next - get next statistic

    @@ -564,14 +77,15 @@ If no more siblings are present, then NULL is returned.

    SEE ALSO

    -

    libnng(3), -nng_stat_child(3), -nng_stats_get(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stat_child(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_string.3.html b/man/v1.2.2/nng_stat_string.3.html index 4063ec91..30a0932d 100644 --- a/man/v1.2.2/nng_stat_string.3.html +++ b/man/v1.2.2/nng_stat_string.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_string(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_string - get statistic string value

    @@ -539,7 +52,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stat_string() function returns a string value for the statistic stat, -which must be of type NNG_STAT_STRING (see nng_stat_type(3)).

    +which must be of type NNG_STAT_STRING (see nng_stat_type(3)).

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

    @@ -567,15 +80,16 @@ a string type.

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stats_type(3), -nng_stats_value(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stats_type(3), +nng_stats_value(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_timestamp.3.html b/man/v1.2.2/nng_stat_timestamp.3.html index d2383d79..22e9f561 100644 --- a/man/v1.2.2/nng_stat_timestamp.3.html +++ b/man/v1.2.2/nng_stat_timestamp.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_timestamp(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_timestamp - get statistic timestamp

    @@ -567,7 +80,7 @@ comparing values from one snapshot with a subsequent one. @@ -596,15 +109,16 @@ milliseconds since some time in the past.

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stat_value(3), -nng_clock(3supp), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stat_value(3), +nng_clock(3supp), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_type.3.html b/man/v1.2.2/nng_stat_type.3.html index b10faded..cb995513 100644 --- a/man/v1.2.2/nng_stat_type.3.html +++ b/man/v1.2.2/nng_stat_type.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_type(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_type - get statistic type

    @@ -558,7 +71,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    This is a placeholder providing scope, and carries no value on its own. Instead it is a parent node with child statistics (see -nng_stat_child().)

    +nng_stat_child().)

    NNG_STAT_LEVEL
    @@ -577,13 +90,13 @@ divided by the interval over which the change occurred.)

    NNG_STAT_STRING

    This is a string, and carries no numeric value. -Instead the nng_stat_string() function +Instead the nng_stat_string() function should be used to obtain the value.

    NNG_STAT_BOOLEAN

    This is a boolean value. -The nng_stat_value() function will return zero +The nng_stat_value() function will return zero to represent a false value, and one to represent a true value.

    @@ -602,7 +115,7 @@ be used with another interface.

    @@ -630,16 +143,17 @@ detail about the units measured by the static.

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stat_string(3), -nng_stat_unit(3), -nng_stat_value(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stat_string(3), +nng_stat_unit(3), +nng_stat_value(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_unit.3.html b/man/v1.2.2/nng_stat_unit.3.html index 5e4dd310..45f9980f 100644 --- a/man/v1.2.2/nng_stat_unit.3.html +++ b/man/v1.2.2/nng_stat_unit.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stat_unit(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_unit - get statistic unit

    @@ -558,7 +71,7 @@ by the statistic stat.

    There are no particular units measured. In some cases there may be units, but the type of the unit will be obvious -from the name (see nng_stat_name()) of the statistic.

    +from the name (see nng_stat_name()) of the statistic.

    NNG_UNIT_BYTES
    @@ -567,7 +80,7 @@ from the name (see nng_stat_name()<
    NNG_UNIT_MESSAGES

    The statistic is a count of messages. -Typically, one message corresponds to a single nng_msg structure.

    +Typically, one message corresponds to a single nng_msg structure.

    NNG_UNIT_MILLIS
    @@ -581,7 +94,7 @@ Typically, one message corresponds to a single n

    For statistics that are neither NNG_STAT_COUNTER nor NNG_STAT_LEVEL -type (see nng_stat_type()), the unit will +type (see nng_stat_type()), the unit will generally be NNG_UNIT_NONE.

    @@ -620,17 +133,18 @@ meaningless.

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stat_name(3), -nng_stat_type(3), -nng_stat_value(3), -nng_msg(5), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stat_name(3), +nng_stat_type(3), +nng_stat_value(3), +nng_msg(5), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_value.3.html b/man/v1.2.2/nng_stat_value.3.html index a2b4cee6..2584b4b3 100644 --- a/man/v1.2.2/nng_stat_value.3.html +++ b/man/v1.2.2/nng_stat_value.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stat_value(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_value - get statistic value

    @@ -542,7 +55,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b If the statistic has a boolean value, then zero is returned for false, and one is returned for true. Otherwise, if the statistic is not of numeric type, then zero is returned. -See nng_stat_type() for a description of statistic types.

    +See nng_stat_type() for a description of statistic types.

    @@ -566,15 +79,16 @@ See nng_stat_type() for a descr

    SEE ALSO

    -

    libnng(3), -nng_stats_get(3), -nng_stat_type(3), -nng_stat_unit(3), -nng_stat(5), -nng(7)

    +

    libnng(3), +nng_stats_get(3), +nng_stat_type(3), +nng_stat_unit(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stats_free.3.html b/man/v1.2.2/nng_stats_free.3.html index 001c5743..323ebeb2 100644 --- a/man/v1.2.2/nng_stats_free.3.html +++ b/man/v1.2.2/nng_stats_free.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stats_free(3) - - - + + -

    NAME

    +

    NAME

    nng_stats_free - free statistics snapshot

    @@ -540,7 +53,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stats_free() function deallocates a statistics snapshot previously collected with -nng_stats_get(). +nng_stats_get(). After calling this, all values associated with the snapshot are invalidated.

    @@ -579,12 +92,13 @@ freed using this function.

    SEE ALSO

    -

    nng_stats_get(3), -nng_stat(5), -nng(7)

    +

    nng_stats_get(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stats_get.3.html b/man/v1.2.2/nng_stats_get.3.html index fb1657a0..8852082c 100644 --- a/man/v1.2.2/nng_stats_get.3.html +++ b/man/v1.2.2/nng_stats_get.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stats_get(3) - - - + + -

    NAME

    +

    NAME

    nng_stats_get - get statistics snapshot

    @@ -561,13 +74,13 @@ has an empty name. This parent statistic is returned through the statsp pointer.

    -

    The nng_stat_child() and -nng_stat_next() function can be used to +

    The nng_stat_child() and +nng_stat_next() function can be used to iterate over the the tree.

    When no longer needed, the statistics can be freed with the -nng_stats_free() function, but that +nng_stats_free() function, but that function must be called only with the root statistic that is returned through the statsp pointer.

    @@ -643,21 +156,22 @@ and NULL otherwise.

    SEE ALSO

    -

    nng_stats_free(3), -nng_stat_child(3), -nng_stat_desc(3), -nng_stat_name(3), -nng_stat_next(3), -nng_stat_string(3), -nng_stat_type(3), -nng_stat_timestamp(3), -nng_stat_unit(3), -nng_stat_value(3), -nng_stat(5), -nng(7)

    +

    nng_stats_free(3), +nng_stat_child(3), +nng_stat_desc(3), +nng_stat_name(3), +nng_stat_next(3), +nng_stat_string(3), +nng_stat_type(3), +nng_stat_timestamp(3), +nng_stat_unit(3), +nng_stat_value(3), +nng_stat(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_strdup.3.html b/man/v1.2.2/nng_strdup.3.html index 9d750609..629f6a44 100644 --- a/man/v1.2.2/nng_strdup.3.html +++ b/man/v1.2.2/nng_strdup.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_strdup(3) - - - + + -

    NAME

    +

    NAME

    nng_strdup - duplicate string

    @@ -539,15 +52,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

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

    -

    This is logically equivalent to using nng_alloc() +

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

    The returned string should be deallocated with -nng_strfree(), or may be deallocated using the -nng_free() using the length of the returned string plus +nng_strfree(), or may be deallocated using the +nng_free() using the length of the returned string plus one (for the NUL terminating byte).

    @@ -586,12 +99,13 @@ treated the same as NNG_ENOMEM.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream.5.html b/man/v1.2.2/nng_stream.5.html index f5d8cc7f..4547a9ac 100644 --- a/man/v1.2.2/nng_stream.5.html +++ b/man/v1.2.2/nng_stream.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream(5) - - - + + -

    NAME

    +

    NAME

    nng_stream - byte stream

    @@ -547,9 +60,9 @@ a connected UNIX domain socket or named pipe.

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

    SEE ALSO

    -

    nng_socket(5), -nng(7)

    +

    nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_socket_set.3.html b/man/v1.2.2/nng_socket_set.3.html index 62b75b64..15fb8059 100644 --- a/man/v1.2.2/nng_socket_set.3.html +++ b/man/v1.2.2/nng_socket_set.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_socket_set(3) - - - + + -

    NAME

    +

    NAME

    nng_socket_set - set socket option

    @@ -559,7 +72,7 @@ The nng_socket_set() functions are used to configure options for the socket s. The actual options that may be configured in this way vary, and are specified by opt. -A number of them are documented in nng_options(5).

    +A number of them are documented in nng_options(5).

    Additionally some transport-specific and protocol-specific options are @@ -608,7 +121,7 @@ The ival is passed to the option.

    nng_socket_set_ms()

    This function is used to configure time durations (such as timeouts) using -type nng_duration. +type nng_duration. The duration dur is an integer number of milliseconds.

    nng_socket_set_ptr()
    @@ -616,7 +129,7 @@ The duration dur is an integer number of milliseconds.

    This function is used to pass a pointer, ptr, to structured data. The data referenced by ptr is generally managed by other functions. For example, TLS configuration objects created with -(nng_tls_config_alloc()) +(nng_tls_config_alloc()) can be passed this way.

    @@ -721,16 +234,17 @@ and similar.

    SEE ALSO

    -

    nng_socket_get(3), -nng_dialer_set(3), -nng_listener_set(3), -nng_strerror(3), -nng_options(5), -nng_socket(5), -nng(7)

    +

    nng_socket_get(3), +nng_dialer_set(3), +nng_listener_set(3), +nng_strerror(3), +nng_options(5), +nng_socket(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat.5.html b/man/v1.2.2/nng_stat.5.html index 9d9f7466..06b5d0c2 100644 --- a/man/v1.2.2/nng_stat.5.html +++ b/man/v1.2.2/nng_stat.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stat(5) - - - + + -

    NAME

    +

    NAME

    nng_stat - statistic

    @@ -535,36 +48,36 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_stat represents a statistic. -All statistics have names (nng_stat_name()) and -descriptions (nng_stat_desc()), and are -typed (nng_stat_type()).

    +All statistics have names (nng_stat_name()) and +descriptions (nng_stat_desc()), and are +typed (nng_stat_type()).

    Most statistics are numeric, -and thus carry a value (nng_stat_value()) -and frequently also a unit that the value measures (nng_stat_unit()).

    +and thus carry a value (nng_stat_value()) +and frequently also a unit that the value measures (nng_stat_unit()).

    -

    Some statistics however, are simply strings (nng_stat_string()), +

    Some statistics however, are simply strings (nng_stat_string()), and thus carry no numeric value.

    Statistics are organized as a tree, and any given statistic can have siblings -(nng_stat_next()). +(nng_stat_next()). Note however that generally only NNG_STAT_SCOPE statistics, which are act as placeholders in the tree (and carry no value), -will have children (nng_stat_child()).

    +will have children (nng_stat_child()).

    -

    A tree of statistics is collected using nng_stats_get(), -and can be freed when no longer needed with nng_stats_free(). +

    A tree of statistics is collected using nng_stats_get(), +and can be freed when no longer needed with nng_stats_free(). This collection process is generally performed in a way to minimize impact to running operations, but there is still some impact caused by collection of statistics.

    The time when a statistic’s value is captured can be obtained using -nng_stat_timestamp(), which is useful for +nng_stat_timestamp(), which is useful for measuring rates of change in certain statistics.

    @@ -601,22 +114,23 @@ in order to reduce program size and run-time overheads.

    SEE ALSO

    -

    libnng(3), -nng_stats_free(3), -nng_stats_get(3), -nng_stat_child(3), -nng_stat_desc(3), -nng_stat_name(3), -nng_stat_next(3), -nng_stat_string(3), -nng_stat_timestamp(3), -nng_stat_type(3), -nng_stat_unit(3), -nng_stat_value(3), -nng(7)

    +

    libnng(3), +nng_stats_free(3), +nng_stats_get(3), +nng_stat_child(3), +nng_stat_desc(3), +nng_stat_name(3), +nng_stat_next(3), +nng_stat_string(3), +nng_stat_timestamp(3), +nng_stat_type(3), +nng_stat_unit(3), +nng_stat_value(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stat_child.3.html b/man/v1.2.2/nng_stat_child.3.html index 5a3e8aaa..4ca3685c 100644 --- a/man/v1.2.2/nng_stat_child.3.html +++ b/man/v1.2.2/nng_stat_child.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stat_child(3) - - - + + -

    NAME

    +

    NAME

    nng_stat_child - get child statistic

    @@ -549,7 +62,7 @@ If no children are present, then NULL is returned.

    		 -Only statistics with type (see nng_stat_type()) +Only statistics with type (see nng_stat_type()) of NNG_STAT_SCOPE will have children.
    The values used here have the same offset as the -nng_clock() supplemental function. +nng_clock() supplemental function. This can be useful when converting these values to local clock time.
    For NNG_STAT_COUNTER and NNG_STAT_LEVEL statistics, the -nng_stat_unit() function will provide more +nng_stat_unit() function will provide more detail about the units measured by the static.
    The nng_stream object is used for raw byte stream connections, and should not be confused with a pipe object created on -socket using the -nng_listen(), -nng_dial() or related functions. +socket using the +nng_listen(), +nng_dial() or related functions.
    @@ -557,9 +70,9 @@ should not be confused with a pipe object created on

    These objects are created either establishing an outgoing connection with -nng_stream_dialer_dial() +nng_stream_dialer_dial() or by accepting in incoming connection with -nng_stream_listener_accept().

    +nng_stream_listener_accept().

    Byte streams are “reliable” in that data @@ -567,13 +80,13 @@ will not be delivered out of order, or with portions missing.

    Data can be sent using -nng_stream_send() or +nng_stream_send() or received with -nng_stream_recv().

    +nng_stream_recv().

    When the connection is no longer needed, it should be freed with -nng_stream_free().

    +nng_stream_free().

    @@ -584,7 +97,7 @@ received with
    It is possible to close the connection, without freeing it, by using -nng_stream_close(). +nng_stream_close().
    @@ -592,10 +105,10 @@ using

    Byte streams may, depending on the underlying technology, support various -options, which +options, which can be accessed using the -nng_stream_get() and -nng_stream_set() family of +nng_stream_get() and +nng_stream_set() family of functions.

    @@ -604,20 +117,21 @@ functions.

    SEE ALSO

    -

    libnng(3), -nng_stream_close(3str), -nng_stream_dialer_dial(3str), -nng_stream_free(3str), -nng_stream_getopt(3str), -nng_stream_listener_accept(3str), -nng_stream_recv(3str), -nng_stream_send(3str), -nng_stream_setopt(3str), -nng_options(5), -nng(7),

    +

    libnng(3), +nng_stream_close(3str), +nng_stream_dialer_dial(3str), +nng_stream_free(3str), +nng_stream_getopt(3str), +nng_stream_listener_accept(3str), +nng_stream_recv(3str), +nng_stream_send(3str), +nng_stream_setopt(3str), +nng_options(5), +nng(7),

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_close.3str.html b/man/v1.2.2/nng_stream_close.3str.html index caf20162..0f995fa0 100644 --- a/man/v1.2.2/nng_stream_close.3str.html +++ b/man/v1.2.2/nng_stream_close.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_close(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_close - close byte stream

    @@ -537,13 +50,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_close() function closes the -byte stream s.

    +byte stream s.

    If any operations are pending, such as -nng_stream_send() +nng_stream_send() or -nng_stream_recv(), +nng_stream_recv(), they will be terminated with an NNG_ECLOSED error condition. Also, any new operations will fail with NNG_ECLOSED after the connection @@ -574,7 +87,7 @@ have completely transmitted. Closing the connection does not free the resources associated with it. Once it is certain that no more operations are pending on the connection, it should be freed with -nng_stream_free(). +nng_stream_free(). @@ -601,14 +114,15 @@ it should be freed with

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_free(3str), -nng_stream_recv(3str), -nng_stream_send(3str), -nng_stream(5)

    +

    nng_strerror(3), +nng_stream_free(3str), +nng_stream_recv(3str), +nng_stream_send(3str), +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer.5.html b/man/v1.2.2/nng_stream_dialer.5.html index c2170529..9066dba4 100644 --- a/man/v1.2.2/nng_stream_dialer.5.html +++ b/man/v1.2.2/nng_stream_dialer.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer(5) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer - byte stream dialer

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    An nng_stream_dialer is a handle to a “dialer” for byte streams, and is responsible for creating -nng_stream objects (corresponding to connected byte +nng_stream objects (corresponding to connected byte streams) by connecting to remote peers.

    @@ -549,7 +62,7 @@ streams) by connecting to remote peers.

    The nng_stream_dialer object is used for low-level byte stream connections, and should not be confused with a high-level -nng_dialer object. +nng_dialer object. @@ -560,15 +73,16 @@ connections, and should not be confused with a high-level

    SEE ALSO

    -

    nng_stream_dialer_alloc(3str), -nng_stream_dialer_close(3str), -nng_stream_dialer_dial(3str), -nng_stream_dialer_free(3str), -nng_stream(5), -nng_stream_listener(5)

    +

    nng_stream_dialer_alloc(3str), +nng_stream_dialer_close(3str), +nng_stream_dialer_dial(3str), +nng_stream_dialer_free(3str), +nng_stream(5), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_alloc.3str.html b/man/v1.2.2/nng_stream_dialer_alloc.3str.html index 5f437ed5..aaf1267d 100644 --- a/man/v1.2.2/nng_stream_dialer_alloc.3str.html +++ b/man/v1.2.2/nng_stream_dialer_alloc.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_alloc(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer_alloc - allocate byte stream dialer

    @@ -540,9 +53,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    These functions allocates a dialer for byte streams. Dialers create -nng_stream objects by initiating outgoing +nng_stream objects by initiating outgoing connections, via the -nng_stream_dialer_dial() function.

    +nng_stream_dialer_dial() function.

    The first form, nng_stream_dialer_alloc(), connects to the address @@ -551,7 +64,7 @@ specified by addr, which should be a string representing a URL.

    The second form, nng_stream_dialer_alloc_url(), takes a pre-parsed or pre-constructed -nng_url object to determine the remote address.

    +nng_url object to determine the remote address.

    These functions may support different URL schemes, such as @@ -607,16 +120,17 @@ or pre-constructed

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_close(3str) -nng_stream_dialer_dial(3str) -nng_stream_dialer_free(3str) -nng_stream_dialer_get(3str) -nng_stream_dialer_set(3str) -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_close(3str) +nng_stream_dialer_dial(3str) +nng_stream_dialer_free(3str) +nng_stream_dialer_get(3str) +nng_stream_dialer_set(3str) +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_close.3str.html b/man/v1.2.2/nng_stream_dialer_close.3str.html index 9e8511da..0d50d195 100644 --- a/man/v1.2.2/nng_stream_dialer_close.3str.html +++ b/man/v1.2.2/nng_stream_dialer_close.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_close(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer_close - close byte stream dialer

    @@ -542,7 +55,7 @@ but does not free the underlying resources associated with it.

    If any -dial +dial operations using d are in progress, they will be terminated with an NNG_ECLOSED error condition.

    @@ -559,7 +72,7 @@ in progress, they will be terminated with an NNG_ECLOSED error cond This function does not release the memory for the dialer, so the application should still free the memory using -nng_stream_dialer_free() +nng_stream_dialer_free() once it is certain that nothing else is using it. @@ -587,14 +100,15 @@ once it is certain that nothing else is using it.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_alloc(3str), -nng_stream_dialer_dial(3str), -nng_stream_dialer_free(3str), -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_alloc(3str), +nng_stream_dialer_dial(3str), +nng_stream_dialer_free(3str), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_dial.3str.html b/man/v1.2.2/nng_stream_dialer_dial.3str.html index 64e790c4..02173f6d 100644 --- a/man/v1.2.2/nng_stream_dialer_dial.3str.html +++ b/man/v1.2.2/nng_stream_dialer_dial.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_dial(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer_dial - initiate outgoing byte stream connection

    @@ -548,8 +61,8 @@ The operation is completed asynchronously, using aio.

    The peer address is determined by the address specified using -nng_stream_dialer_alloc() or -nng_stream_dialer_alloc_url(). +nng_stream_dialer_alloc() or +nng_stream_dialer_alloc_url(). @@ -557,9 +70,9 @@ The peer address is determined by the address specified using

    If a connection is successfully established, the aio will have the resulting -nng_stream object stored as its first output. +nng_stream object stored as its first output. (See -nng_aio_get_output().)

    +nng_aio_get_output().)

    @@ -632,16 +145,17 @@ resulting

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_alloc(3str), -nng_stream_dialer_close(3str), -nng_stream_dialer_free(3str), -nng_aio(5), -nng_stream(5), -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_alloc(3str), +nng_stream_dialer_close(3str), +nng_stream_dialer_free(3str), +nng_aio(5), +nng_stream(5), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_free.3str.html b/man/v1.2.2/nng_stream_dialer_free.3str.html index c3411ff3..a24cacb2 100644 --- a/man/v1.2.2/nng_stream_dialer_free.3str.html +++ b/man/v1.2.2/nng_stream_dialer_free.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_free(3str) - - - + + -
    -

    NAME

    -

    nng_stream_dialer_free - free byte stream dialer

    -
    +

    SYNOPSIS

    @@ -551,7 +55,7 @@ and frees the underlying resources associated with it.

    If any -dial operations using d are +dial operations using d are in progress, they will be terminated with an NNG_ECLOSED error condition.

    @@ -589,14 +93,15 @@ are made to d, as the memory backing it will be reclaimed for other use

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_alloc(3str), -nng_stream_dialer_close(3str), -nng_stream_dialer_dial(3str), -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_alloc(3str), +nng_stream_dialer_close(3str), +nng_stream_dialer_dial(3str), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_get.3str.html b/man/v1.2.2/nng_stream_dialer_get.3str.html index bc8a6fe1..4d006456 100644 --- a/man/v1.2.2/nng_stream_dialer_get.3str.html +++ b/man/v1.2.2/nng_stream_dialer_get.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_get(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer_get - get option from byte stream dialer

    @@ -557,12 +70,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_dialer_get() functions are used to retrieve option values for the -byte stream dialer d.

    +byte stream dialer d.

    The actual options that may be retrieved in this way vary. A number of them are documented in -nng_options(5) and additional linked documents.

    +nng_options(5) and additional linked documents.

    Forms

    @@ -621,7 +134,7 @@ It may be easier to use one of the typed forms of this function.
    nng_stream_dialer_get_ms()

    This function is used to retrieve time -durations +durations (such as timeouts), stored as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -655,15 +168,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_stream_dialer_get_addr()

    This function is used to retrieve a -socket address.

    +socket address.

    nng_stream_dialer_get_string()

    This function is used to retrieve a NULL-terminated string. This string is created from the source using -nng_strdup() +nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_stream_dialer_get_uint64()
    @@ -730,13 +243,14 @@ The amount of data actually needed is returned in sizep.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_set(3str), -nng_options(5), -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_set(3str), +nng_options(5), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_dialer_set.3str.html b/man/v1.2.2/nng_stream_dialer_set.3str.html index f3a42312..0390410a 100644 --- a/man/v1.2.2/nng_stream_dialer_set.3str.html +++ b/man/v1.2.2/nng_stream_dialer_set.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_dialer_set(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_dialer_set - set option on byte stream dialer

    @@ -557,11 +70,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_dialer_set() functions are used to configure options for the -byte stream dialer d. +byte stream dialer d. The actual options that may be configured in this way vary, and are specified by opt. A number of them are documented in -nng_options(5).

    +nng_options(5).

    Additionally some transport-specific and protocol-specific options are @@ -605,7 +118,7 @@ It may be easier to use one of the typed forms of this function.

    This function is used to configure time durations (such as timeouts) using the type -nng_duration. +nng_duration. The duration is an integer number of milliseconds.

    nng_stream_dialer_set_ptr()
    @@ -613,7 +126,7 @@ The duration is an integer number of milliseconds.

    This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -nng_tls_config_alloc() +nng_tls_config_alloc() can be passed this way.

    @@ -652,7 +165,7 @@ and similar options.

    nng_stream_dialer_set_addr()

    This function is used to configure a -socket address. +socket address. The value is copied, and thus the caller may discard the supplied value immediately after this function returns.

    @@ -714,16 +227,17 @@ value immediately after this function returns.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_dialer_get(3str), -nng_options(5), -nng_ipc_options(5), -nng_tcp_options(5), -nng_tls_options(5), -nng_stream_dialer(5)

    +

    nng_strerror(3), +nng_stream_dialer_get(3str), +nng_options(5), +nng_ipc_options(5), +nng_tcp_options(5), +nng_tls_options(5), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_free.3str.html b/man/v1.2.2/nng_stream_free.3str.html index 38e8b27c..7f85f8af 100644 --- a/man/v1.2.2/nng_stream_free.3str.html +++ b/man/v1.2.2/nng_stream_free.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_free(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_free - free byte stream

    @@ -537,14 +50,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_free() function closes the -byte stream s, +byte stream s, and frees the underlying resources associated with it.

    If any operations are pending, such as -nng_stream_send() +nng_stream_send() or -nng_stream_recv(), +nng_stream_recv(), they will be terminated with an NNG_ECLOSED error condition.

    @@ -597,14 +110,15 @@ have completely transmitted.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_close(3str), -nng_stream_recv(3str), -nng_stream_send(3str), -nng_stream(5)

    +

    nng_strerror(3), +nng_stream_close(3str), +nng_stream_recv(3str), +nng_stream_send(3str), +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_get.3str.html b/man/v1.2.2/nng_stream_get.3str.html index 31a739e8..f0b391fe 100644 --- a/man/v1.2.2/nng_stream_get.3str.html +++ b/man/v1.2.2/nng_stream_get.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_get(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_get - get option from byte stream

    @@ -557,12 +70,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_get() functions are used to retrieve option values for the -byte stream conn.

    +byte stream conn.

    The actual options that may be retrieved in this way vary. A number of them are documented in -nng_options(5) and additional linked documents.

    +nng_options(5) and additional linked documents.

    Forms

    @@ -621,7 +134,7 @@ It may be easier to use one of the typed forms of this function.
    nng_stream_get_ms()

    This function is used to retrieve time -durations +durations (such as timeouts), stored as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -655,15 +168,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_stream_get_addr()

    This function is used to retrieve a -socket address.

    +socket address.

    nng_stream_get_string()

    This function is used to retrieve a NULL-terminated string. This string is created from the source using -nng_strdup() +nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_stream_get_uint64()
    @@ -730,16 +243,17 @@ The amount of data actually needed is returned in sizep.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_set(3str), -nng_options(5), -nng_ipc_options(5), -nng_tcp_options(5), -nng_tls_options(5), -nng_stream(5)

    +

    nng_strerror(3), +nng_stream_set(3str), +nng_options(5), +nng_ipc_options(5), +nng_tcp_options(5), +nng_tls_options(5), +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener.5.html b/man/v1.2.2/nng_stream_listener.5.html index acef4d00..67cf8b15 100644 --- a/man/v1.2.2/nng_stream_listener.5.html +++ b/man/v1.2.2/nng_stream_listener.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_listener(5) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener - byte stream listener

    @@ -538,7 +51,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b An nng_stream_listener is a handle to a byte stream “listener”, which is responsible for accepting incoming connections and creating corresponding -nng_stream from them.

    +nng_stream from them.

    @@ -550,7 +63,7 @@ corresponding The nng_stream_listener object is a low-level object for raw byte stream connections, and should not be confused with a high-level -nng_listener object. +nng_listener object.
    @@ -561,16 +74,17 @@ and should not be confused with a high-level

    SEE ALSO

    -

    nng_stream_listener_accept(3str), -nng_stream_listener_alloc(3str), -nng_stream_listener_close(3str), -nng_stream_listener_free(3str), -nng_stream_listener_listen(3str), -nng_stream(5), -nng_stream_dialer(5)

    +

    nng_stream_listener_accept(3str), +nng_stream_listener_alloc(3str), +nng_stream_listener_close(3str), +nng_stream_listener_free(3str), +nng_stream_listener_listen(3str), +nng_stream(5), +nng_stream_dialer(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_accept.3str.html b/man/v1.2.2/nng_stream_listener_accept.3str.html index 0e4bdeb5..ea0a2864 100644 --- a/man/v1.2.2/nng_stream_listener_accept.3str.html +++ b/man/v1.2.2/nng_stream_listener_accept.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_accept(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_accept - accept incoming byte stream connection

    @@ -542,14 +55,14 @@ The operation is completed asynchronously, using aio.

    This operation can only be done after the listener is already -listening.

    +listening.

    If a connection is successfully established, the aio will have the resulting -nng_stream object stored as its first output, +nng_stream object stored as its first output, which can be retrieved with -nng_aio_get_output().

    +nng_aio_get_output().

    @@ -614,17 +127,18 @@ which can be retrieved with

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_alloc(3str), -nng_stream_listener_close(3str), -nng_stream_listener_free(3str), -nng_stream_listener_listen(3str), -nng_aio(5), -nng_stream(5), -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_alloc(3str), +nng_stream_listener_close(3str), +nng_stream_listener_free(3str), +nng_stream_listener_listen(3str), +nng_aio(5), +nng_stream(5), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_alloc.3str.html b/man/v1.2.2/nng_stream_listener_alloc.3str.html index b5f9131e..ad53a792 100644 --- a/man/v1.2.2/nng_stream_listener_alloc.3str.html +++ b/man/v1.2.2/nng_stream_listener_alloc.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_alloc(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_alloc - allocate byte stream listener

    @@ -540,9 +53,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    These functions allocates a listener for byte streams. Listeners create -nng_stream objects by accepting incoming +nng_stream objects by accepting incoming connections, via the -nng_stream_listener_accept() +nng_stream_listener_accept() function.

    @@ -552,7 +65,7 @@ specified by addr, which should be a string representing a URL.

    The second form, nng_stream_listener_alloc_url(), takes a pre-parsed or pre-constructed -nng_url object to determine the remote address.

    +nng_url object to determine the remote address.

    These functions may support different URL schemes, such as @@ -608,17 +121,18 @@ or pre-constructed

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_accept(3str) -nng_stream_listener_close(3str) -nng_stream_listener_free(3str) -nng_stream_listener_get(3str) -nng_stream_listener_listen(3str) -nng_stream_listener_set(3str) -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_accept(3str) +nng_stream_listener_close(3str) +nng_stream_listener_free(3str) +nng_stream_listener_get(3str) +nng_stream_listener_listen(3str) +nng_stream_listener_set(3str) +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_close.3str.html b/man/v1.2.2/nng_stream_listener_close.3str.html index ea68d400..0cfcdd5a 100644 --- a/man/v1.2.2/nng_stream_listener_close.3str.html +++ b/man/v1.2.2/nng_stream_listener_close.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_close(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_close - close byte stream listener

    @@ -542,7 +55,7 @@ but does not free the underlying resources associated with it.

    If any -accept +accept operations using d are in progress, they will be terminated with an NNG_ECLOSED error condition.

    @@ -559,7 +72,7 @@ in progress, they will be terminated with an NNG_ECLOSED error cond This function does not release the memory for the listener, so the application should still free the memory using -nng_stream_listener_free() +nng_stream_listener_free() once it is certain that nothing else is using it. @@ -587,14 +100,15 @@ once it is certain that nothing else is using it.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_accept(3str), -nng_stream_listener_alloc(3str), -nng_stream_listener_free(3str), -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_accept(3str), +nng_stream_listener_alloc(3str), +nng_stream_listener_free(3str), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_free.3str.html b/man/v1.2.2/nng_stream_listener_free.3str.html index d7ebc970..2b4c56be 100644 --- a/man/v1.2.2/nng_stream_listener_free.3str.html +++ b/man/v1.2.2/nng_stream_listener_free.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_free(3str) - - - + + -
    -

    NAME

    -

    nng_stream_listener_free - free byte stream listener

    -
    +

    SYNOPSIS

    @@ -551,7 +55,7 @@ and frees the underlying resources associated with it.

    If any -accept operations using __l are +accept operations using __l are in progress, they will be terminated with an NNG_ECLOSED error condition.

    @@ -589,14 +93,15 @@ are made to l, as the memory backing it will be reclaimed for other use

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_accept(3str), -nng_stream_listener_alloc(3str), -nng_stream_listener_close(3str), -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_accept(3str), +nng_stream_listener_alloc(3str), +nng_stream_listener_close(3str), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_get.3str.html b/man/v1.2.2/nng_stream_listener_get.3str.html index a3735212..d0d75f33 100644 --- a/man/v1.2.2/nng_stream_listener_get.3str.html +++ b/man/v1.2.2/nng_stream_listener_get.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_get(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_get - get option from byte stream listener

    @@ -558,12 +71,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_listener_get() functions are used to retrieve option values for the -byte stream listener l.

    +byte stream listener l.

    The actual options that may be retrieved in this way vary. A number of them are documented in -nng_options(5) and additional linked documents.

    +nng_options(5) and additional linked documents.

    Forms

    @@ -622,7 +135,7 @@ It may be easier to use one of the typed forms of this function.
    nng_stream_listener_get_ms()

    This function is used to retrieve time -durations +durations (such as timeouts), stored as a number of milliseconds. (The special value NNG_DUR_INFINITE means an infinite amount of time, and the special value NNG_DUR_DEFAULT means a context-specific default.)

    @@ -656,15 +169,15 @@ typically for buffer sizes, message maximum sizes, and similar options.

    nng_stream_listener_get_addr()

    This function is used to retrieve a -socket address.

    +socket address.

    nng_stream_listener_get_string()

    This function is used to retrieve a NULL-terminated string. This string is created from the source using -nng_strdup() +nng_strdup() and consequently must be freed by the caller using -nng_strfree() when it is no longer needed.

    +nng_strfree() when it is no longer needed.

    nng_stream_listener_get_uint64()
    @@ -731,13 +244,14 @@ The amount of data actually needed is returned in sizep.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_set(3str), -nng_options(5), -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_set(3str), +nng_options(5), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_listen.3str.html b/man/v1.2.2/nng_stream_listener_listen.3str.html index 5a81cddb..dcea0cec 100644 --- a/man/v1.2.2/nng_stream_listener_listen.3str.html +++ b/man/v1.2.2/nng_stream_listener_listen.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_listen(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_listen - bind listener to configured address

    @@ -541,7 +54,7 @@ to the local address specified when the listener was created.

    This must generally be done before accepting incoming connections using -nng_stream_listener_accept().

    +nng_stream_listener_accept().

    For some transports this will also perform other actiosn. For example, @@ -556,7 +69,7 @@ when a TCP port number of zero is specified, indicating that an ephemeral port should be used), this operation will allocate that resource. This can permit retrieval of the selected address using -nng_stream_listener_get(), +nng_stream_listener_get(), typically with the NNG_OPT_LOCADDR option.

    @@ -615,12 +128,13 @@ typically with the

    SEE ALSO

    -

    nng_stream_listener_accept(3str), -nng_strerror(3), -nng_stream_listener(5)

    +

    nng_stream_listener_accept(3str), +nng_strerror(3), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_listener_set.3str.html b/man/v1.2.2/nng_stream_listener_set.3str.html index 751cb3b5..7ef4653b 100644 --- a/man/v1.2.2/nng_stream_listener_set.3str.html +++ b/man/v1.2.2/nng_stream_listener_set.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_stream_listener_set(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_listener_set - set option on byte stream listener

    @@ -557,11 +70,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_listener_set() functions are used to configure options for the -byte stream listener l. +byte stream listener l. The actual options that may be configured in this way vary, and are specified by opt. A number of them are documented in -nng_options(5).

    +nng_options(5).

    Additionally some transport-specific and protocol-specific options are @@ -605,7 +118,7 @@ It may be easier to use one of the typed forms of this function.

    This function is used to configure time durations (such as timeouts) using the type -nng_duration. +nng_duration. The duration is an integer number of milliseconds.

    nng_stream_listener_set_ptr()
    @@ -613,7 +126,7 @@ The duration is an integer number of milliseconds.

    This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -nng_tls_config_alloc() +nng_tls_config_alloc() can be passed this way.

    @@ -652,7 +165,7 @@ and similar options.

    nng_stream_listener_set_addr()

    This function is used to configure a -socket address. +socket address. The value is copied, and thus the caller may discard the supplied value immediately after this function returns.

    @@ -714,16 +227,17 @@ value immediately after this function returns.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_listener_get(3str), -nng_options(5), -nng_ipc_options(5), -nng_tcp_options(5), -nng_tls_options(5), -nng_stream_listener(5)

    +

    nng_strerror(3), +nng_stream_listener_get(3str), +nng_options(5), +nng_ipc_options(5), +nng_tcp_options(5), +nng_tls_options(5), +nng_stream_listener(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_recv.3str.html b/man/v1.2.2/nng_stream_recv.3str.html index 4fb3f1b8..ec99778a 100644 --- a/man/v1.2.2/nng_stream_recv.3str.html +++ b/man/v1.2.2/nng_stream_recv.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_recv(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_recv - receive from byte stream

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_recv() function starts an asynchronous receive from the -byte stream s +byte stream s into the scatter/gather vector located in the asynchronous I/O structure aio.

    @@ -549,7 +62,7 @@ asynchronous I/O structure aio.

    @@ -559,7 +72,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -567,7 +80,7 @@ That result will either be zero or an error code.

    received, or an error has occurred. Therefore, the number of bytes read may be less than requested. The actual number of bytes read can be determined with -nng_aio_count().

    +nng_aio_count().

    @@ -648,17 +161,18 @@ The actual number of bytes read can be determined with

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_strerror(3), -nng_stream_close(3str), -nng_stream_send(3str), -nng_stream(5)

    +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_strerror(3), +nng_stream_close(3str), +nng_stream_send(3str), +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_send.3str.html b/man/v1.2.2/nng_stream_send.3str.html index b4fb736a..a731a517 100644 --- a/man/v1.2.2/nng_stream_send.3str.html +++ b/man/v1.2.2/nng_stream_send.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_send(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_send - send to byte stream

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_send() function starts an asynchronous send over the -byte stream s +byte stream s from the scatter/gather vector located in the asynchronous I/O structure aio.

    @@ -549,7 +62,7 @@ asynchronous I/O structure aio.

    @@ -560,7 +73,7 @@ called first, to set the scatter/gather vector for aio.

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

    @@ -568,7 +81,7 @@ That result will either be zero or an error code.

    sent, or an error has occurred. Therefore, the number of bytes sent may be less than requested. The actual number of bytes sent can be determined with -nng_aio_count().

    +nng_aio_count().

    @@ -641,17 +154,18 @@ The actual number of bytes sent can be determined with

    SEE ALSO

    -

    nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_strerror(3), +

    nng_aio_alloc(3), +nng_aio_count(3), +nng_aio_result(3), +nng_aio_set_iov(3), +nng_strerror(3), nng_stream_close(3str), nng_stream_recv(3str), -nng_stream(5)

    +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_stream_set.3str.html b/man/v1.2.2/nng_stream_set.3str.html index cb2f971d..782005a8 100644 --- a/man/v1.2.2/nng_stream_set.3str.html +++ b/man/v1.2.2/nng_stream_set.3str.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_stream_set(3str) - - - + + -

    NAME

    +

    NAME

    nng_stream_set - set option on byte stream

    @@ -557,11 +70,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_stream_set() functions are used to configure options for the -byte stream s. +byte stream s. The actual options that may be configured in this way vary, and are specified by opt. A number of them are documented in -nng_options(5).

    +nng_options(5).

    Additionally some transport-specific and protocol-specific options are @@ -605,7 +118,7 @@ It may be easier to use one of the typed forms of this function.

    This function is used to configure time durations (such as timeouts) using the type -nng_duration. +nng_duration. The duration is an integer number of milliseconds.

    nng_stream_set_ptr()
    @@ -613,7 +126,7 @@ The duration is an integer number of milliseconds.

    This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -nng_tls_config_alloc() +nng_tls_config_alloc() can be passed this way.

    The -nng_aio_set_iov() function must have been +nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio.
    The -nng_aio_set_iov() +nng_aio_set_iov() function must have been called first, to set the scatter/gather vector for aio.
    @@ -652,7 +165,7 @@ and similar options.

    nng_stream_set_addr()

    This function is used to configure a -socket address. +socket address. The value is copied, and thus the caller may discard the supplied value immediately after this function returns.

    @@ -714,16 +227,17 @@ value immediately after this function returns.

    SEE ALSO

    -

    nng_strerror(3), -nng_stream_get(3str), -nng_options(5), -nng_ipc_options(5), -nng_tcp_options(5), -nng_tls_options(5), -nng_stream(5)

    +

    nng_strerror(3), +nng_stream_get(3str), +nng_options(5), +nng_ipc_options(5), +nng_tcp_options(5), +nng_tls_options(5), +nng_stream(5)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_strerror.3.html b/man/v1.2.2/nng_strerror.3.html index 96dc4e8f..fc542f04 100644 --- a/man/v1.2.2/nng_strerror.3.html +++ b/man/v1.2.2/nng_strerror.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_strerror(3) - - - + + -

    NAME

    +

    NAME

    nng_strerror - return an error description

    @@ -582,11 +95,12 @@ by a NUL byte.

    SEE ALSO

    -

    libnng(3), -nng(7)

    +

    libnng(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_strfree.3.html b/man/v1.2.2/nng_strfree.3.html index a93ee21b..e7cc0de9 100644 --- a/man/v1.2.2/nng_strfree.3.html +++ b/man/v1.2.2/nng_strfree.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_strfree(3) - - - + + -

    NAME

    +

    NAME

    nng_strfree - free memory

    @@ -537,7 +50,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    The nng_strfree() function deallocates the string str. -This is equivalent to using nng_free() with +This is equivalent to using nng_free() with the length of str plus one (for the NUL terminating byte) as the size.

    @@ -549,8 +62,8 @@ the size.

    @@ -565,9 +78,9 @@ as strlen(str) + 1. @@ -595,13 +108,14 @@ case, using the length of the original string plus one for the size.)

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sub.7.html b/man/v1.2.2/nng_sub.7.html index ea48613a..b2d0d5b6 100644 --- a/man/v1.2.2/nng_sub.7.html +++ b/man/v1.2.2/nng_sub.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_sub(7) - - - + + -

    NAME

    +

    NAME

    nng_sub - subscriber protocol

    @@ -547,7 +60,7 @@ The subscribing applications only see the data to which they have subscribed.

    The sub protocol is the subscriber side, and the -pub protocol is the publisher side.

    +pub protocol is the publisher side.

    This should only be used with strings that were allocated -by nng_strdup() or -nng_alloc(). +by nng_strdup() or +nng_alloc(). In all cases, the allocation size of the string must be the same as strlen(str) + 1. Consequently, if the a string created with -nng_strdup() is modified to be shorter, then +nng_strdup() is modified to be shorter, then it is incorrect to call this function. -(The nng_free() function can be used instead in that +(The nng_free() function can be used instead in that case, using the length of the original string plus one for the size.)
    @@ -573,7 +86,7 @@ Applications should construct their messages accordingly.

    Socket Operations

    -

    The nng_sub0_open() functions create a subscriber socket. +

    The nng_sub0_open() functions create a subscriber socket. This socket may be used to receive messages, but is unable to send them. Attempts to send messages will result in NNG_ENOTSUP.

    @@ -608,10 +121,10 @@ discarded.

    @@ -658,12 +171,13 @@ When false, the subscriber will reject messages if the message queu

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_sub_open.3.html b/man/v1.2.2/nng_sub_open.3.html index fd81dcdf..7379787f 100644 --- a/man/v1.2.2/nng_sub_open.3.html +++ b/man/v1.2.2/nng_sub_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_sub_open(3) - - - + + -

    NAME

    +

    NAME

    nng_sub_open - create sub socket

    @@ -539,12 +52,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_sub0_open() function creates a sub version 0 -socket and returns it at the location pointed to by s.

    +

    The nng_sub0_open() function creates a sub version 0 +socket and returns it at the location pointed to by s.

    -

    The nng_sub0_open_raw() function creates a sub version 0 -socket in +

    The nng_sub0_open_raw() function creates a sub version 0 +socket in raw mode and returns it at the location pointed to by s.

    @@ -586,13 +99,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_socket(5), -nng_pub(7), -nng_sub(7), -nng(7)

    +

    nng_socket(5), +nng_pub(7), +nng_sub(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_surveyor.7.html b/man/v1.2.2/nng_surveyor.7.html index 068e55cf..7edff4b8 100644 --- a/man/v1.2.2/nng_surveyor.7.html +++ b/man/v1.2.2/nng_surveyor.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_surveyor(7) - - - + + -

    NAME

    +

    NAME

    nng_surveyor - surveyor protocol

    @@ -565,12 +78,12 @@ service discovery problems.

    The surveyor protocol is the surveyor side, and the -respondent protocol is the respondent side.

    +respondent protocol is the respondent side.

    Socket Operations

    -

    The nng_surveyor0_open() +

    The nng_surveyor0_open() functions create a surveyor socket. This socket may be used to send messages (surveys), and then to receive replies. A reply can only be received after sending a survey. @@ -596,8 +109,8 @@ survey that arrive after this will be discarded.

    Context Operations

    -

    This protocol supports the creation of contexts for concurrent -use cases using nng_ctx_open().

    +

    This protocol supports the creation of contexts for concurrent +use cases using nng_ctx_open().

    Each context can initiate its own surveys, and it will receive only @@ -648,7 +161,7 @@ version.)

    NNG_OPT_SURVEYOR_SURVEYTIME
    -

    (nng_duration) Duration of surveys. +

    (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 @@ -674,7 +187,7 @@ significant bit clear.

    When a survey message is received by a forwarding node (see -nng_device()), the forwarding node prepends a +nng_device()), the forwarding node prepends a 32-bit peer ID (which must have the most significant bit clear), which is the forwarder’s way of identifying the directly connected peer from which it received the message. @@ -713,12 +226,13 @@ document.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_surveyor_open.3.html b/man/v1.2.2/nng_surveyor_open.3.html index e9b32978..e8e59e46 100644 --- a/man/v1.2.2/nng_surveyor_open.3.html +++ b/man/v1.2.2/nng_surveyor_open.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_surveyor_open(3) - - - + + -

    NAME

    +

    NAME

    nng_surveyor_open - create surveyor socket

    @@ -539,13 +52,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    DESCRIPTION

    -

    The nng_surveyor0_open() function creates a surveyor -version 0 socket and returns it at the location +

    The nng_surveyor0_open() function creates a surveyor +version 0 socket and returns it at the location pointed to by s.

    -

    The nng_surveyor0_open_raw() function creates a surveyor -version 0 socket in +

    The nng_surveyor0_open_raw() function creates a surveyor +version 0 socket in raw mode and returns it at the location pointed to by s.

    @@ -587,13 +100,14 @@ version 0 socket in

    SEE ALSO

    -

    nng_socket(5), -nng_respondent(7), -nng_surveyor(7), -nng(7)

    +

    nng_socket(5), +nng_respondent(7), +nng_surveyor(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tcp.5.html b/man/v1.2.2/nng_tcp.5.html index 9f4b1ad7..9594cb81 100644 --- a/man/v1.2.2/nng_tcp.5.html +++ b/man/v1.2.2/nng_tcp.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - +nng_tcp(5) - - - + + -

    NAME

    +

    NAME

    nng_tcp - TCP connection

    @@ -551,7 +64,7 @@ TCP stream objects can be used to send or receive data.

    This option is a byte array. Thus if you use -nng_setopt_string() the NUL terminator byte will +nng_setopt_string() the NUL terminator byte will be included in the topic. If that isn’t desired, consider using -nng_setopt() and using strlen() of the topic +nng_setopt() and using strlen() of the topic as the topic size.
    The nng_tcp object is used for raw TCP connections, and should not be confused with a pipe object created using the -nng_tcp(7) transport. +nng_tcp(7) transport.
    @@ -564,28 +77,28 @@ should not be confused with a pipe object created using the Most NNG applications should not use this, but instead use the -nng_tcp(7) transport instead. +nng_tcp(7) transport instead.

    These objects are created either establishing an outgoing connection -with nng_tcp_dialer_dial() or by +with nng_tcp_dialer_dial() or by accepting in incoming connection with -nng_tcp_listener_accept().

    +nng_tcp_listener_accept().

    TCP connections are byte streams, and are “reliable” in that data will not be delivered out of order, or with portions missing.

    -

    Data can be sent using nng_tcp_send() or -received with nng_tcp_recv().

    +

    Data can be sent using nng_tcp_send() or +received with nng_tcp_recv().

    When the connection is no longer needed, it should be freed with -nng_tcp_free().

    +nng_tcp_free().

    @@ -595,7 +108,7 @@ received with nng_tcp_recv().
    It is possible to close the connection, without freeing it, by -using nng_tcp_close(). +using nng_tcp_close().
    @@ -604,8 +117,8 @@ using nng_tcp_close().

    Options

    The following options are applicable to TCP connections, and may be -accessed using the nng_tcp_getopt() and -nng_tcp_setopt() functions.

    +accessed using the nng_tcp_getopt() and +nng_tcp_setopt() functions.

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tcp.7.html b/man/v1.2.2/nng_tcp.7.html index e85460ed..33a1926a 100644 --- a/man/v1.2.2/nng_tcp.7.html +++ b/man/v1.2.2/nng_tcp.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tcp(7) - - - + + -

    NAME

    +

    NAME

    nng_tcp - TCP/IP transport

    @@ -646,10 +159,10 @@ and could be used to listen to port 9999 on the host:

    Socket Address

    -

    When using an nng_sockaddr structure, +

    When using an nng_sockaddr structure, the actual structure is either of type -nng_sockaddr_in (for IPv4) or -nng_sockaddr_in6 (for IPv6).

    +nng_sockaddr_in (for IPv4) or +nng_sockaddr_in6 (for IPv6).

    @@ -684,15 +197,16 @@ where supported by the underlying platform.

    SEE ALSO

    -

    nng_options(5), -nng_sockaddr(5), -nng_sockaddr_in(5), -nng_sockaddr_in6(5), -nng_tcp_options(5), -nng(7)

    +

    nng_options(5), +nng_sockaddr(5), +nng_sockaddr_in(5), +nng_sockaddr_in6(5), +nng_tcp_options(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tcp_options.5.html b/man/v1.2.2/nng_tcp_options.5.html index 07c7472e..52428231 100644 --- a/man/v1.2.2/nng_tcp_options.5.html +++ b/man/v1.2.2/nng_tcp_options.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tcp_options(5) - - - + + -

    NAME

    +

    NAME

    nng_tcp_options - TTCP-specific options

    @@ -690,17 +203,18 @@ when appropriate for the context:

    SEE ALSO

    -

    nng_tcp_dialer_getopt(3tcp), -nng_tcp_dialer_setopt(3tcp), -nng_tcp_getopt(3tcp), -nng_tcp_listener_getopt(3tcp), -nng_tcp_listener_setopt(3tcp), -nng_tcp_setopt(3tcp), -nng_options(5) -nng(7)

    +

    nng_tcp_dialer_getopt(3tcp), +nng_tcp_dialer_setopt(3tcp), +nng_tcp_getopt(3tcp), +nng_tcp_listener_getopt(3tcp), +nng_tcp_listener_setopt(3tcp), +nng_tcp_setopt(3tcp), +nng_options(5) +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tcp_register.3.html b/man/v1.2.2/nng_tcp_register.3.html index 6d19c5e5..0a5409d2 100644 --- a/man/v1.2.2/nng_tcp_register.3.html +++ b/man/v1.2.2/nng_tcp_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tcp_register(3) - - - + + -

    NAME

    +

    NAME

    nng_tcp_register - register tcp transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_tcp(7), -nng(7)

    +

    nng_tcp(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_thread_create.3supp.html b/man/v1.2.2/nng_thread_create.3supp.html index 79e2af7a..0d911eb7 100644 --- a/man/v1.2.2/nng_thread_create.3supp.html +++ b/man/v1.2.2/nng_thread_create.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_thread_create(3supp) - - - + + -

    NAME

    +

    NAME

    nng_thread_create - create thread

    @@ -557,7 +70,7 @@ programs that use simple sequential execution, using functions in the

    When the thread is no longer needed, the -nng_thread_destroy() +nng_thread_destroy() function should be used to reap it. (This function will block waiting for func to return.)

    @@ -603,7 +116,7 @@ The system may impose limits on the number of threads that can be created. Typically applications should not create more than a dozen of these. If greater concurrency or scalability is needed, consider instead using -an asynchronous model using nng_aio structures. +an asynchronous model using nng_aio structures. @@ -616,8 +129,8 @@ an asynchronous model using nng_aio s Threads can be synchronized using -mutexes and -condition variables. +mutexes and +condition variables. @@ -653,15 +166,16 @@ Threads can be synchronized using

    SEE ALSO

    -

    nng_strerror(3), -nng_cv_alloc(3supp), -nng_mtx_alloc(3supp), -nng_thread_destroy(3supp), -nng_aio(5), -nng(7)

    +

    nng_strerror(3), +nng_cv_alloc(3supp), +nng_mtx_alloc(3supp), +nng_thread_destroy(3supp), +nng_aio(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_thread_destroy.3supp.html b/man/v1.2.2/nng_thread_destroy.3supp.html index 60c37dda..2e5adda2 100644 --- a/man/v1.2.2/nng_thread_destroy.3supp.html +++ b/man/v1.2.2/nng_thread_destroy.3supp.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_thread_destroy(3supp) - - - + + -

    NAME

    +

    NAME

    nng_thread_destroy - reap thread

    @@ -576,11 +89,12 @@ or a deadlock will occur.

    SEE ALSO

    -

    nng_thread_create(3supp), -nng(7)

    +

    nng_thread_create(3supp), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls.5.html b/man/v1.2.2/nng_tls.5.html index ac6dbe36..8dd67882 100644 --- a/man/v1.2.2/nng_tls.5.html +++ b/man/v1.2.2/nng_tls.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls(5) - - - + + -

    NAME

    +

    NAME

    nng_tls - TLS over TCP connection

    @@ -553,7 +66,7 @@ stream.

    The nng_tls object is used for raw TLS connections, and should not be confused with a pipe object created using the -nng_tls(7) transport. +nng_tls(7) transport. @@ -566,28 +79,28 @@ should not be confused with a pipe object created using the Most NNG applications should not use this, but instead use the -nng_tls(7) transport instead. +nng_tls(7) transport instead.

    These objects are created either establishing an outgoing connection -with nng_tls_dialer_dial() or by +with nng_tls_dialer_dial() or by accepting in incoming connection with -nng_tls_listener_accept().

    +nng_tls_listener_accept().

    TLS connections are byte streams, and are “reliable” in that data will not be delivered out of order, or with portions missing.

    -

    Data can be sent using nng_tls_send() or -received with nng_tls_recv().

    +

    Data can be sent using nng_tls_send() or +received with nng_tls_recv().

    When the connection is no longer needed, it should be freed with -nng_tls_free().

    +nng_tls_free().

    @@ -597,7 +110,7 @@ received with nng_tls_recv().
    It is possible to close the connection, without freeing it, by -using nng_tls_close(). +using nng_tls_close().
    @@ -606,8 +119,8 @@ using nng_tls_close().

    Options

    The following options are applicable to TLS connections, and may be -accessed using the nng_tls_getopt() and -nng_tls_setopt() functions.

    +accessed using the nng_tls_getopt() and +nng_tls_setopt() functions.

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls.7.html b/man/v1.2.2/nng_tls.7.html index 2f24aef2..f48df3ef 100644 --- a/man/v1.2.2/nng_tls.7.html +++ b/man/v1.2.2/nng_tls.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls(7) - - - + + -

    NAME

    +

    NAME

    nng_tls - TLS transport

    @@ -558,7 +71,7 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.<

    Depending upon how the library was built, it may be necessary to register the transport by calling -nng_tls_register().

    +nng_tls_register().

    @@ -708,10 +221,10 @@ and could be used to listen to port 9999 on the host:

    Socket Address

    -

    When using an nng_sockaddr structure, +

    When using an nng_sockaddr structure, the actual structure is either of type -nng_sockaddr_in (for IPv4) or -nng_sockaddr_in6 (for IPv6).

    +nng_sockaddr_in (for IPv4) or +nng_sockaddr_in6 (for IPv6).

    @@ -761,17 +274,18 @@ Note that setting these must be done before the transport is started.

    SEE ALSO

    -

    nng_tls_config_alloc(3tls) -nng_options(5), -nng_sockaddr_in(5), -nng_sockaddr_in6(5), -nng_tcp_options(5), -nng_tls_config(5), -nng_tls_options(5), -nng(7),

    +

    nng_tls_config_alloc(3tls) +nng_options(5), +nng_sockaddr_in(5), +nng_sockaddr_in6(5), +nng_tcp_options(5), +nng_tls_config(5), +nng_tls_options(5), +nng(7),

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config.5.html b/man/v1.2.2/nng_tls_config.5.html index 6c95d127..a11ca75c 100644 --- a/man/v1.2.2/nng_tls_config.5.html +++ b/man/v1.2.2/nng_tls_config.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config(5) - - - + + -

    NAME

    +

    NAME

    nng_tls_config - message

    @@ -551,9 +64,9 @@ precludes further modifications to the configuration.

    Messages are allocated using the -nng_tls_config_alloc() +nng_tls_config_alloc() function, and are deallocated using the -nng_tls_config_free() +nng_tls_config_free() function.

    @@ -562,17 +75,18 @@ function.

    SEE ALSO

    -

    nng_tls_config_alloc(3tls), -nng_tls_config_auth_mode(3tls), -nng_tls_config_ca_chain(3tls), -nng_tls_config_own_cert(3tls), -nng_tls_config_free(3tls), -nng_tls_config_hold(3tls), -nng_tls_config_server_name(3tls), -nng(7)

    +

    nng_tls_config_alloc(3tls), +nng_tls_config_auth_mode(3tls), +nng_tls_config_ca_chain(3tls), +nng_tls_config_own_cert(3tls), +nng_tls_config_free(3tls), +nng_tls_config_hold(3tls), +nng_tls_config_server_name(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_alloc.3tls.html b/man/v1.2.2/nng_tls_config_alloc.3tls.html index d1db6b5b..e1eb97e4 100644 --- a/man/v1.2.2/nng_tls_config_alloc.3tls.html +++ b/man/v1.2.2/nng_tls_config_alloc.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_alloc(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_alloc - allocate TLS configuration object

    @@ -566,9 +79,9 @@ that object is not inadvertently freed while in use.

    A configuration object created with nng_tls_config_alloc() starts with a reference count of one. The reference count may be incremented using -nng_tls_config_hold() and may be +nng_tls_config_hold() and may be decremented with -nng_tls_config_free().

    +nng_tls_config_free().

    Also note that a TLS configuration object becomes “read-only” after it @@ -615,18 +128,19 @@ further changes to the configuration will result in NNG_EBUSY.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_auth_mode(3tls), -nng_tls_config_ca_chain(3tls), -nng_tls_config_own_cert(3tls), -nng_tls_config_free(3tls), -nng_tls_config_hold(3tls), -nng_tls_config_server_name(3tls), -nng_tls_config(5), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_auth_mode(3tls), +nng_tls_config_ca_chain(3tls), +nng_tls_config_own_cert(3tls), +nng_tls_config_free(3tls), +nng_tls_config_hold(3tls), +nng_tls_config_server_name(3tls), +nng_tls_config(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_auth_mode.3tls.html b/man/v1.2.2/nng_tls_config_auth_mode.3tls.html index d62be349..98986bc6 100644 --- a/man/v1.2.2/nng_tls_config_auth_mode.3tls.html +++ b/man/v1.2.2/nng_tls_config_auth_mode.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_auth_mode(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_auth_mode - configure authentication mode

    @@ -619,15 +132,16 @@ This is the default for clients.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(3tls), -nng_tls_config_ca_chain(3tls), -nng_tls_config_ca_file(3tls), -nng_tls_config_server_name(3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(3tls), +nng_tls_config_ca_chain(3tls), +nng_tls_config_ca_file(3tls), +nng_tls_config_server_name(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_ca_chain.3tls.html b/man/v1.2.2/nng_tls_config_ca_chain.3tls.html index 2ddd5881..b8602505 100644 --- a/man/v1.2.2/nng_tls_config_ca_chain.3tls.html +++ b/man/v1.2.2/nng_tls_config_ca_chain.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_ca_chain(3) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_ca_chain - configure certificate authority certificate chain

    @@ -624,14 +137,15 @@ certificate revocation list for the associated authority.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(.3tls), -nng_tls_config_auth_mode(.3tls), -nng_tls_config_ca_file(.3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(.3tls), +nng_tls_config_auth_mode(.3tls), +nng_tls_config_ca_file(.3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_ca_file.3tls.html b/man/v1.2.2/nng_tls_config_ca_file.3tls.html index 0a2daeba..485c854d 100644 --- a/man/v1.2.2/nng_tls_config_ca_file.3tls.html +++ b/man/v1.2.2/nng_tls_config_ca_file.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_ca_file(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_ca_file - load certificate authority from file

    @@ -636,14 +149,15 @@ to a configuration, without affecting those added previously.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(3tls), -nng_tls_config_auth_mode(3tls), -nng_tls_config_ca_chain(3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(3tls), +nng_tls_config_auth_mode(3tls), +nng_tls_config_ca_chain(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_cert_key_file.3tls.html b/man/v1.2.2/nng_tls_config_cert_key_file.3tls.html index 3d3da593..bb3fbba4 100644 --- a/man/v1.2.2/nng_tls_config_cert_key_file.3tls.html +++ b/man/v1.2.2/nng_tls_config_cert_key_file.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_cert_key_file(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_cert_key_file - load own certificate and key from file

    @@ -624,13 +137,14 @@ to be used for different cryptographic algorithms.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(3tls), -nng_tls_config_own_cert(3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(3tls), +nng_tls_config_own_cert(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_free.3tls.html b/man/v1.2.2/nng_tls_config_free.3tls.html index 54eadc3d..a12fad79 100644 --- a/man/v1.2.2/nng_tls_config_free.3tls.html +++ b/man/v1.2.2/nng_tls_config_free.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_free(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_free - deallocate a TLS configuration object

    @@ -563,11 +76,12 @@ reference count is zero, then deallocates the configuration object.

    SEE ALSO

    -

    nng_tls_config_alloc(3tls), -nng(7)

    +

    nng_tls_config_alloc(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_hold.3tls.html b/man/v1.2.2/nng_tls_config_hold.3tls.html index 80adaea5..7324a25f 100644 --- a/man/v1.2.2/nng_tls_config_hold.3tls.html +++ b/man/v1.2.2/nng_tls_config_hold.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_hold(3tls) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_hold - hold TLS configuration object

    @@ -543,7 +56,7 @@ from being freed while in use.

    The hold can be released by calling -nng_tls_config_free().

    +nng_tls_config_free().

    Multiple holds can be placed on a configuration object; the object @@ -571,12 +84,13 @@ will not be freed until the last hold is released.

    SEE ALSO

    -

    nng_tls_config_alloc(3tls), -nng_tls_config_free(3tls), -nng(7)

    +

    nng_tls_config_alloc(3tls), +nng_tls_config_free(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_own_cert.3tls.html b/man/v1.2.2/nng_tls_config_own_cert.3tls.html index 69bca06e..146bf409 100644 --- a/man/v1.2.2/nng_tls_config_own_cert.3tls.html +++ b/man/v1.2.2/nng_tls_config_own_cert.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_own_cert(3) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_own_cert - configure own certificate and key

    @@ -609,13 +122,14 @@ strings containing

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(3tls), -nng_tls_config_cert_key_file(3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(3tls), +nng_tls_config_cert_key_file(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_config_server_name.3tls.html b/man/v1.2.2/nng_tls_config_server_name.3tls.html index f11429bd..4539bca1 100644 --- a/man/v1.2.2/nng_tls_config_server_name.3tls.html +++ b/man/v1.2.2/nng_tls_config_server_name.3tls.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_config_server_name(3) - - - + + -

    NAME

    +

    NAME

    nng_tls_config_server_name - configure remote server name

    @@ -596,13 +109,14 @@ This function is only useful in configuring client behavior.

    SEE ALSO

    -

    nng_strerror(3), -nng_tls_config_alloc(3tls), -nng_tls_config_auth_mode(3tls), -nng(7)

    +

    nng_strerror(3), +nng_tls_config_alloc(3tls), +nng_tls_config_auth_mode(3tls), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_options.5.html b/man/v1.2.2/nng_tls_options.5.html index 15c46654..2a9833b7 100644 --- a/man/v1.2.2/nng_tls_options.5.html +++ b/man/v1.2.2/nng_tls_options.5.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_options(5) - - - + + -

    NAME

    +

    NAME

    nng_tls_options - TLS-specific options

    @@ -568,14 +81,14 @@ description of the option.

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

    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 +See nng_tls_config_ca_file() for more information.

    NNG_OPT_TLS_CERT_KEY_FILE
    @@ -583,14 +96,14 @@ information.

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

    NNG_OPT_TLS_CONFIG

    (nng_tls_config *) This option references the underlying -TLS configuration object. +TLS configuration object. A hold is placed on the underlying configuration object before returning it.

    @@ -601,7 +114,7 @@ configuration object before returning it.

    The caller should release the hold with -nng_tls_config_free() when it no +nng_tls_config_free() when it no longer needs the TLS configuration object. @@ -668,19 +181,20 @@ when appropriate for the context:

    SEE ALSO

    -

    nng_tls_dialer_getopt(3tls), -nng_tls_dialer_setopt(3tls), -nng_tls_getopt(3tls), -nng_tls_listener_getopt(3tls), -nng_tls_listener_setopt(3tls), -nng_tls_setopt(3tls), -nng_options(5) -nng_tcp_options(5) -nng_tls_config(5), -nng(7)

    +

    nng_tls_dialer_getopt(3tls), +nng_tls_dialer_setopt(3tls), +nng_tls_getopt(3tls), +nng_tls_listener_getopt(3tls), +nng_tls_listener_setopt(3tls), +nng_tls_setopt(3tls), +nng_options(5) +nng_tcp_options(5) +nng_tls_config(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_tls_register.3.html b/man/v1.2.2/nng_tls_register.3.html index eecc6fc5..2671ecba 100644 --- a/man/v1.2.2/nng_tls_register.3.html +++ b/man/v1.2.2/nng_tls_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_tls_register(3) - - - + + -

    NAME

    +

    NAME

    nng_tls_register - register tls transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_tls(5), -nng(7)

    +

    nng_tls(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_url_clone.3.html b/man/v1.2.2/nng_url_clone.3.html index 6b234a05..f127dcc2 100644 --- a/man/v1.2.2/nng_url_clone.3.html +++ b/man/v1.2.2/nng_url_clone.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_url_clone(3) - - - + + -

    NAME

    +

    NAME

    nng_url_clone - clone URL structure

    @@ -571,13 +84,14 @@ This clone includes fully duplicating each of the member fields.

    SEE ALSO

    -

    nng_url_free(3), -nng_url_parse(3), -nng_strerror(3), -nng(7)

    +

    nng_url_free(3), +nng_url_parse(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_url_free.3.html b/man/v1.2.2/nng_url_free.3.html index 3ef6ce67..c46cbb9c 100644 --- a/man/v1.2.2/nng_url_free.3.html +++ b/man/v1.2.2/nng_url_free.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_url_free(3) - - - + + -

    NAME

    +

    NAME

    nng_url_free - free a URL structure

    @@ -561,12 +74,13 @@ any of its members.

    SEE ALSO

    -

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

    +

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

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_url_parse.3.html b/man/v1.2.2/nng_url_parse.3.html index a853bd92..3cead992 100644 --- a/man/v1.2.2/nng_url_parse.3.html +++ b/man/v1.2.2/nng_url_parse.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_url_parse(3) - - - + + -

    NAME

    +

    NAME

    nng_url_parse - create URL structure from a string

    @@ -662,13 +175,14 @@ Only the u_userinfo, u_query, and u_fragmentSEE ALSO
    -

    nng_url_clone(3), -nng_url_free(3), -nng_strerror(3), -nng(7)

    +

    nng_url_clone(3), +nng_url_free(3), +nng_strerror(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_version.3.html b/man/v1.2.2/nng_version.3.html index 105a9a75..fac07621 100644 --- a/man/v1.2.2/nng_version.3.html +++ b/man/v1.2.2/nng_version.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_version(3) - - - + + -

    NAME

    +

    NAME

    nng_version - report library version

    @@ -591,11 +104,12 @@ manner depending upon the link options and how the library is built.)

    SEE ALSO

    -

    libnng(3), -nng(7)

    +

    libnng(3), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ws.7.html b/man/v1.2.2/nng_ws.7.html index dc5c7430..dd065d7c 100644 --- a/man/v1.2.2/nng_ws.7.html +++ b/man/v1.2.2/nng_ws.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ws(7) - - - + + -

    NAME

    +

    NAME

    nng_ws - WebSocket transport

    @@ -557,12 +70,12 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.<

    Registration

    Depending upon how the library was built, it may be necessary to -register the transport by calling nng_ws_register().

    +register the transport by calling nng_ws_register().

    If TLS support is enabled in the library, secure WebSockets (over TLS v1.2) can be used as well, but the secure transport may have to be registered using -the nng_wss_register() function.

    +the nng_wss_register() function.

    @@ -616,10 +129,10 @@ permitted, with IPv4 addresses mapped to IPv6 addresses.)

    Socket Address

    -

    When using an nng_sockaddr structure, +

    When using an nng_sockaddr structure, the actual structure is either of type -nng_sockaddr_in (for IPv4) or -nng_sockaddr_in6 (for IPv6).

    +nng_sockaddr_in (for IPv4) or +nng_sockaddr_in6 (for IPv6).

    @@ -691,7 +204,7 @@ configuration object for wss:// endpoints. A hold is placed on the underlying configuration object before returning it. The caller should release the object with -nng_tls_config_free() when it no +nng_tls_config_free() when it no longer needs the TLS configuration.

    @@ -714,7 +227,7 @@ Use this option when advanced TLS configuration is required.

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

    NNG_OPT_TLS_CERT_KEY_FILE
    @@ -722,13 +235,13 @@ information.

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

    NNG_OPT_TLS_AUTH_MODE

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

    NNG_OPT_TLS_VERIFIED
    @@ -746,14 +259,15 @@ May return incorrect results if peer authentication is disabled.

    SEE ALSO

    -

    nng_tls_config_alloc(3tls), -nng_sockaddr(5), -nng_sockaddr_in(5), -nng_sockaddr_in6(5), -nng(7)

    +

    nng_tls_config_alloc(3tls), +nng_sockaddr(5), +nng_sockaddr_in(5), +nng_sockaddr_in6(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_ws_register.3.html b/man/v1.2.2/nng_ws_register.3.html index f012a1a8..25668dd6 100644 --- a/man/v1.2.2/nng_ws_register.3.html +++ b/man/v1.2.2/nng_ws_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_ws_register(3) - - - + + -

    NAME

    +

    NAME

    nng_ws_register - register WebSocket transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_ws(7), -nng(7)

    +

    nng_ws(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_wss_register.3.html b/man/v1.2.2/nng_wss_register.3.html index 9deaa5c8..bfca406e 100644 --- a/man/v1.2.2/nng_wss_register.3.html +++ b/man/v1.2.2/nng_wss_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_wss_register(3) - - - + + -

    NAME

    +

    NAME

    nng_wss_register - register WebSocket secure transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_ws(7), -nng(7)

    +

    nng_ws(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_zerotier.7.html b/man/v1.2.2/nng_zerotier.7.html index 25737df4..dda8fc3f 100644 --- a/man/v1.2.2/nng_zerotier.7.html +++ b/man/v1.2.2/nng_zerotier.7.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_zerotier(7) - - - + + -

    NAME

    +

    NAME

    nng_zerotier - ZeroTier transport

    @@ -622,7 +135,7 @@ concepts and administration.

    Depending upon how the library was built, it may be necessary to register the transport by calling -nng_zt_register(). +nng_zt_register(). This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason.

    @@ -648,15 +161,15 @@ the node’s own node number.

    Listeners may use port 0 to indicate that a suitable port number be selected automatically. Applications using this must determine the selected port number using the -nng_listener_getopt() function.

    +nng_listener_getopt() function.

    Socket Address

    -

    When using an nng_sockaddr structure, +

    When using an nng_sockaddr structure, the actual structure is of type -nng_sockaddr_zt.

    +nng_sockaddr_zt.

    @@ -788,7 +301,7 @@ as established by the ZeroTier network administrator.

    NNG_OPT_ZT_CONN_TIME
    -

    (nng_duration) +

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

    @@ -811,7 +324,7 @@ If the value is set to 0, then connection attempts will keep retrying forever.
    NNG_OPT_ZT_PING_TIME
    -

    (nng_duration) If no traffic has been received from +

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

    @@ -868,11 +381,12 @@ this has no effect.

    SEE ALSO

    -

    nng_sockaddr_zt(5), -nng(7)

    +

    nng_sockaddr_zt(5), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nng_zt_register.3.html b/man/v1.2.2/nng_zt_register.3.html index a49eaacf..4d7a8e11 100644 --- a/man/v1.2.2/nng_zt_register.3.html +++ b/man/v1.2.2/nng_zt_register.3.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nng_zt_register(3) - - - + + -

    NAME

    +

    NAME

    nng_zt_register - register ZeroTier transport

    @@ -578,11 +91,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    SEE ALSO

    -

    nng_zerotier(7), -nng(7)

    +

    nng_zerotier(7), +nng(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/nngcat.1.html b/man/v1.2.2/nngcat.1.html index 68e8db9b..cd46e765 100644 --- a/man/v1.2.2/nngcat.1.html +++ b/man/v1.2.2/nngcat.1.html @@ -1,505 +1,18 @@ --- -version: 1.2.2 +version: v1.2.2 layout: refman --- - + - + nngcat(1) - - - + + -

    NAME

    +

    NAME

    nngcat - command line access to Scalability Protocols

    @@ -621,12 +134,12 @@ 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.

    +the pair protocol instead of version 1.

    --subscribe=TOPIC

    Subscribe to TOPIC. This option can only be used with the -sub protocol. +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. @@ -665,54 +178,54 @@ At least one protocol must be selected.

    --bus, --bus0
    -

    Select the bus version 0 protocol. +

    Select the bus version 0 protocol. 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 +

    Select the req version 0 protocol. +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 +

    Select the rep version 0 protocol. +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.

    +

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

    --sub, --sub0
    -

    Select the sub version 0 protocol. -This protocol receives messages from pub version +

    Select the sub version 0 protocol. +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. +

    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.

    --pull, --pull0
    -

    Select the pull version 0 protocol. +

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

    +messages from push version 0 peers.

    --pair0
    -

    Select the pair version 0 protocol. +

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

    --pair1
    -

    Select the pair version 1 protocol. +

    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. @@ -726,14 +239,14 @@ 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 +

    Select the surveyor version 0 protocol. +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 +

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

    @@ -993,21 +506,22 @@ $ nngcat --sub --dial=${<

    SEE ALSO

    -

    libnng(3), -nng(7), -nng_bus(7), -nng_pair(7), -nng_pub(7), -nng_pull(7), -nng_push(7), -nng_sub(7), -nng_rep(7), -nng_req(7), -nng_respondent(7), -nng_surveyor(7)

    +

    libnng(3), +nng(7), +nng_bus(7), +nng_pair(7), +nng_pub(7), +nng_pull(7), +nng_push(7), +nng_sub(7), +nng_rep(7), +nng_req(7), +nng_respondent(7), +nng_surveyor(7)

    + - + \ No newline at end of file diff --git a/man/v1.2.2/pygments-default.css b/man/v1.2.2/pygments-default.css new file mode 100644 index 00000000..16d4c78e --- /dev/null +++ b/man/v1.2.2/pygments-default.css @@ -0,0 +1,69 @@ +pre.pygments .hll { background-color: #ffffcc } +pre.pygments { background: #f8f8f8; } +pre.pygments .tok-c { color: #408080; font-style: italic } /* Comment */ +pre.pygments .tok-err { border: 1px solid #FF0000 } /* Error */ +pre.pygments .tok-k { color: #008000; font-weight: bold } /* Keyword */ +pre.pygments .tok-o { color: #666666 } /* Operator */ +pre.pygments .tok-ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +pre.pygments .tok-cm { color: #408080; font-style: italic } /* Comment.Multiline */ +pre.pygments .tok-cp { color: #BC7A00 } /* Comment.Preproc */ +pre.pygments .tok-cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +pre.pygments .tok-c1 { color: #408080; font-style: italic } /* Comment.Single */ +pre.pygments .tok-cs { color: #408080; font-style: italic } /* Comment.Special */ +pre.pygments .tok-gd { color: #A00000 } /* Generic.Deleted */ +pre.pygments .tok-ge { font-style: italic } /* Generic.Emph */ +pre.pygments .tok-gr { color: #FF0000 } /* Generic.Error */ +pre.pygments .tok-gh { color: #000080; font-weight: bold } /* Generic.Heading */ +pre.pygments .tok-gi { color: #00A000 } /* Generic.Inserted */ +pre.pygments .tok-go { color: #888888 } /* Generic.Output */ +pre.pygments .tok-gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +pre.pygments .tok-gs { font-weight: bold } /* Generic.Strong */ +pre.pygments .tok-gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +pre.pygments .tok-gt { color: #0044DD } /* Generic.Traceback */ +pre.pygments .tok-kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +pre.pygments .tok-kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +pre.pygments .tok-kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +pre.pygments .tok-kp { color: #008000 } /* Keyword.Pseudo */ +pre.pygments .tok-kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +pre.pygments .tok-kt { color: #B00040 } /* Keyword.Type */ +pre.pygments .tok-m { color: #666666 } /* Literal.Number */ +pre.pygments .tok-s { color: #BA2121 } /* Literal.String */ +pre.pygments .tok-na { color: #7D9029 } /* Name.Attribute */ +pre.pygments .tok-nb { color: #008000 } /* Name.Builtin */ +pre.pygments .tok-nc { color: #0000FF; font-weight: bold } /* Name.Class */ +pre.pygments .tok-no { color: #880000 } /* Name.Constant */ +pre.pygments .tok-nd { color: #AA22FF } /* Name.Decorator */ +pre.pygments .tok-ni { color: #999999; font-weight: bold } /* Name.Entity */ +pre.pygments .tok-ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +pre.pygments .tok-nf { color: #0000FF } /* Name.Function */ +pre.pygments .tok-nl { color: #A0A000 } /* Name.Label */ +pre.pygments .tok-nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +pre.pygments .tok-nt { color: #008000; font-weight: bold } /* Name.Tag */ +pre.pygments .tok-nv { color: #19177C } /* Name.Variable */ +pre.pygments .tok-ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +pre.pygments .tok-w { color: #bbbbbb } /* Text.Whitespace */ +pre.pygments .tok-mb { color: #666666 } /* Literal.Number.Bin */ +pre.pygments .tok-mf { color: #666666 } /* Literal.Number.Float */ +pre.pygments .tok-mh { color: #666666 } /* Literal.Number.Hex */ +pre.pygments .tok-mi { color: #666666 } /* Literal.Number.Integer */ +pre.pygments .tok-mo { color: #666666 } /* Literal.Number.Oct */ +pre.pygments .tok-sa { color: #BA2121 } /* Literal.String.Affix */ +pre.pygments .tok-sb { color: #BA2121 } /* Literal.String.Backtick */ +pre.pygments .tok-sc { color: #BA2121 } /* Literal.String.Char */ +pre.pygments .tok-dl { color: #BA2121 } /* Literal.String.Delimiter */ +pre.pygments .tok-sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +pre.pygments .tok-s2 { color: #BA2121 } /* Literal.String.Double */ +pre.pygments .tok-se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +pre.pygments .tok-sh { color: #BA2121 } /* Literal.String.Heredoc */ +pre.pygments .tok-si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +pre.pygments .tok-sx { color: #008000 } /* Literal.String.Other */ +pre.pygments .tok-sr { color: #BB6688 } /* Literal.String.Regex */ +pre.pygments .tok-s1 { color: #BA2121 } /* Literal.String.Single */ +pre.pygments .tok-ss { color: #19177C } /* Literal.String.Symbol */ +pre.pygments .tok-bp { color: #008000 } /* Name.Builtin.Pseudo */ +pre.pygments .tok-fm { color: #0000FF } /* Name.Function.Magic */ +pre.pygments .tok-vc { color: #19177C } /* Name.Variable.Class */ +pre.pygments .tok-vg { color: #19177C } /* Name.Variable.Global */ +pre.pygments .tok-vi { color: #19177C } /* Name.Variable.Instance */ +pre.pygments .tok-vm { color: #19177C } /* Name.Variable.Magic */ +pre.pygments .tok-il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file -- cgit v1.2.3-70-g09d2