From b8836cedde0b4941260fbaa8c5af4e67cd659406 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 23 Jan 2020 21:42:50 -0800 Subject: Publishing updates for tip --- man/tip/asciidoctor.css | 426 ++++ man/tip/index.html | 2208 ++++++++------------- man/tip/libnng.3.html | 1210 ++++------- man/tip/nn_allocmsg.3compat.html | 525 +---- man/tip/nn_bind.3compat.html | 525 +---- man/tip/nn_close.3compat.html | 517 +---- man/tip/nn_cmsg.3compat.html | 521 +---- man/tip/nn_connect.3compat.html | 525 +---- man/tip/nn_device.3compat.html | 522 +---- man/tip/nn_errno.3compat.html | 515 +---- man/tip/nn_freemsg.3compat.html | 521 +---- man/tip/nn_get_statistic.3compat.html | 513 +---- man/tip/nn_getsockopt.3compat.html | 523 +---- man/tip/nn_poll.3compat.html | 525 +---- man/tip/nn_reallocmsg.3compat.html | 519 +---- man/tip/nn_recv.3compat.html | 527 +---- man/tip/nn_recvmsg.3compat.html | 529 +---- man/tip/nn_send.3compat.html | 525 +---- man/tip/nn_sendmsg.3compat.html | 529 +---- man/tip/nn_setsockopt.3compat.html | 523 +---- man/tip/nn_shutdown.3compat.html | 521 +---- man/tip/nn_socket.3compat.html | 541 +---- man/tip/nn_strerror.3compat.html | 515 +---- man/tip/nn_term.3compat.html | 517 +---- man/tip/nng.7.html | 554 +----- man/tip/nng_aio.5.html | 559 +----- man/tip/nng_aio_abort.3.html | 517 +---- man/tip/nng_aio_alloc.3.html | 559 +----- man/tip/nng_aio_begin.3.html | 521 +---- man/tip/nng_aio_cancel.3.html | 519 +---- man/tip/nng_aio_count.3.html | 523 +---- man/tip/nng_aio_defer.3.html | 521 +---- man/tip/nng_aio_finish.3.html | 521 +---- man/tip/nng_aio_free.3.html | 515 +---- man/tip/nng_aio_get_input.3.html | 519 +---- man/tip/nng_aio_get_msg.3.html | 521 +---- man/tip/nng_aio_get_output.3.html | 517 +---- man/tip/nng_aio_result.3.html | 519 +---- man/tip/nng_aio_set_input.3.html | 519 +---- man/tip/nng_aio_set_iov.3.html | 562 +----- man/tip/nng_aio_set_msg.3.html | 519 +---- man/tip/nng_aio_set_output.3.html | 519 +---- man/tip/nng_aio_set_timeout.3.html | 517 +---- man/tip/nng_aio_stop.3.html | 519 +---- man/tip/nng_aio_wait.3.html | 513 +---- man/tip/nng_alloc.3.html | 517 +---- man/tip/nng_bus.7.html | 517 +---- man/tip/nng_bus_open.3.html | 521 +---- man/tip/nng_clock.3supp.html | 519 +---- man/tip/nng_close.3.html | 518 +---- man/tip/nng_compat.3compat.html | 565 +----- man/tip/nng_ctx.5.html | 559 +----- man/tip/nng_ctx_close.3.html | 518 +---- man/tip/nng_ctx_get.3.html | 254 +++ man/tip/nng_ctx_getopt.3.html | 543 +---- man/tip/nng_ctx_id.3.html | 513 +---- man/tip/nng_ctx_open.3.html | 535 +---- man/tip/nng_ctx_recv.3.html | 531 +---- man/tip/nng_ctx_send.3.html | 537 +---- man/tip/nng_ctx_set.3.html | 239 +++ man/tip/nng_ctx_setopt.3.html | 533 +---- man/tip/nng_cv_alloc.3supp.html | 529 +---- man/tip/nng_cv_free.3supp.html | 509 +---- man/tip/nng_cv_until.3supp.html | 527 +---- man/tip/nng_cv_wait.3supp.html | 525 +---- man/tip/nng_cv_wake.3supp.html | 527 +---- man/tip/nng_cv_wake1.3supp.html | 527 +---- man/tip/nng_device.3.html | 529 +---- man/tip/nng_dial.3.html | 533 +---- man/tip/nng_dialer.5.html | 547 +---- man/tip/nng_dialer_close.3.html | 523 +---- man/tip/nng_dialer_create.3.html | 533 +---- man/tip/nng_dialer_get.3.html | 263 +++ man/tip/nng_dialer_getopt.3.html | 549 +---- man/tip/nng_dialer_id.3.html | 515 +---- man/tip/nng_dialer_set.3.html | 270 +++ man/tip/nng_dialer_setopt.3.html | 539 +---- man/tip/nng_dialer_start.3.html | 515 +---- man/tip/nng_duration.5.html | 509 +---- man/tip/nng_free.3.html | 515 +---- man/tip/nng_getopt.3.html | 569 +----- man/tip/nng_http_client_alloc.3http.html | 515 +---- man/tip/nng_http_client_connect.3http.html | 527 +---- man/tip/nng_http_client_free.3http.html | 513 +---- man/tip/nng_http_client_get_tls.3http.html | 525 +---- man/tip/nng_http_client_set_tls.3http.html | 521 +---- man/tip/nng_http_client_transact.3http.html | 540 +---- man/tip/nng_http_conn_close.3http.html | 513 +---- man/tip/nng_http_conn_read.3http.html | 529 +---- man/tip/nng_http_conn_read_all.3http.html | 527 +---- man/tip/nng_http_conn_read_req.3http.html | 521 +---- man/tip/nng_http_conn_read_res.3http.html | 529 +---- man/tip/nng_http_conn_transact.3http.html | 533 +---- man/tip/nng_http_conn_write.3http.html | 529 +---- man/tip/nng_http_conn_write_all.3http.html | 549 +---- man/tip/nng_http_conn_write_req.3http.html | 531 +---- man/tip/nng_http_conn_write_res.3http.html | 531 +---- man/tip/nng_http_handler_alloc.3http.html | 567 +----- man/tip/nng_http_handler_collect_body.3http.html | 515 +---- man/tip/nng_http_handler_free.3http.html | 511 +---- man/tip/nng_http_handler_get_data.3http.html | 515 +---- man/tip/nng_http_handler_set_data.3http.html | 515 +---- man/tip/nng_http_handler_set_host.3http.html | 511 +---- man/tip/nng_http_handler_set_method.3http.html | 515 +---- man/tip/nng_http_handler_set_tree.3http.html | 513 +---- man/tip/nng_http_hijack.3http.html | 517 +---- man/tip/nng_http_req_add_header.3http.html | 517 +---- man/tip/nng_http_req_alloc.3http.html | 553 +----- man/tip/nng_http_req_copy_data.3http.html | 519 +---- man/tip/nng_http_req_del_header.3http.html | 515 +---- man/tip/nng_http_req_free.3http.html | 513 +---- man/tip/nng_http_req_get_data.3http.html | 513 +---- man/tip/nng_http_req_get_header.3http.html | 513 +---- man/tip/nng_http_req_get_method.3http.html | 511 +---- man/tip/nng_http_req_get_uri.3http.html | 511 +---- man/tip/nng_http_req_get_version.3http.html | 511 +---- man/tip/nng_http_req_reset.3http.html | 515 +---- man/tip/nng_http_req_set_data.3http.html | 519 +---- man/tip/nng_http_req_set_header.3http.html | 517 +---- man/tip/nng_http_req_set_method.3http.html | 511 +---- man/tip/nng_http_req_set_uri.3http.html | 515 +---- man/tip/nng_http_req_set_version.3http.html | 511 +---- man/tip/nng_http_res_add_header.3http.html | 517 +---- man/tip/nng_http_res_alloc.3http.html | 553 +----- man/tip/nng_http_res_alloc_error.3http.html | 517 +---- man/tip/nng_http_res_copy_data.3http.html | 519 +---- man/tip/nng_http_res_del_header.3http.html | 515 +---- man/tip/nng_http_res_free.3http.html | 513 +---- man/tip/nng_http_res_get_data.3http.html | 513 +---- man/tip/nng_http_res_get_header.3http.html | 513 +---- man/tip/nng_http_res_get_reason.3http.html | 515 +---- man/tip/nng_http_res_get_status.3http.html | 515 +---- man/tip/nng_http_res_get_version.3http.html | 511 +---- man/tip/nng_http_res_reset.3http.html | 511 +---- man/tip/nng_http_res_set_data.3http.html | 519 +---- man/tip/nng_http_res_set_header.3http.html | 517 +---- man/tip/nng_http_res_set_reason.3http.html | 515 +---- man/tip/nng_http_res_set_status.3http.html | 515 +---- man/tip/nng_http_res_set_version.3http.html | 511 +---- man/tip/nng_http_server_add_handler.3http.html | 517 +---- man/tip/nng_http_server_del_handler.3http.html | 513 +---- man/tip/nng_http_server_get_addr.3http.html | 96 + man/tip/nng_http_server_get_tls.3http.html | 525 +---- man/tip/nng_http_server_hold.3http.html | 519 +---- man/tip/nng_http_server_release.3http.html | 513 +---- man/tip/nng_http_server_res_error.3http.html | 525 +---- man/tip/nng_http_server_set_error_file.3http.html | 523 +---- man/tip/nng_http_server_set_error_page.3http.html | 523 +---- man/tip/nng_http_server_set_tls.3http.html | 523 +---- man/tip/nng_http_server_start.3http.html | 517 +---- man/tip/nng_http_server_stop.3http.html | 521 +---- man/tip/nng_inproc.7.html | 531 +---- man/tip/nng_inproc_register.3.html | 509 +---- man/tip/nng_iov.5.html | 519 +---- man/tip/nng_ipc.5.html | 666 ------- man/tip/nng_ipc.7.html | 535 +---- man/tip/nng_ipc_close.3ipc.html | 615 ------ man/tip/nng_ipc_dialer.5.html | 594 ------ man/tip/nng_ipc_dialer_alloc.3ipc.html | 590 ------ man/tip/nng_ipc_dialer_close.3ipc.html | 603 ------ man/tip/nng_ipc_dialer_dial.3ipc.html | 650 ------ man/tip/nng_ipc_dialer_free.3ipc.html | 598 ------ man/tip/nng_ipc_dialer_getopt.3ipc.html | 632 ------ man/tip/nng_ipc_dialer_setopt.3ipc.html | 627 ------ man/tip/nng_ipc_free.3ipc.html | 613 ------ man/tip/nng_ipc_getopt.3ipc.html | 653 ------ man/tip/nng_ipc_listener.5.html | 595 ------ man/tip/nng_ipc_listener_accept.3ipc.html | 634 ------ man/tip/nng_ipc_listener_alloc.3ipc.html | 591 ------ man/tip/nng_ipc_listener_close.3ipc.html | 603 ------ man/tip/nng_ipc_listener_free.3ipc.html | 596 ------ man/tip/nng_ipc_listener_getopt.3ipc.html | 639 ------ man/tip/nng_ipc_listener_listen.3ipc.html | 625 ------ man/tip/nng_ipc_listener_setopt.3ipc.html | 649 ------ man/tip/nng_ipc_options.5.html | 525 +---- man/tip/nng_ipc_recv.3ipc.html | 660 ------ man/tip/nng_ipc_register.3.html | 509 +---- man/tip/nng_ipc_send.3ipc.html | 659 ------ man/tip/nng_ipc_setopt.3ipc.html | 625 ------ man/tip/nng_listen.3.html | 529 +---- man/tip/nng_listener.5.html | 547 +---- man/tip/nng_listener_close.3.html | 517 +---- man/tip/nng_listener_create.3.html | 533 +---- man/tip/nng_listener_get.3.html | 263 +++ man/tip/nng_listener_getopt.3.html | 553 +----- man/tip/nng_listener_id.3.html | 515 +---- man/tip/nng_listener_set.3.html | 268 +++ man/tip/nng_listener_setopt.3.html | 545 +---- man/tip/nng_listener_start.3.html | 517 +---- man/tip/nng_msg.5.html | 539 +---- man/tip/nng_msg_alloc.3.html | 525 +---- man/tip/nng_msg_append.3.html | 527 +---- man/tip/nng_msg_body.3.html | 537 +---- man/tip/nng_msg_chop.3.html | 527 +---- man/tip/nng_msg_clear.3.html | 509 +---- man/tip/nng_msg_dup.3.html | 515 +---- man/tip/nng_msg_free.3.html | 513 +---- man/tip/nng_msg_get_pipe.3.html | 517 +---- man/tip/nng_msg_header.3.html | 527 +---- man/tip/nng_msg_header_append.3.html | 523 +---- man/tip/nng_msg_header_chop.3.html | 523 +---- man/tip/nng_msg_header_clear.3.html | 511 +---- man/tip/nng_msg_header_insert.3.html | 525 +---- man/tip/nng_msg_header_len.3.html | 513 +---- man/tip/nng_msg_header_trim.3.html | 525 +---- man/tip/nng_msg_insert.3.html | 527 +---- man/tip/nng_msg_len.3.html | 513 +---- man/tip/nng_msg_realloc.3.html | 531 +---- man/tip/nng_msg_set_pipe.3.html | 523 +---- man/tip/nng_msg_trim.3.html | 527 +---- man/tip/nng_msleep.3supp.html | 515 +---- man/tip/nng_mtx_alloc.3supp.html | 517 +---- man/tip/nng_mtx_free.3supp.html | 509 +---- man/tip/nng_mtx_lock.3supp.html | 515 +---- man/tip/nng_mtx_unlock.3supp.html | 515 +---- man/tip/nng_options.5.html | 619 +----- man/tip/nng_opts_parse.3supp.html | 509 +---- man/tip/nng_pair.7.html | 531 +---- man/tip/nng_pair_open.3.html | 521 +---- man/tip/nng_pipe.5.html | 535 +---- man/tip/nng_pipe_close.3.html | 516 +---- man/tip/nng_pipe_dialer.3.html | 515 +---- man/tip/nng_pipe_get.3.html | 279 +++ man/tip/nng_pipe_getopt.3.html | 561 +----- man/tip/nng_pipe_id.3.html | 511 +---- man/tip/nng_pipe_listener.3.html | 515 +---- man/tip/nng_pipe_notify.3.html | 529 +---- man/tip/nng_pipe_socket.3.html | 513 +---- man/tip/nng_pub.7.html | 515 +---- man/tip/nng_pub_open.3.html | 523 +---- man/tip/nng_pull.7.html | 515 +---- man/tip/nng_pull_open.3.html | 523 +---- man/tip/nng_push.7.html | 519 +---- man/tip/nng_push_open.3.html | 523 +---- man/tip/nng_random.3supp.html | 507 +---- man/tip/nng_recv.3.html | 531 +---- man/tip/nng_recv_aio.3.html | 539 +---- man/tip/nng_recvmsg.3.html | 523 +---- man/tip/nng_rep.7.html | 523 +---- man/tip/nng_rep_open.3.html | 527 +---- man/tip/nng_req.7.html | 537 +---- man/tip/nng_req_open.3.html | 525 +---- man/tip/nng_respondent.7.html | 523 +---- man/tip/nng_respondent_open.3.html | 523 +---- man/tip/nng_send.3.html | 537 +---- man/tip/nng_send_aio.3.html | 543 +---- man/tip/nng_sendmsg.3.html | 531 +---- man/tip/nng_setopt.3.html | 539 +---- man/tip/nng_sleep_aio.3.html | 521 +---- man/tip/nng_sockaddr.5.html | 527 +---- man/tip/nng_sockaddr_in.5.html | 517 +---- man/tip/nng_sockaddr_in6.5.html | 519 +---- man/tip/nng_sockaddr_inproc.5.html | 515 +---- man/tip/nng_sockaddr_ipc.5.html | 515 +---- man/tip/nng_sockaddr_zt.5.html | 517 +---- man/tip/nng_socket.5.html | 535 +---- man/tip/nng_socket_get.3.html | 257 +++ man/tip/nng_socket_id.3.html | 515 +---- man/tip/nng_socket_set.3.html | 246 +++ man/tip/nng_stat.5.html | 569 +----- man/tip/nng_stat_child.3.html | 521 +---- man/tip/nng_stat_desc.3.html | 519 +---- man/tip/nng_stat_find.3.html | 102 + man/tip/nng_stat_find_dialer.3.html | 97 + man/tip/nng_stat_find_listener.3.html | 97 + man/tip/nng_stat_find_socket.3.html | 97 + man/tip/nng_stat_name.3.html | 517 +---- man/tip/nng_stat_next.3.html | 519 +---- man/tip/nng_stat_string.3.html | 523 +---- man/tip/nng_stat_timestamp.3.html | 523 +---- man/tip/nng_stat_type.3.html | 533 +---- man/tip/nng_stat_unit.3.html | 533 +---- man/tip/nng_stat_value.3.html | 527 +---- man/tip/nng_stats_free.3.html | 517 +---- man/tip/nng_stats_get.3.html | 541 +---- man/tip/nng_strdup.3.html | 517 +---- man/tip/nng_stream.5.html | 133 ++ man/tip/nng_stream_close.3str.html | 124 ++ man/tip/nng_stream_dialer.5.html | 84 + man/tip/nng_stream_dialer_alloc.3str.html | 132 ++ man/tip/nng_stream_dialer_close.3str.html | 110 + man/tip/nng_stream_dialer_dial.3str.html | 157 ++ man/tip/nng_stream_dialer_free.3str.html | 103 + man/tip/nng_stream_dialer_get.3str.html | 252 +++ man/tip/nng_stream_dialer_set.3str.html | 239 +++ man/tip/nng_stream_free.3str.html | 120 ++ man/tip/nng_stream_get.3str.html | 255 +++ man/tip/nng_stream_listener.5.html | 86 + man/tip/nng_stream_listener_accept.3str.html | 140 ++ man/tip/nng_stream_listener_alloc.3str.html | 134 ++ man/tip/nng_stream_listener_close.3str.html | 110 + man/tip/nng_stream_listener_free.3str.html | 103 + man/tip/nng_stream_listener_get.3str.html | 253 +++ man/tip/nng_stream_listener_listen.3str.html | 136 ++ man/tip/nng_stream_listener_set.3str.html | 239 +++ man/tip/nng_stream_recv.3str.html | 174 ++ man/tip/nng_stream_send.3str.html | 167 ++ man/tip/nng_stream_set.3str.html | 239 +++ man/tip/nng_strerror.3.html | 509 +---- man/tip/nng_strfree.3.html | 525 +---- man/tip/nng_sub.7.html | 539 +---- man/tip/nng_sub_open.3.html | 523 +---- man/tip/nng_surveyor.7.html | 530 +---- man/tip/nng_surveyor_open.3.html | 523 +---- man/tip/nng_tcp.5.html | 560 +----- man/tip/nng_tcp.7.html | 533 +---- man/tip/nng_tcp_close.3tcp.html | 615 ------ man/tip/nng_tcp_dialer.5.html | 593 ------ man/tip/nng_tcp_dialer_alloc.3tcp.html | 592 ------ man/tip/nng_tcp_dialer_close.3tcp.html | 603 ------ man/tip/nng_tcp_dialer_dial.3tcp.html | 642 ------ man/tip/nng_tcp_dialer_free.3tcp.html | 597 ------ man/tip/nng_tcp_dialer_getopt.3tcp.html | 646 ------ man/tip/nng_tcp_dialer_setopt.3tcp.html | 640 ------ man/tip/nng_tcp_free.3tcp.html | 613 ------ man/tip/nng_tcp_getopt.3tcp.html | 647 ------ man/tip/nng_tcp_listener.5.html | 596 ------ man/tip/nng_tcp_listener_accept.3tcp.html | 640 ------ man/tip/nng_tcp_listener_alloc.3tcp.html | 593 ------ man/tip/nng_tcp_listener_close.3tcp.html | 603 ------ man/tip/nng_tcp_listener_free.3tcp.html | 596 ------ man/tip/nng_tcp_listener_getopt.3tcp.html | 645 ------ man/tip/nng_tcp_listener_listen.3tcp.html | 637 ------ man/tip/nng_tcp_listener_setopt.3tcp.html | 637 ------ man/tip/nng_tcp_options.5.html | 547 +---- man/tip/nng_tcp_recv.3tcp.html | 673 ------- man/tip/nng_tcp_register.3.html | 509 +---- man/tip/nng_tcp_send.3tcp.html | 672 ------- man/tip/nng_tcp_setopt.3tcp.html | 636 ------ man/tip/nng_thread_create.3supp.html | 527 +---- man/tip/nng_thread_destroy.3supp.html | 509 +---- man/tip/nng_tls.5.html | 559 +----- man/tip/nng_tls.7.html | 549 +---- man/tip/nng_tls_close.3tls.html | 615 ------ man/tip/nng_tls_config.5.html | 525 +---- man/tip/nng_tls_config_alloc.3tls.html | 527 +---- man/tip/nng_tls_config_auth_mode.3tls.html | 517 +---- man/tip/nng_tls_config_ca_chain.3tls.html | 515 +---- man/tip/nng_tls_config_ca_file.3tls.html | 515 +---- man/tip/nng_tls_config_cert_key_file.3tls.html | 513 +---- man/tip/nng_tls_config_free.3tls.html | 509 +---- man/tip/nng_tls_config_hold.3tls.html | 513 +---- man/tip/nng_tls_config_own_cert.3tls.html | 513 +---- man/tip/nng_tls_config_server_name.3tls.html | 513 +---- man/tip/nng_tls_dialer.5.html | 594 ------ man/tip/nng_tls_dialer_alloc.3tls.html | 600 ------ man/tip/nng_tls_dialer_close.3tls.html | 603 ------ man/tip/nng_tls_dialer_dial.3tls.html | 650 ------ man/tip/nng_tls_dialer_free.3tls.html | 597 ------ man/tip/nng_tls_dialer_getopt.3tls.html | 651 ------ man/tip/nng_tls_dialer_setopt.3tls.html | 656 ------ man/tip/nng_tls_free.3tls.html | 613 ------ man/tip/nng_tls_getopt.3tls.html | 651 ------ man/tip/nng_tls_listener.5.html | 596 ------ man/tip/nng_tls_listener_accept.3tls.html | 642 ------ man/tip/nng_tls_listener_alloc.3tls.html | 601 ------ man/tip/nng_tls_listener_close.3tls.html | 603 ------ man/tip/nng_tls_listener_free.3tls.html | 596 ------ man/tip/nng_tls_listener_getopt.3tls.html | 650 ------ man/tip/nng_tls_listener_listen.3tls.html | 646 ------ man/tip/nng_tls_listener_setopt.3tls.html | 652 ------ man/tip/nng_tls_options.5.html | 543 +---- man/tip/nng_tls_recv.3tls.html | 668 ------- man/tip/nng_tls_register.3.html | 509 +---- man/tip/nng_tls_send.3tls.html | 667 ------- man/tip/nng_tls_setopt.3tls.html | 636 ------ man/tip/nng_url_clone.3.html | 513 +---- man/tip/nng_url_free.3.html | 511 +---- man/tip/nng_url_parse.3.html | 515 +---- man/tip/nng_version.3.html | 509 +---- man/tip/nng_ws.7.html | 533 +---- man/tip/nng_ws_register.3.html | 509 +---- man/tip/nng_wss_register.3.html | 511 +---- man/tip/nng_zerotier.7.html | 521 +---- man/tip/nng_zt_register.3.html | 509 +---- man/tip/nngcat.1.html | 571 +----- man/tip/pygments-default.css | 69 + 377 files changed, 12053 insertions(+), 181288 deletions(-) create mode 100644 man/tip/asciidoctor.css create mode 100644 man/tip/nng_ctx_get.3.html create mode 100644 man/tip/nng_ctx_set.3.html create mode 100644 man/tip/nng_dialer_get.3.html create mode 100644 man/tip/nng_dialer_set.3.html create mode 100644 man/tip/nng_http_server_get_addr.3http.html delete mode 100644 man/tip/nng_ipc.5.html delete mode 100644 man/tip/nng_ipc_close.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer.5.html delete mode 100644 man/tip/nng_ipc_dialer_alloc.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer_close.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer_dial.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer_free.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer_getopt.3ipc.html delete mode 100644 man/tip/nng_ipc_dialer_setopt.3ipc.html delete mode 100644 man/tip/nng_ipc_free.3ipc.html delete mode 100644 man/tip/nng_ipc_getopt.3ipc.html delete mode 100644 man/tip/nng_ipc_listener.5.html delete mode 100644 man/tip/nng_ipc_listener_accept.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_alloc.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_close.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_free.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_getopt.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_listen.3ipc.html delete mode 100644 man/tip/nng_ipc_listener_setopt.3ipc.html delete mode 100644 man/tip/nng_ipc_recv.3ipc.html delete mode 100644 man/tip/nng_ipc_send.3ipc.html delete mode 100644 man/tip/nng_ipc_setopt.3ipc.html create mode 100644 man/tip/nng_listener_get.3.html create mode 100644 man/tip/nng_listener_set.3.html create mode 100644 man/tip/nng_pipe_get.3.html create mode 100644 man/tip/nng_socket_get.3.html create mode 100644 man/tip/nng_socket_set.3.html create mode 100644 man/tip/nng_stat_find.3.html create mode 100644 man/tip/nng_stat_find_dialer.3.html create mode 100644 man/tip/nng_stat_find_listener.3.html create mode 100644 man/tip/nng_stat_find_socket.3.html create mode 100644 man/tip/nng_stream.5.html create mode 100644 man/tip/nng_stream_close.3str.html create mode 100644 man/tip/nng_stream_dialer.5.html create mode 100644 man/tip/nng_stream_dialer_alloc.3str.html create mode 100644 man/tip/nng_stream_dialer_close.3str.html create mode 100644 man/tip/nng_stream_dialer_dial.3str.html create mode 100644 man/tip/nng_stream_dialer_free.3str.html create mode 100644 man/tip/nng_stream_dialer_get.3str.html create mode 100644 man/tip/nng_stream_dialer_set.3str.html create mode 100644 man/tip/nng_stream_free.3str.html create mode 100644 man/tip/nng_stream_get.3str.html create mode 100644 man/tip/nng_stream_listener.5.html create mode 100644 man/tip/nng_stream_listener_accept.3str.html create mode 100644 man/tip/nng_stream_listener_alloc.3str.html create mode 100644 man/tip/nng_stream_listener_close.3str.html create mode 100644 man/tip/nng_stream_listener_free.3str.html create mode 100644 man/tip/nng_stream_listener_get.3str.html create mode 100644 man/tip/nng_stream_listener_listen.3str.html create mode 100644 man/tip/nng_stream_listener_set.3str.html create mode 100644 man/tip/nng_stream_recv.3str.html create mode 100644 man/tip/nng_stream_send.3str.html create mode 100644 man/tip/nng_stream_set.3str.html delete mode 100644 man/tip/nng_tcp_close.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer.5.html delete mode 100644 man/tip/nng_tcp_dialer_alloc.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer_close.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer_dial.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer_free.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer_getopt.3tcp.html delete mode 100644 man/tip/nng_tcp_dialer_setopt.3tcp.html delete mode 100644 man/tip/nng_tcp_free.3tcp.html delete mode 100644 man/tip/nng_tcp_getopt.3tcp.html delete mode 100644 man/tip/nng_tcp_listener.5.html delete mode 100644 man/tip/nng_tcp_listener_accept.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_alloc.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_close.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_free.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_getopt.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_listen.3tcp.html delete mode 100644 man/tip/nng_tcp_listener_setopt.3tcp.html delete mode 100644 man/tip/nng_tcp_recv.3tcp.html delete mode 100644 man/tip/nng_tcp_send.3tcp.html delete mode 100644 man/tip/nng_tcp_setopt.3tcp.html delete mode 100644 man/tip/nng_tls_close.3tls.html delete mode 100644 man/tip/nng_tls_dialer.5.html delete mode 100644 man/tip/nng_tls_dialer_alloc.3tls.html delete mode 100644 man/tip/nng_tls_dialer_close.3tls.html delete mode 100644 man/tip/nng_tls_dialer_dial.3tls.html delete mode 100644 man/tip/nng_tls_dialer_free.3tls.html delete mode 100644 man/tip/nng_tls_dialer_getopt.3tls.html delete mode 100644 man/tip/nng_tls_dialer_setopt.3tls.html delete mode 100644 man/tip/nng_tls_free.3tls.html delete mode 100644 man/tip/nng_tls_getopt.3tls.html delete mode 100644 man/tip/nng_tls_listener.5.html delete mode 100644 man/tip/nng_tls_listener_accept.3tls.html delete mode 100644 man/tip/nng_tls_listener_alloc.3tls.html delete mode 100644 man/tip/nng_tls_listener_close.3tls.html delete mode 100644 man/tip/nng_tls_listener_free.3tls.html delete mode 100644 man/tip/nng_tls_listener_getopt.3tls.html delete mode 100644 man/tip/nng_tls_listener_listen.3tls.html delete mode 100644 man/tip/nng_tls_listener_setopt.3tls.html delete mode 100644 man/tip/nng_tls_recv.3tls.html delete mode 100644 man/tip/nng_tls_send.3tls.html delete mode 100644 man/tip/nng_tls_setopt.3tls.html create mode 100644 man/tip/pygments-default.css diff --git a/man/tip/asciidoctor.css b/man/tip/asciidoctor.css new file mode 100644 index 00000000..9d9cc70c --- /dev/null +++ b/man/tip/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/tip/index.html b/man/tip/index.html index 4f28b422..083eed4d 100644 --- a/man/tip/index.html +++ b/man/tip/index.html @@ -1,499 +1,51 @@ ---- -version: tip -layout: refman ---- - + - -NNG Reference Manual: tip + +Section 3tls: Supplemental TLS Functions - - +
-
-
-
-

The following pages are present:

-
-
-
-

Section 1: Commands and Utilities

+

Section 3tls: Supplemental TLS Functions

-

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

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

nngcat(1)

command line access to Scalability Protocols

-
+

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

-
-

Section 3: Library Functions

-
-

This section documents core libary functions supporting Scalability -Protocols.

+

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

-

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

+

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

@@ -502,505 +54,359 @@ primary API for building such applications.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + +

libnng(3)

nanomsg next generation library

nng_aio_abort(3)

abort asynchronous I/O operation

nng_aio_alloc(3)

allocate asynchronous I/O handle

nng_aio_begin(3)

begin asynchronous I/O operation

nng_aio_cancel(3)

cancel asynchronous I/O operation

nng_aio_count(3)

return number of bytes transferred

nng_aio_defer(3)

defer asynchronous I/O operation

nng_aio_finish(3)

finish asynchronous I/O operation

nng_aio_free(3)

free asynchronous I/O handle

nng_aio_get_input(3)

return input parameter

nng_aio_get_msg(3)

get message from asynchronous receive

nng_aio_get_output(3)

return output result

nng_aio_result(3)

return result of asynchronous operation

nng_aio_set_input(3)

set input parameter

nng_aio_set_iov(3)

set scatter/gather vector

nng_aio_set_msg(3)

set message for asynchronous send

nng_aio_set_output(3)

set output result

nng_aio_set_timeout(3)

set asynchronous I/O timeout

nng_aio_stop(3)

stop asynchronous I/O operation

nng_aio_wait(3)

wait for asynchronous I/O operation

nng_alloc(3)

allocate memory

nng_bus_open(3)

create bus socket

nng_close(3)

close socket

nng_ctx_close(3)

close context

nng_ctx_getopt(3)

get context option

nng_ctx_id(3)

return numeric context identifier

nng_ctx_open(3)

create context

nng_ctx_recv(3)

receive message using context asynchronously

nng_ctx_send(3)

send message using context asynchronously

nng_ctx_setopt(3)

set context option

nng_device(3)

message forwarding device

nng_dial(3)

create and start dialer

nng_dialer_close(3)

close dialer

nng_dialer_create(3)

create dialer

nng_dialer_getopt(3)

get dialer option

nng_dialer_id(3)

return numeric dialer identifier

nng_dialer_setopt(3)

set dialer option

nng_dialer_start(3)

start dialer

nng_free(3)

free memory

nng_tls_config_alloc.3tls(3tls)

allocate TLS configuration object

nng_getopt(3)

get socket option

nng_tls_config_auth_mode.3tls(3tls)

configure authentication mode

nng_inproc_register(3)

register inproc transport

nng_tls_config_ca_chain.3tls(3tls)

configure certificate authority certificate chain

nng_ipc_register(3)

register ipc transport

nng_tls_config_ca_file.3tls(3tls)

load certificate authority from file

nng_listen(3)

create and start listener

nng_tls_config_cert_key_file.3tls(3tls)

load own certificate and key from file

nng_listener_close(3)

close listener

nng_tls_config_free.3tls(3tls)

deallocate a TLS configuration object

nng_listener_create(3)

create listener

nng_tls_config_hold.3tls(3tls)

hold TLS configuration object

nng_listener_getopt(3)

get listener option

nng_tls_config_own_cert.3tls(3tls)

configure own certificate and key

nng_listener_id(3)

return numeric listener identifier

nng_tls_config_server_name.3tls(3tls)

configure remote server name
+
+
+
+

Section 3http: Supplemental HTTP Functions

+
+
+

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

+
+
+

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

+
+
+

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

+
+ ++++ + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

nng_listener_setopt(3)

set listener option

nng_http_client_alloc.3http(3http)

allocate HTTP client

nng_listener_start(3)

start listener

nng_http_client_connect.3http(3http)

establish HTTP client connection

nng_msg_alloc(3)

allocate a message

nng_http_client_free.3http(3http)

free HTTP client

nng_msg_append(3)

append to message body

nng_http_client_get_tls.3http(3http)

get HTTP client TLS configuration

nng_msg_body(3)

return message body

nng_http_client_set_tls.3http(3http)

set HTTP client TLS configuration

nng_msg_chop(3)

remove data from end of message body

nng_http_client_transact.3http(3http)

perform one HTTP transaction

nng_msg_clear(3)

clear message body content

nng_http_conn_close.3http(3http)

close HTTP connection

nng_msg_dup(3)

duplicate a message

nng_http_conn_read.3http(3http)

read from HTTP connection

nng_msg_free(3)

free a message

nng_http_conn_read_all.3http(3http)

read all from HTTP connection

nng_msg_get_pipe(3)

get pipe for message

nng_http_conn_read_req.3http(3http)

read HTTP request

nng_msg_header(3)

return message header

nng_http_conn_read_res.3http(3http)

read HTTP response

nng_msg_header_append(3)

append to message header

nng_http_conn_transact.3http(3http)

perform one HTTP transaction on connection

nng_msg_header_chop(3)

remove data from end of message header

nng_http_conn_write.3http(3http)

write to HTTP connection

nng_msg_header_clear(3)

clear message header

nng_http_conn_write_all.3http(3http)

write all to HTTP connection

nng_msg_header_insert(3)

prepend to message header

nng_http_conn_write_req.3http(3http)

write HTTP request

nng_msg_header_len(3)

return message header length

nng_http_conn_write_res.3http(3http)

write HTTP response

nng_msg_header_trim(3)

remove data from start of message header

nng_http_handler_alloc.3http(3http)

allocate HTTP server handler

nng_msg_insert(3)

prepend to message body

nng_http_handler_collect_body.3http(3http)

set HTTP handler to collect request body

nng_msg_len(3)

return message body length

nng_http_handler_free.3http(3http)

free HTTP server handler

nng_msg_realloc(3)

reallocate a message

nng_http_handler_get_data.3http(3http)

return extra data for HTTP handler

nng_msg_set_pipe(3)

set pipe for message

nng_http_handler_set_data.3http(3http)

set extra data for HTTP handler

nng_msg_trim(3)

remove data from start of message body

nng_http_handler_set_host.3http(3http)

set host for HTTP handler

nng_pair_open(3)

create pair socket

nng_http_handler_set_method.3http(3http)

set HTTP handler method

nng_pipe_close(3)

close pipe

nng_http_handler_set_tree.3http(3http)

set HTTP handler to match trees

nng_pipe_dialer(3)

return dialer that created pipe

nng_http_hijack.3http(3http)

hijack HTTP server connection

nng_pipe_getopt(3)

get pipe option

nng_http_req_add_header.3http(3http)

add HTTP request header

nng_pipe_id(3)

return numeric pipe identifier

nng_http_req_alloc.3http(3http)

allocate HTTP request structure

nng_pipe_listener(3)

return listener that created pipe

nng_http_req_copy_data.3http(3http)

copy HTTP request body

nng_pipe_notify(3)

register pipe notification callback

nng_http_req_del_header.3http(3http)

delete HTTP request header

nng_pipe_socket(3)

return owning socket for pipe

nng_http_req_free.3http(3http)

free HTTP request structure

nng_pub_open(3)

create pub socket

nng_http_req_get_data.3http(3http)

get HTTP request body

nng_pull_open(3)

create pull socket

nng_http_req_get_header.3http(3http)

return HTTP request header

nng_push_open(3)

create push socket

nng_http_req_get_method.3http(3http)

return HTTP request method

nng_recv(3)

recv data

nng_http_req_get_uri.3http(3http)

return HTTP request URI

nng_recv_aio(3)

receive message asynchronously

nng_http_req_get_version.3http(3http)

return HTTP request protocol version

nng_recvmsg(3)

recv message

nng_http_req_reset.3http(3http)

reset HTTP request structure

nng_rep_open(3)

create rep socket

nng_http_req_set_data.3http(3http)

set HTTP request body

nng_req_open(3)

create req socket

nng_http_req_set_header.3http(3http)

set HTTP request header

nng_respondent_open(3)

create respondent socket

nng_http_req_set_method.3http(3http)

set HTTP request method

nng_send(3)

send data

nng_http_req_set_uri.3http(3http)

set HTTP request URI

nng_send_aio(3)

send message asynchronously

nng_http_req_set_version.3http(3http)

set HTTP request protocol version

nng_sendmsg(3)

send message

nng_http_res_add_header.3http(3http)

add HTTP response header

nng_setopt(3)

set socket option

nng_http_res_alloc.3http(3http)

allocate HTTP response structure

nng_sleep_aio(3)

sleep asynchronously

nng_http_res_alloc_error.3http(3http)

allocate HTTP error response

nng_socket_id(3)

return numeric socket identifier

nng_http_res_copy_data.3http(3http)

copy HTTP response body

nng_stat_child(3)

get child statistic

nng_http_res_del_header.3http(3http)

set HTTP response header

nng_stat_desc(3)

get statistic description

nng_http_res_free.3http(3http)

free HTTP response structure

nng_stat_name(3)

get statistic name

nng_http_res_get_data.3http(3http)

get HTTP response body

nng_stat_next(3)

get next statistic

nng_http_res_get_header.3http(3http)

return HTTP response header

nng_stat_string(3)

get statistic string value

nng_http_res_get_reason.3http(3http)

return HTTP response reason

nng_stat_timestamp(3)

get statistic timestamp

nng_http_res_get_status.3http(3http)

return HTTP status code

nng_stat_type(3)

get statistic value

nng_http_res_get_version.3http(3http)

return HTTP response protocol version

nng_stat_unit(3)

get statistic value

nng_http_res_reset.3http(3http)

reset HTTP response structure

nng_stat_value(3)

get statistic value

nng_http_res_set_data.3http(3http)

set HTTP response body

nng_stats_free(3)

free statistics snapshot

nng_http_res_set_header.3http(3http)

set HTTP response header

nng_stats_get(3)

get statistics snapshot

nng_http_res_set_reason.3http(3http)

set HTTP response reason

nng_strdup(3)

duplicate string

nng_http_res_set_status.3http(3http)

set HTTP response status

nng_strerror(3)

return an error description

nng_http_res_set_version.3http(3http)

set HTTP response protocol version

nng_strfree(3)

free memory

nng_http_server_add_handler.3http(3http)

add HTTP server handler

nng_sub_open(3)

create sub socket

nng_http_server_del_handler.3http(3http)

delete HTTP server handler

nng_surveyor_open(3)

create surveyor socket

nng_http_server_get_addr.3http(3http)

get HTTP server address

nng_tcp_register(3)

register tcp transport

nng_http_server_get_tls.3http(3http)

get HTTP server TLS configuration

nng_tls_register(3)

register tls transport

nng_http_server_hold.3http(3http)

get and hold HTTP server instance

nng_url_clone(3)

clone URL structure

nng_http_server_release.3http(3http)

release HTTP server instance

nng_url_free(3)

free a URL structure

nng_http_server_res_error.3http(3http)

use HTTP server error page

nng_url_parse(3)

create URL structure from a string

nng_http_server_set_error_file.3http(3http)

set custom HTTP error file

nng_version(3)

report library version

nng_http_server_set_error_page.3http(3http)

set custom HTTP error page

nng_ws_register(3)

register WebSocket transport

nng_http_server_set_tls.3http(3http)

set HTTP server TLS configuration

nng_wss_register(3)

register WebSocket secure transport

nng_http_server_start.3http(3http)

start HTTP server

nng_zt_register(3)

register ZeroTier transport

nng_http_server_stop.3http(3http)

stop HTTP server
-

Section 3compat: Compatible Library Functions

+

Section 1: Commands and Utilities

-

This section documents the nanomsg 1.0 libary compatible functions.

-
-
-

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

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

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

@@ -1009,819 +415,637 @@ the legacy API to the new API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

nn_allocmsg(3compat)

allocate message (compatible API)

nn_bind(3compat)

accept connections from remote peers (compatible API)

nn_close(3compat)

close socket (compatible API)

nn_cmsg(3compat)

message control data (compatible API)

nn_connect(3compat)

connect to remote peer (compatible API)

nn_device(3compat)

create forwarding device (compatible API)

nn_errno(3compat)

return most recent error (compatible API)

nn_freemsg(3compat)

free message (compatible API)

nn_get_statistic(3compat)

get statistic (stub)

nn_getsockopt(3compat)

get socket option (compatible API)

nn_poll(3compat)

poll sockets (compatible API)

nn_reallocmsg(3compat)

reallocate message (compatible API)

nn_recv(3compat)

receive data (compatible API)

nn_recvmsg(3compat)

receive message (compatible API)

nn_send(3compat)

send data (compatible API)

nn_sendmsg(3compat)

send message (compatible API)

nn_setsockopt(3compat)

set socket option (compatible API)

nn_shutdown(3compat)

shut down endpoint (compatible API)

nn_socket(3compat)

create socket (compatible API)

nn_strerror(3compat)

return message for error (compatible API)

nn_term(3compat)

terminate library (compatible API)

nng_compat(3compat)

compatibility with nanomsg 1.0

nngcat.1(1)

command line access to Scalability Protocols
-

Section 3http: Supplemental HTTP Functions

+

Section 3supp: Supplemental Functions

-

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

-
-
-

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

+

This section documents supplemental functions that are available. +These functions are not intrinsic to building Scalability Protocols +applications with this library.

-

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

+

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

---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ++++ + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + +

nng_http_client_alloc(3http)

allocate HTTP client

nng_http_client_connect(3http)

establish HTTP client connection

nng_http_client_free(3http)

free HTTP client

nng_http_client_get_tls(3http)

get HTTP client TLS configuration

nng_http_client_set_tls(3http)

set HTTP client TLS configuration

nng_http_client_transact(3http)

perform one HTTP transaction

nng_http_conn_close(3http)

close HTTP connection

nng_http_conn_read(3http)

read from HTTP connection

nng_clock.3supp(3supp)

get time

nng_http_conn_read_all(3http)

read all from HTTP connection

nng_cv_alloc.3supp(3supp)

allocate condition variable

nng_http_conn_read_req(3http)

read HTTP request

nng_cv_free.3supp(3supp)

free condition variable

nng_http_conn_read_res(3http)

read HTTP response

nng_cv_until.3supp(3supp)

wait for condition or timeout

nng_http_conn_transact(3http)

perform one HTTP transaction on connection

nng_cv_wait.3supp(3supp)

wait for condition

nng_http_conn_write(3http)

write to HTTP connection

nng_cv_wake.3supp(3supp)

wake all waiters

nng_http_conn_write_all(3http)

write all to HTTP connection

nng_cv_wake1.3supp(3supp)

wake one waiter

nng_http_conn_write_req(3http)

write HTTP request

nng_msleep.3supp(3supp)

sleep milliseconds

nng_http_conn_write_res(3http)

write HTTP response

nng_mtx_alloc.3supp(3supp)

allocate mutex

nng_http_handler_alloc(3http)

allocate HTTP server handler

nng_mtx_free.3supp(3supp)

free mutex

nng_http_handler_collect_body(3http)

set HTTP handler to collect request body

nng_mtx_lock.3supp(3supp)

lock mutex

nng_http_handler_free(3http)

free HTTP server handler

nng_mtx_unlock.3supp(3supp)

unlock mutex

nng_http_handler_get_data(3http)

return extra data for HTTP handler

nng_opts_parse.3supp(3supp)

parse command line options

nng_http_handler_set_data(3http)

set extra data for HTTP handler

nng_random.3supp(3supp)

get random number

nng_http_handler_set_host(3http)

set host for HTTP handler

nng_thread_create.3supp(3supp)

create thread

nng_http_handler_set_method(3http)

set HTTP handler method

nng_thread_destroy.3supp(3supp)

reap thread
+
+
+
+

Section 3: Library Functions

+
+
+

This section documents core libary functions supporting Scalability +Protocols.

+
+
+

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

+
+ ++++ + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - -

nng_http_handler_set_tree(3http)

set HTTP handler to match trees

libnng.3(3)

nanomsg next generation library

nng_http_hijack(3http)

hijack HTTP server connection

nng_aio_abort.3(3)

abort asynchronous I/O operation

nng_http_req_add_header(3http)

add HTTP request header

nng_aio_alloc.3(3)

allocate asynchronous I/O handle

nng_http_req_alloc(3http)

allocate HTTP request structure

nng_aio_begin.3(3)

begin asynchronous I/O operation

nng_http_req_copy_data(3http)

copy HTTP request body

nng_aio_cancel.3(3)

cancel asynchronous I/O operation

nng_http_req_del_header(3http)

delete HTTP request header

nng_aio_count.3(3)

return number of bytes transferred

nng_http_req_free(3http)

free HTTP request structure

nng_aio_defer.3(3)

defer asynchronous I/O operation

nng_http_req_get_data(3http)

get HTTP request body

nng_aio_finish.3(3)

finish asynchronous I/O operation

nng_http_req_get_header(3http)

return HTTP request header

nng_aio_free.3(3)

free asynchronous I/O handle

nng_http_req_get_method(3http)

return HTTP request method

nng_aio_get_input.3(3)

return input parameter

nng_http_req_get_uri(3http)

return HTTP request URI

nng_aio_get_msg.3(3)

get message from asynchronous receive

nng_http_req_get_version(3http)

return HTTP request protocol version

nng_aio_get_output.3(3)

return output result

nng_http_req_reset(3http)

reset HTTP request structure

nng_aio_result.3(3)

return result of asynchronous operation

nng_http_req_set_data(3http)

set HTTP request body

nng_aio_set_input.3(3)

set input parameter

nng_http_req_set_header(3http)

set HTTP request header

nng_aio_set_iov.3(3)

set scatter/gather vector

nng_http_req_set_method(3http)

set HTTP request method

nng_aio_set_msg.3(3)

set message for asynchronous send

nng_http_req_set_uri(3http)

set HTTP request URI

nng_aio_set_output.3(3)

set output result

nng_http_req_set_version(3http)

set HTTP request protocol version

nng_aio_set_timeout.3(3)

set asynchronous I/O timeout

nng_http_res_add_header(3http)

add HTTP response header

nng_aio_stop.3(3)

stop asynchronous I/O operation

nng_http_res_alloc(3http)

allocate HTTP response structure

nng_aio_wait.3(3)

wait for asynchronous I/O operation

nng_http_res_alloc_error(3http)

allocate HTTP error response

nng_alloc.3(3)

allocate memory

nng_http_res_copy_data(3http)

copy HTTP response body

nng_bus_open.3(3)

create bus socket

nng_http_res_del_header(3http)

set HTTP response header

nng_close.3(3)

close socket

nng_http_res_free(3http)

free HTTP response structure

nng_ctx_close.3(3)

close context

nng_http_res_get_data(3http)

get HTTP response body

nng_ctx_get.3(3)

get context option

nng_http_res_get_header(3http)

return HTTP response header

nng_ctx_getopt.3(3)

get context option

nng_http_res_get_reason(3http)

return HTTP response reason

nng_ctx_id.3(3)

return numeric context identifier

nng_http_res_get_status(3http)

return HTTP status code

nng_ctx_open.3(3)

create context

nng_http_res_get_version(3http)

return HTTP response protocol version

nng_ctx_recv.3(3)

receive message using context asynchronously

nng_http_res_reset(3http)

reset HTTP response structure

nng_ctx_send.3(3)

send message using context asynchronously

nng_http_res_set_data(3http)

set HTTP response body

nng_ctx_set.3(3)

set context option

nng_http_res_set_header(3http)

set HTTP response header

nng_ctx_setopt.3(3)

set context option

nng_http_res_set_reason(3http)

set HTTP response reason

nng_device.3(3)

message forwarding device

nng_http_res_set_status(3http)

set HTTP response status

nng_dial.3(3)

create and start dialer

nng_http_res_set_version(3http)

set HTTP response protocol version

nng_dialer_close.3(3)

close dialer

nng_http_server_add_handler(3http)

add HTTP server handler

nng_dialer_create.3(3)

create dialer

nng_http_server_del_handler(3http)

delete HTTP server handler

nng_dialer_get.3(3)

get dialer option

nng_http_server_get_tls(3http)

get HTTP server TLS configuration

nng_dialer_getopt.3(3)

get dialer option

nng_http_server_hold(3http)

get and hold HTTP server instance

nng_dialer_id.3(3)

return numeric dialer identifier

nng_http_server_release(3http)

release HTTP server instance

nng_dialer_set.3(3)

set dialer option

nng_http_server_res_error(3http)

use HTTP server error page

nng_dialer_setopt.3(3)

set dialer option

nng_http_server_set_error_file(3http)

set custom HTTP error file

nng_dialer_start.3(3)

start dialer

nng_http_server_set_error_page(3http)

set custom HTTP error page

nng_free.3(3)

free memory

nng_http_server_set_tls(3http)

set HTTP server TLS configuration

nng_getopt.3(3)

get socket option

nng_http_server_start(3http)

start HTTP server

nng_inproc_register.3(3)

register inproc transport

nng_http_server_stop(3http)

stop HTTP server

nng_ipc_register.3(3)

register ipc transport
-
-
-
-

Section 3ipc: Supplemental TCP Functions

-
-
-

This section documents supplemental TCP functions that are available.

-
-
-

These functions are made available to facilitate using raw TCP connections -with the NNG asynchronous I/O API. -Most applications should never need to use these functions.

-
- ---- - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - -

nng_ipc_close(3ipc)

close IPC connection

nng_listen.3(3)

create and start listener

nng_ipc_dialer_alloc(3ipc)

allocate IPC dialer

nng_listener_close.3(3)

close listener

nng_ipc_dialer_close(3ipc)

close IPC dialer

nng_listener_create.3(3)

create listener

nng_ipc_dialer_dial(3ipc)

initiate outgoing IPC connection

nng_listener_get.3(3)

get listener option

nng_ipc_dialer_free(3ipc)

free IPC dialer

nng_listener_getopt.3(3)

get listener option

nng_ipc_dialer_getopt(3ipc)

get option from IPC dialer

nng_listener_id.3(3)

return numeric listener identifier

nng_ipc_dialer_setopt(3ipc)

set option on IPC dialer

nng_listener_set.3(3)

set listener option

nng_ipc_free(3ipc)

free IPC connection

nng_listener_setopt.3(3)

set listener option

nng_ipc_getopt(3ipc)

get option from IPC connection

nng_listener_start.3(3)

start listener

nng_ipc_listener_accept(3ipc)

accept incoming IPC connection

nng_msg_alloc.3(3)

allocate a message

nng_ipc_listener_alloc(3ipc)

allocate IPC listener

nng_msg_append.3(3)

append to message body

nng_ipc_listener_close(3ipc)

close IPC listener

nng_msg_body.3(3)

return message body

nng_ipc_listener_free(3ipc)

free IPC listener

nng_msg_chop.3(3)

remove data from end of message body

nng_ipc_listener_getopt(3ipc)

get option from IPC listener

nng_msg_clear.3(3)

clear message body content

nng_ipc_listener_listen(3ipc)

bind IPC listener

nng_msg_dup.3(3)

duplicate a message

nng_ipc_listener_setopt(3ipc)

set option on IPC listener

nng_msg_free.3(3)

free a message

nng_ipc_recv(3ipc)

receive from IPC connection

nng_msg_get_pipe.3(3)

get pipe for message

nng_ipc_send(3ipc)

send to IPC connection

nng_msg_header.3(3)

return message header

nng_ipc_setopt(3ipc)

set option on IPC connection

nng_msg_header_append.3(3)

append to message header
-
-
-
-

Section 3supp: Supplemental Functions

-
-
-

This section documents supplemental functions that are available. -These functions are not intrinsic to building Scalability Protocols -applications with this library.

-
-
-

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

-
- ---- - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - - -

nng_clock(3supp)

get time

nng_msg_header_chop.3(3)

remove data from end of message header

nng_cv_alloc(3supp)

allocate condition variable

nng_msg_header_clear.3(3)

clear message header

nng_cv_free(3supp)

free condition variable

nng_msg_header_insert.3(3)

prepend to message header

nng_cv_until(3supp)

wait for condition or timeout

nng_msg_header_len.3(3)

return message header length

nng_cv_wait(3supp)

wait for condition

nng_msg_header_trim.3(3)

remove data from start of message header

nng_cv_wake(3supp)

wake all waiters

nng_msg_insert.3(3)

prepend to message body

nng_cv_wake1(3supp)

wake one waiter

nng_msg_len.3(3)

return message body length

nng_msleep(3supp)

sleep milliseconds

nng_msg_realloc.3(3)

reallocate a message

nng_mtx_alloc(3supp)

allocate mutex

nng_msg_set_pipe.3(3)

set pipe for message

nng_mtx_free(3supp)

free mutex

nng_msg_trim.3(3)

remove data from start of message body

nng_mtx_lock(3supp)

lock mutex

nng_pair_open.3(3)

create pair socket

nng_mtx_unlock(3supp)

lock mutex

nng_pipe_close.3(3)

close pipe

nng_opts_parse(3supp)

parse command line options

nng_pipe_dialer.3(3)

return dialer that created pipe

nng_random(3supp)

get random number

nng_pipe_get.3(3)

get pipe option

nng_thread_create(3supp)

create thread

nng_pipe_getopt.3(3)

get pipe option

nng_thread_destroy(3supp)

reap thread

-
-
-
-

Section 3tcp: Supplemental TCP Functions

-
-
-

This section documents supplemental TCP functions that are available.

-
-
-

These functions are made available to facilitate using raw TCP connections -with the NNG asynchronous I/O API. -Most applications should never need to use these functions.

-
- ---- - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - -

nng_pipe_id.3(3)

return numeric pipe identifier

nng_tcp_close(3tcp)

close TCP connection

nng_pipe_listener.3(3)

return listener that created pipe

nng_tcp_dialer_alloc(3tcp)

allocate TCP dialer

nng_pipe_notify.3(3)

register pipe notification callback

nng_tcp_dialer_close(3tcp)

close TCP dialer

nng_pipe_socket.3(3)

return owning socket for pipe

nng_tcp_dialer_dial(3tcp)

initiate outgoing TCP connection

nng_pub_open.3(3)

create pub socket

nng_tcp_dialer_free(3tcp)

free TCP dialer

nng_pull_open.3(3)

create pull socket

nng_tcp_dialer_getopt(3tcp)

get option from TCP dialer

nng_push_open.3(3)

create push socket

nng_tcp_dialer_setopt(3tcp)

set option on TCP dialer

nng_recv.3(3)

recv data

nng_tcp_free(3tcp)

free TCP connection

nng_recv_aio.3(3)

receive message asynchronously

nng_tcp_getopt(3tcp)

get option from TCP connection

nng_recvmsg.3(3)

recv message

nng_tcp_listener_accept(3tcp)

accept incoming TCP connection

nng_rep_open.3(3)

create rep socket

nng_tcp_listener_alloc(3tcp)

allocate TCP listener

nng_req_open.3(3)

create req socket

nng_tcp_listener_close(3tcp)

close TCP listener

nng_respondent_open.3(3)

create respondent socket

nng_tcp_listener_free(3tcp)

free TCP listener

nng_send.3(3)

send data

nng_tcp_listener_getopt(3tcp)

get option from TCP listener

nng_send_aio.3(3)

send message asynchronously

nng_tcp_listener_listen(3tcp)

bind listener to TCP port

nng_sendmsg.3(3)

send message

nng_tcp_listener_setopt(3tcp)

set option on TCP listener

nng_setopt.3(3)

set socket option

nng_tcp_recv(3tcp)

receive from TCP connection

nng_sleep_aio.3(3)

sleep asynchronously

nng_tcp_send(3tcp)

send to TCP connection

nng_socket_get.3(3)

get socket option

nng_tcp_setopt(3tcp)

set option on TCP connection

nng_socket_id.3(3)

return numeric socket identifier
-
-
-
-

Section 3tls: Supplemental TLS Functions

-
-
-

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

-
-
-

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

-
-
-

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

-
- ---- - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

nng_tls_close(3tls)

close TLS connection

nng_socket_set.3(3)

set socket option

nng_tls_config_alloc(3tls)

allocate TLS configuration object

nng_stat_child.3(3)

get child statistic

nng_tls_config_auth_mode(3tls)

configure authentication mode

nng_stat_desc.3(3)

get statistic description

nng_tls_config_ca_chain(3tls)

configure certificate authority certificate chain

nng_stat_find.3(3)

find statistic by name

nng_tls_config_ca_file(3tls)

load certificate authority from file

nng_stat_find_dialer.3(3)

find dialer statistics

nng_tls_config_cert_key_file(3tls)

load own certificate and key from file

nng_stat_find_listener.3(3)

find listener statistics

nng_tls_config_free(3tls)

deallocate a TLS configuration object

nng_stat_find_socket.3(3)

find socket statistics

nng_tls_config_hold(3tls)

hold TLS configuration object

nng_stat_name.3(3)

get statistic name

nng_tls_config_own_cert(3tls)

configure own certificate and key

nng_stat_next.3(3)

get next statistic

nng_tls_config_server_name(3tls)

configure remote server name

nng_stat_string.3(3)

get statistic string value

nng_tls_dialer_alloc(3tls)

allocate TLS dialer

nng_stat_timestamp.3(3)

get statistic timestamp

nng_stat_type.3(3)

get statistic type

nng_stat_unit.3(3)

get statistic unit

nng_tls_dialer_close(3tls)

close TLS dialer

nng_stat_value.3(3)

get statistic value

nng_tls_dialer_dial(3tls)

initiate outgoing TLS connection

nng_stats_free.3(3)

free statistics snapshot

nng_tls_dialer_free(3tls)

free TLS dialer

nng_stats_get.3(3)

get statistics snapshot

nng_tls_dialer_getopt(3tls)

get option from TLS dialer

nng_strdup.3(3)

duplicate string

nng_tls_dialer_setopt(3tls)

set option on TLS dialer

nng_strerror.3(3)

return an error description

nng_tls_free(3tls)

free TLS connection

nng_strfree.3(3)

free memory

nng_tls_getopt(3tls)

get option from TLS connection

nng_sub_open.3(3)

create sub socket

nng_tls_listener_accept(3tls)

accept incoming TLS connection

nng_surveyor_open.3(3)

create surveyor socket

nng_tls_listener_alloc(3tls)

allocate TLS listener

nng_tcp_register.3(3)

register tcp transport

nng_tls_listener_close(3tls)

close TLS listener

nng_tls_register.3(3)

register tls transport

nng_tls_listener_free(3tls)

free TLS listener

nng_url_clone.3(3)

clone URL structure

nng_tls_listener_getopt(3tls)

get option from TLS listener

nng_url_free.3(3)

free a URL structure

nng_tls_listener_listen(3tls)

bind listener to TLS port

nng_url_parse.3(3)

create URL structure from a string

nng_tls_listener_setopt(3tls)

set option on TLS listener

nng_version.3(3)

report library version

nng_tls_recv(3tls)

receive from TLS connection

nng_ws_register.3(3)

register WebSocket transport

nng_tls_send(3tls)

send to TLS connection

nng_wss_register.3(3)

register WebSocket secure transport

nng_tls_setopt(3tls)

set option on TLS connection

nng_zt_register.3(3)

register ZeroTier transport
@@ -1844,123 +1068,107 @@ applications need will use.

-

nng_aio(5)

+

nng_aio.5(5)

asynchronous I/O handle

-

nng_ctx(5)

+

nng_ctx.5(5)

protocol context

-

nng_dialer(5)

+

nng_dialer.5(5)

dialer

-

nng_duration(5)

+

nng_duration.5(5)

relative time in milliseconds

-

nng_iov(5)

+

nng_iov.5(5)

scatter/gather element

-

nng_ipc(5)

-

IPC connection

- - -

nng_ipc_dialer(5)

-

IPC dialer

- - -

nng_ipc_listener(5)

-

IPC listener

- - -

nng_ipc_options(5)

+

nng_ipc_options.5(5)

IPC-specific options

-

nng_listener(5)

+

nng_listener.5(5)

listener

-

nng_msg(5)

+

nng_msg.5(5)

message

-

nng_options(5)

+

nng_options.5(5)

socket, dialer, listener, and pipe options

-

nng_pipe(5)

+

nng_pipe.5(5)

communications pipe

-

nng_sockaddr(5)

+

nng_sockaddr.5(5)

socket address

-

nng_sockaddr_in(5)

+

nng_sockaddr_in.5(5)

IPv4 socket address

-

nng_sockaddr_in6(5)

+

nng_sockaddr_in6.5(5)

IPv6 socket address

-

nng_sockaddr_inproc(5)

+

nng_sockaddr_inproc.5(5)

inproc socket address

-

nng_sockaddr_ipc(5)

+

nng_sockaddr_ipc.5(5)

IPC socket address

-

nng_sockaddr_zt(5)

+

nng_sockaddr_zt.5(5)

ZeroTier socket address

-

nng_socket(5)

+

nng_socket.5(5)

socket handle

-

nng_stat(5)

+

nng_stat.5(5)

statistic

-

nng_tcp(5)

-

TCP connection

+

nng_stream.5(5)

+

byte stream

+ + +

nng_stream_dialer.5(5)

+

byte stream dialer

-

nng_tcp_dialer(5)

-

TCP dialer

+

nng_stream_listener.5(5)

+

byte stream listener

-

nng_tcp_listener(5)

-

TCP listener

+

nng_tcp.5(5)

+

TCP connection

-

nng_tcp_options(5)

+

nng_tcp_options.5(5)

TTCP-specific options

-

nng_tls(5)

+

nng_tls.5(5)

TLS over TCP connection

-

nng_tls_config(5)

+

nng_tls_config.5(5)

message

-

nng_tls_dialer(5)

-

TLS dialer

- - -

nng_tls_listener(5)

-

TLS listener

- - -

nng_tls_options(5)

+

nng_tls_options.5(5)

TLS-specific options

@@ -1978,14 +1186,14 @@ available in the distribution.

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

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

@@ -1995,77 +1203,303 @@ time.

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +

nng(7)

nng.7(7)

nanomsg next generation

nng_bus(7)

nng_bus.7(7)

bus protocol

nng_inproc(7)

nng_inproc.7(7)

intra-process transport

nng_ipc(7)

nng_ipc.7(7)

IPC transport

nng_pair(7)

nng_pair.7(7)

pair protocol

nng_pub(7)

nng_pub.7(7)

publisher protocol

nng_pull(7)

nng_pull.7(7)

pull protocol

nng_push(7)

nng_push.7(7)

push protocol

nng_rep(7)

nng_rep.7(7)

reply protocol

nng_req(7)

nng_req.7(7)

request protocol

nng_respondent(7)

nng_respondent.7(7)

respondent protocol

nng_sub(7)

nng_sub.7(7)

subscriber protocol

nng_surveyor(7)

nng_surveyor.7(7)

surveyor protocol

nng_tcp(7)

nng_tcp.7(7)

TCP/IP transport

nng_tls(7)

nng_tls.7(7)

TLS transport

nng_ws(7)

nng_ws.7(7)

WebSocket transport

nng_zerotier(7)

nng_zerotier.7(7)

ZeroTier transport
+
+

Section 3str: Supplemental TCP Functions

+
+
+

This section documents supplemental byte stream functions that +are available.

+
+
+

These functions are made available to facilitate using raw byte stream +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.

+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_stream_close.3str(3str)

close byte stream

nng_stream_dialer_alloc.3str(3str)

allocate byte stream dialer

nng_stream_dialer_close.3str(3str)

close byte stream dialer

nng_stream_dialer_dial.3str(3str)

initiate outgoing byte stream connection

nng_stream_dialer_free.3str(3str)

free byte stream dialer

nng_stream_dialer_get.3str(3str)

get option from byte stream dialer

nng_stream_dialer_set.3str(3str)

set option on byte stream dialer

nng_stream_free.3str(3str)

free byte stream

nng_stream_get.3str(3str)

get option from byte stream

nng_stream_listener_accept.3str(3str)

accept incoming byte stream connection

nng_stream_listener_alloc.3str(3str)

allocate byte stream listener

nng_stream_listener_close.3str(3str)

close byte stream listener

nng_stream_listener_free.3str(3str)

free byte stream listener

nng_stream_listener_get.3str(3str)

get option from byte stream listener

nng_stream_listener_listen.3str(3str)

bind listener to configured address

nng_stream_listener_set.3str(3str)

set option on byte stream listener

nng_stream_recv.3str(3str)

receive from byte stream

nng_stream_send.3str(3str)

send to byte stream

nng_stream_set.3str(3str)

set option on byte stream

+
+
+
+

Section 3compat: Compatible Library Functions

+
+
+

This section documents the nanomsg 1.0 libary compatible functions.

+
+
+

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

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

nn_allocmsg.3compat(3compat)

allocate message (compatible API)

nn_bind.3compat(3compat)

accept connections from remote peers (compatible API)

nn_close.3compat(3compat)

close socket (compatible API)

nn_cmsg.3compat(3compat)

message control data (compatible API)

nn_connect.3compat(3compat)

connect to remote peer (compatible API)

nn_device.3compat(3compat)

create forwarding device (compatible API)

nn_errno.3compat(3compat)

return most recent error (compatible API)

nn_freemsg.3compat(3compat)

free message (compatible API)

nn_get_statistic.3compat(3compat)

get statistic (stub)

nn_getsockopt.3compat(3compat)

get socket option (compatible API)

nn_poll.3compat(3compat)

poll sockets (compatible API)

nn_reallocmsg.3compat(3compat)

reallocate message (compatible API)

nn_recv.3compat(3compat)

receive data (compatible API)

nn_recvmsg.3compat(3compat)

receive message (compatible API)

nn_send.3compat(3compat)

send data (compatible API)

nn_sendmsg.3compat(3compat)

send message (compatible API)

nn_setsockopt.3compat(3compat)

set socket option (compatible API)

nn_shutdown.3compat(3compat)

shut down endpoint (compatible API)

nn_socket.3compat(3compat)

create socket (compatible API)

nn_strerror.3compat(3compat)

return message for error (compatible API)

nn_term.3compat(3compat)

terminate library (compatible API)

nng_compat.3compat(3compat)

compatibility with nanomsg 1.0

+
+
- + \ No newline at end of file diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index caa480fd..4a09b884 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + libnng(3) - + - @@ -622,15 +126,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/tip/nn_bind.3compat.html b/man/tip/nn_bind.3compat.html index 9c00734d..1b2dcc8c 100644 --- a/man/tip/nn_bind.3compat.html +++ b/man/tip/nn_bind.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_bind(3compat) - + -
@@ -556,8 +60,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. @@ -586,7 +90,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.) @@ -646,15 +150,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/tip/nn_close.3compat.html b/man/tip/nn_close.3compat.html index a6849566..cd836e0b 100644 --- a/man/tip/nn_close.3compat.html +++ b/man/tip/nn_close.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_close(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_cmsg.3compat.html b/man/tip/nn_cmsg.3compat.html index 4cc35790..b09edda6 100644 --- a/man/tip/nn_cmsg.3compat.html +++ b/man/tip/nn_cmsg.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_cmsg(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_device.3compat.html b/man/tip/nn_device.3compat.html index ba979684..00d2f248 100644 --- a/man/tip/nn_device.3compat.html +++ b/man/tip/nn_device.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_device(3compat) - + -
-

The two sockets must be compatible, and must be raw mode +

The two sockets must be compatible, and must be +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.

@@ -613,13 +118,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/tip/nn_errno.3compat.html b/man/tip/nn_errno.3compat.html index 8105076a..3d1a4777 100644 --- a/man/tip/nn_errno.3compat.html +++ b/man/tip/nn_errno.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_errno(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_freemsg.3compat.html b/man/tip/nn_freemsg.3compat.html index c9445617..4a2ffbbe 100644 --- a/man/tip/nn_freemsg.3compat.html +++ b/man/tip/nn_freemsg.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_freemsg(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_getsockopt.3compat.html b/man/tip/nn_getsockopt.3compat.html index 45b0055b..ec7ae2cb 100644 --- a/man/tip/nn_getsockopt.3compat.html +++ b/man/tip/nn_getsockopt.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_getsockopt(3compat) - + - @@ -966,15 +470,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/tip/nn_poll.3compat.html b/man/tip/nn_poll.3compat.html index 2d900dee..5b2ccb0f 100644 --- a/man/tip/nn_poll.3compat.html +++ b/man/tip/nn_poll.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_poll(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_reallocmsg.3compat.html b/man/tip/nn_reallocmsg.3compat.html index 0e812c58..e5b14460 100644 --- a/man/tip/nn_reallocmsg.3compat.html +++ b/man/tip/nn_reallocmsg.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_reallocmsg(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_recv.3compat.html b/man/tip/nn_recv.3compat.html index 90ed7f8e..c8632514 100644 --- a/man/tip/nn_recv.3compat.html +++ b/man/tip/nn_recv.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_recv(3compat) - + -

The flags field may contain the special flag NN_DONTWAIT. @@ -643,15 +147,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/tip/nn_recvmsg.3compat.html b/man/tip/nn_recvmsg.3compat.html index 5148a8f7..6e9861b7 100644 --- a/man/tip/nn_recvmsg.3compat.html +++ b/man/tip/nn_recvmsg.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_recvmsg(3compat) - + -

The values of msg_control and msg_controllen describe a buffer of ancillary data associated with the message. This is currently only useful to obtain the message headers -used with raw mode sockets. +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).

@@ -676,16 +180,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/tip/nn_send.3compat.html b/man/tip/nn_send.3compat.html index b0bd2739..835d382c 100644 --- a/man/tip/nn_send.3compat.html +++ b/man/tip/nn_send.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_send(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_sendmsg.3compat.html b/man/tip/nn_sendmsg.3compat.html index 42245e66..3bd0b02c 100644 --- a/man/tip/nn_sendmsg.3compat.html +++ b/man/tip/nn_sendmsg.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_sendmsg(3compat) - + -

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, @@ -605,10 +109,10 @@ at its choice.)

The values of msg_control and msg_controllen describe a buffer of ancillary data to send the message. This is currently only useful to provide the message headers -used with raw mode sockets. +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).

@@ -694,16 +198,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/tip/nn_setsockopt.3compat.html b/man/tip/nn_setsockopt.3compat.html index f8f0ff54..19c46b57 100644 --- a/man/tip/nn_setsockopt.3compat.html +++ b/man/tip/nn_setsockopt.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - +nn_setsockopt(3compat) - + -
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.
@@ -741,7 +245,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.

@@ -923,15 +427,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/tip/nn_shutdown.3compat.html b/man/tip/nn_shutdown.3compat.html index d2f3ac12..9c427c10 100644 --- a/man/tip/nn_shutdown.3compat.html +++ b/man/tip/nn_shutdown.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_shutdown(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_socket.3compat.html b/man/tip/nn_socket.3compat.html index 8bf61f9a..d2b07721 100644 --- a/man/tip/nn_socket.3compat.html +++ b/man/tip/nn_socket.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_socket(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_strerror.3compat.html b/man/tip/nn_strerror.3compat.html index 487f9388..a1764c68 100644 --- a/man/tip/nn_strerror.3compat.html +++ b/man/tip/nn_strerror.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_errno(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nn_term.3compat.html b/man/tip/nn_term.3compat.html index 4877c261..c13766df 100644 --- a/man/tip/nn_term.3compat.html +++ b/man/tip/nn_term.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nn_term(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nng.7.html b/man/tip/nng.7.html index 5a1e763e..25b4df80 100644 --- a/man/tip/nng.7.html +++ b/man/tip/nng.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_count.3.html b/man/tip/nng_aio_count.3.html index 3f9a27e7..b0a345f6 100644 --- a/man/tip/nng_aio_count.3.html +++ b/man/tip/nng_aio_count.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_count(3) - + -

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

@@ -565,7 +69,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().
@@ -592,16 +96,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/tip/nng_aio_defer.3.html b/man/tip/nng_aio_defer.3.html index 3a16752d..8b717602 100644 --- a/man/tip/nng_aio_defer.3.html +++ b/man/tip/nng_aio_defer.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_defer(3) - + -

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.

@@ -571,7 +75,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. @@ -641,15 +145,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/tip/nng_aio_finish.3.html b/man/tip/nng_aio_finish.3.html index 15ae90ce..43e7a1aa 100644 --- a/man/tip/nng_aio_finish.3.html +++ b/man/tip/nng_aio_finish.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_finish(3) - + -

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

@@ -600,16 +104,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/tip/nng_aio_free.3.html b/man/tip/nng_aio_free.3.html index d1061cdc..ced0d11b 100644 --- a/man/tip/nng_aio_free.3.html +++ b/man/tip/nng_aio_free.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_free(3) - + - @@ -569,13 +73,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/tip/nng_aio_get_input.3.html b/man/tip/nng_aio_get_input.3.html index b823ad14..dec0fbf2 100644 --- a/man/tip/nng_aio_get_input.3.html +++ b/man/tip/nng_aio_get_input.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_get_input(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_get_msg.3.html b/man/tip/nng_aio_get_msg.3.html index e3b2b4ca..96137392 100644 --- a/man/tip/nng_aio_get_msg.3.html +++ b/man/tip/nng_aio_get_msg.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_get_msg(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_get_output.3.html b/man/tip/nng_aio_get_output.3.html index 9e570018..c4c82487 100644 --- a/man/tip/nng_aio_get_output.3.html +++ b/man/tip/nng_aio_get_output.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_get_output(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_result.3.html b/man/tip/nng_aio_result.3.html index 15768bc9..285666f1 100644 --- a/man/tip/nng_aio_result.3.html +++ b/man/tip/nng_aio_result.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_result(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_set_input.3.html b/man/tip/nng_aio_set_input.3.html index 561c3d76..5744f79d 100644 --- a/man/tip/nng_aio_set_input.3.html +++ b/man/tip/nng_aio_set_input.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_set_input(3) - + -

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

+the nng_aio_get_input() function.

@@ -606,15 +110,16 @@ the nng_aio_get_input() function.

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/tip/nng_aio_set_iov.3.html b/man/tip/nng_aio_set_iov.3.html index fe7c510c..f7f91901 100644 --- a/man/tip/nng_aio_set_iov.3.html +++ b/man/tip/nng_aio_set_iov.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_set_iov(3) - + - @@ -592,14 +97,6 @@ generally result in NNG_EINVAL.

- - - - @@ -606,15 +110,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/tip/nng_aio_wait.3.html b/man/tip/nng_aio_wait.3.html index 4a6f8382..f37c393e 100644 --- a/man/tip/nng_aio_wait.3.html +++ b/man/tip/nng_aio_wait.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - +nng_aio_wait(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_alloc.3.html b/man/tip/nng_alloc.3.html index 55829996..084e7dac 100644 --- a/man/tip/nng_alloc.3.html +++ b/man/tip/nng_alloc.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - +nng_alloc(3) - + -

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

-NNG_ENOMEM - -

Insufficient free memory to perform operation.

-
NNG_EINVAL @@ -614,16 +111,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/tip/nng_aio_set_msg.3.html b/man/tip/nng_aio_set_msg.3.html index 563c744a..145a77bd 100644 --- a/man/tip/nng_aio_set_msg.3.html +++ b/man/tip/nng_aio_set_msg.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_set_msg(3) - + - @@ -593,15 +97,16 @@ the nng_aio_get_output() functio

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/tip/nng_aio_set_timeout.3.html b/man/tip/nng_aio_set_timeout.3.html index 0c529086..6c6fb0ca 100644 --- a/man/tip/nng_aio_set_timeout.3.html +++ b/man/tip/nng_aio_set_timeout.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_set_timeout(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_aio_stop.3.html b/man/tip/nng_aio_stop.3.html index 2360c4a0..1ac96dc3 100644 --- a/man/tip/nng_aio_stop.3.html +++ b/man/tip/nng_aio_stop.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_aio_stop(3) - + - 		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.
@@ -589,13 +93,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/tip/nng_bus.7.html b/man/tip/nng_bus.7.html index 9f71c10f..08d26301 100644 --- a/man/tip/nng_bus.7.html +++ b/man/tip/nng_bus.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - +nng_bus(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_clock.3supp.html b/man/tip/nng_clock.3supp.html index 9b782539..e72b6336 100644 --- a/man/tip/nng_clock.3supp.html +++ b/man/tip/nng_clock.3supp.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - +nng_clock(3supp) - + -
This function is intended mostly to help with setting appropriate -timeouts using nng_cv_until(3supp). +timeouts using nng_cv_until().
@@ -599,15 +103,16 @@ timeouts using nng_cv_until(3supp).

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/tip/nng_close.3.html b/man/tip/nng_close.3.html index 19177ac3..6274d373 100644 --- a/man/tip/nng_close.3.html +++ b/man/tip/nng_close.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_close(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_compat.3compat.html b/man/tip/nng_compat.3compat.html index ba6aad8f..ec9b216e 100644 --- a/man/tip/nng_compat.3compat.html +++ b/man/tip/nng_compat.3compat.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_compat(3compat) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_conn_write_req.3http.html b/man/tip/nng_http_conn_write_req.3http.html index 861748ea..abae0b9e 100644 --- a/man/tip/nng_http_conn_write_req.3http.html +++ b/man/tip/nng_http_conn_write_req.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_conn_write_req(3http) - + -

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.

@@ -565,8 +69,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. @@ -644,17 +148,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/tip/nng_http_conn_write_res.3http.html b/man/tip/nng_http_conn_write_res.3http.html index 77667dd6..746635a1 100644 --- a/man/tip/nng_http_conn_write_res.3http.html +++ b/man/tip/nng_http_conn_write_res.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_conn_write_res(3http) - + -

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.

@@ -580,8 +84,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. @@ -660,17 +164,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/tip/nng_http_handler_alloc.3http.html b/man/tip/nng_http_handler_alloc.3http.html index 8ea33436..1e436b35 100644 --- a/man/tip/nng_http_handler_alloc.3http.html +++ b/man/tip/nng_http_handler_alloc.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_handler_alloc(3http) - + - +

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/tip/nng_http_req_copy_data.3http.html b/man/tip/nng_http_req_copy_data.3http.html index b91e573c..e2db57a7 100644 --- a/man/tip/nng_http_req_copy_data.3http.html +++ b/man/tip/nng_http_req_copy_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_copy_data(3http) - + -

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.

@@ -574,7 +78,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. @@ -630,14 +134,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/tip/nng_http_req_del_header.3http.html b/man/tip/nng_http_req_del_header.3http.html index 67814a86..10893e0c 100644 --- a/man/tip/nng_http_req_del_header.3http.html +++ b/man/tip/nng_http_req_del_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_free.3http.html b/man/tip/nng_http_req_free.3http.html index 81d20e94..da247006 100644 --- a/man/tip/nng_http_req_free.3http.html +++ b/man/tip/nng_http_req_free.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_free(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_get_data.3http.html b/man/tip/nng_http_req_get_data.3http.html index 1eaaeefa..fac86c12 100644 --- a/man/tip/nng_http_req_get_data.3http.html +++ b/man/tip/nng_http_req_get_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_get_data(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_get_header.3http.html b/man/tip/nng_http_req_get_header.3http.html index c2ad7661..3569f62e 100644 --- a/man/tip/nng_http_req_get_header.3http.html +++ b/man/tip/nng_http_req_get_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_get_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_get_method.3http.html b/man/tip/nng_http_req_get_method.3http.html index df994d3b..bdc8a288 100644 --- a/man/tip/nng_http_req_get_method.3http.html +++ b/man/tip/nng_http_req_get_method.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_get_method(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_get_uri.3http.html b/man/tip/nng_http_req_get_uri.3http.html index 53aea468..3f3c0fcc 100644 --- a/man/tip/nng_http_req_get_uri.3http.html +++ b/man/tip/nng_http_req_get_uri.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_get_method(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_get_version.3http.html b/man/tip/nng_http_req_get_version.3http.html index e45cf97f..82c1cf04 100644 --- a/man/tip/nng_http_req_get_version.3http.html +++ b/man/tip/nng_http_req_get_version.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_get_version(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_reset.3http.html b/man/tip/nng_http_req_reset.3http.html index 2925711a..e806a870 100644 --- a/man/tip/nng_http_req_reset.3http.html +++ b/man/tip/nng_http_req_reset.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_reset(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_set_data.3http.html b/man/tip/nng_http_req_set_data.3http.html index 82064632..9f868329 100644 --- a/man/tip/nng_http_req_set_data.3http.html +++ b/man/tip/nng_http_req_set_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_data(3http) - + -

This also updates the relevant Content-Length header of req.

@@ -576,7 +80,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(). @@ -632,14 +136,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/tip/nng_http_req_set_header.3http.html b/man/tip/nng_http_req_set_header.3http.html index 207db0de..bfb57c17 100644 --- a/man/tip/nng_http_req_set_header.3http.html +++ b/man/tip/nng_http_req_set_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_set_method.3http.html b/man/tip/nng_http_req_set_method.3http.html index 70efd3b2..b512ffb5 100644 --- a/man/tip/nng_http_req_set_method.3http.html +++ b/man/tip/nng_http_req_set_method.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_method(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_set_uri.3http.html b/man/tip/nng_http_req_set_uri.3http.html index 85f10fa7..61f1ec5c 100644 --- a/man/tip/nng_http_req_set_uri.3http.html +++ b/man/tip/nng_http_req_set_uri.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_uri(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_req_set_version.3http.html b/man/tip/nng_http_req_set_version.3http.html index b9101933..e72d1e80 100644 --- a/man/tip/nng_http_req_set_version.3http.html +++ b/man/tip/nng_http_req_set_version.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_req_set_version(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_add_header.3http.html b/man/tip/nng_http_res_add_header.3http.html index 6b05f4d4..2c29749b 100644 --- a/man/tip/nng_http_res_add_header.3http.html +++ b/man/tip/nng_http_res_add_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_add_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_alloc.3http.html b/man/tip/nng_http_res_alloc.3http.html index 89448528..a6aa07df 100644 --- a/man/tip/nng_http_res_alloc.3http.html +++ b/man/tip/nng_http_res_alloc.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_alloc(3http) - + - - +

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/tip/nng_http_res_alloc_error.3http.html b/man/tip/nng_http_res_alloc_error.3http.html index 3d35998f..65e5100e 100644 --- a/man/tip/nng_http_res_alloc_error.3http.html +++ b/man/tip/nng_http_res_alloc_error.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_alloc_error(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_copy_data.3http.html b/man/tip/nng_http_res_copy_data.3http.html index 90509142..b0f7437e 100644 --- a/man/tip/nng_http_res_copy_data.3http.html +++ b/man/tip/nng_http_res_copy_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_copy_data(3http) - + -

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.

@@ -574,7 +78,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. @@ -630,14 +134,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/tip/nng_http_res_del_header.3http.html b/man/tip/nng_http_res_del_header.3http.html index 6999f6ac..5d3267cc 100644 --- a/man/tip/nng_http_res_del_header.3http.html +++ b/man/tip/nng_http_res_del_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_set_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_free.3http.html b/man/tip/nng_http_res_free.3http.html index 64c02b46..8edcecdb 100644 --- a/man/tip/nng_http_res_free.3http.html +++ b/man/tip/nng_http_res_free.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_free(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_get_data.3http.html b/man/tip/nng_http_res_get_data.3http.html index 8e399882..ce21c37b 100644 --- a/man/tip/nng_http_res_get_data.3http.html +++ b/man/tip/nng_http_res_get_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_get_data(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_get_header.3http.html b/man/tip/nng_http_res_get_header.3http.html index 77423b94..a5bf3a18 100644 --- a/man/tip/nng_http_res_get_header.3http.html +++ b/man/tip/nng_http_res_get_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_get_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_get_reason.3http.html b/man/tip/nng_http_res_get_reason.3http.html index bc955c1a..44c42d29 100644 --- a/man/tip/nng_http_res_get_reason.3http.html +++ b/man/tip/nng_http_res_get_reason.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_get_reason(3http) - + - @@ -570,13 +74,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/tip/nng_http_res_get_status.3http.html b/man/tip/nng_http_res_get_status.3http.html index 6e1f2518..dbea2466 100644 --- a/man/tip/nng_http_res_get_status.3http.html +++ b/man/tip/nng_http_res_get_status.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_get_status(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_get_version.3http.html b/man/tip/nng_http_res_get_version.3http.html index 216289f7..ac95fa5f 100644 --- a/man/tip/nng_http_res_get_version.3http.html +++ b/man/tip/nng_http_res_get_version.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_get_version(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_reset.3http.html b/man/tip/nng_http_res_reset.3http.html index f56bdb6b..c4e11475 100644 --- a/man/tip/nng_http_res_reset.3http.html +++ b/man/tip/nng_http_res_reset.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_reset(3http) - + - @@ -568,11 +72,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/tip/nng_http_res_set_data.3http.html b/man/tip/nng_http_res_set_data.3http.html index 53e94398..fd146f9f 100644 --- a/man/tip/nng_http_res_set_data.3http.html +++ b/man/tip/nng_http_res_set_data.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_set_data(3http) - + -

This also updates the relevant Content-Length header of res.

@@ -576,7 +80,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(). @@ -632,14 +136,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/tip/nng_http_res_set_header.3http.html b/man/tip/nng_http_res_set_header.3http.html index b394b92a..d77754ce 100644 --- a/man/tip/nng_http_res_set_header.3http.html +++ b/man/tip/nng_http_res_set_header.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_set_header(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_res_set_reason.3http.html b/man/tip/nng_http_res_set_reason.3http.html index df58fdf1..7fbf45be 100644 --- a/man/tip/nng_http_res_set_reason.3http.html +++ b/man/tip/nng_http_res_set_reason.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_res_set_reason(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_server_start.3http.html b/man/tip/nng_http_server_start.3http.html index aacd5fca..ca22ec32 100644 --- a/man/tip/nng_http_server_start.3http.html +++ b/man/tip/nng_http_server_start.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_server_start(3http) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_http_server_stop.3http.html b/man/tip/nng_http_server_stop.3http.html index b98264d7..b156d56e 100644 --- a/man/tip/nng_http_server_stop.3http.html +++ b/man/tip/nng_http_server_stop.3http.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_http_server_stop(3http) - + - @@ -601,12 +121,13 @@ the actual structure is of type

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/tip/nng_inproc_register.3.html b/man/tip/nng_inproc_register.3.html index 6b786671..6ae6ee8f 100644 --- a/man/tip/nng_inproc_register.3.html +++ b/man/tip/nng_inproc_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_inproc_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_iov.5.html b/man/tip/nng_iov.5.html index aca0d3ae..8fac37f0 100644 --- a/man/tip/nng_iov.5.html +++ b/man/tip/nng_iov.5.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_sockaddr_in(5) + +nng_iov(5) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_ipc.5.html b/man/tip/nng_ipc.5.html deleted file mode 100644 index 9e266930..00000000 --- a/man/tip/nng_ipc.5.html +++ /dev/null @@ -1,666 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-typedef struct nng_ipc_s nng_ipc;
-
-
-
-
-
-

DESCRIPTION

-
-
-

An nng_ipc represents a connected stream -using interprocess communication (IPC). -IPC stream objects can be used to send or receive data.

-
-
- - - - - -
- - -The nng_ipc object is used for raw IPC connections, and -should not be confused with a pipe object created using the -nng_ipc(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_ipc(7) transport instead. -
-
-
-

These objects are created either establishing an outgoing connection -with nng_ipc_dialer_dial() or by -accepting in incoming connection with -nng_ipc_listener_accept().

-
-
-

IPC 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_ipc_send() or -received with nng_ipc_recv().

-
-
-

When the connection is no longer needed, it should be freed with -nng_ipc_free().

-
-
- - - - - -
- - -It is possible to close the connection, without freeing it, by -using nng_ipc_close(). -
-
-
-

Options

-
-

The following options are applicable to IPC connections, and may be -accessed using the nng_ipc_getopt() and -nng_ipc_setopt() functions.

-
-
- -
-
-

Other platform specific options may be available as well.

-
-
-
-
-
-

SEE ALSO

-
-
-

libnng(3), -nng_ipc_close(3ipc), -nng_ipc_dialer_dial(3ipc), -nng_ipc_free(3ipc), -nng_ipc_getopt(3ipc), -nng_ipc_listener_accept(3ipc), -nng_ipc_recv(3ipc), -nng_ipc_send(3ipc), -nng_ipc_setopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng(7), -nng_ipc(7)

-
-
-
-
- - diff --git a/man/tip/nng_ipc.7.html b/man/tip/nng_ipc.7.html index 0db5cac3..ca69ee2f 100644 --- a/man/tip/nng_ipc.7.html +++ b/man/tip/nng_ipc.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_ipc(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_ipc_close.3ipc.html b/man/tip/nng_ipc_close.3ipc.html deleted file mode 100644 index df9e32f2..00000000 --- a/man/tip/nng_ipc_close.3ipc.html +++ /dev/null @@ -1,615 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_close(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_close(nng_ipc *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_close() function closes the supplied IPC connection, conn.

-
-
-

If any operations are pending (such as nng_ipc_send() -or nng_ipc_recv()) they will be terminated with -an NNG_ECLOSED error condition. -Also, any new operations will fail with NNG_ECLOSED after the connection -is closed.

-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -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_ipc_free(). -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_free(3ipc), -nng_ipc_recv(3ipc), -nng_ipc_send(3ipc), -nng_ipc(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer.5.html b/man/tip/nng_ipc_dialer.5.html deleted file mode 100644 index 40b5d0a1..00000000 --- a/man/tip/nng_ipc_dialer.5.html +++ /dev/null @@ -1,594 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-typedef struct nng_ipc_dialer_s nng_ipc_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_ipc_dialer is a handle to an IPC “dialer”, which is responsible for -creating connections (nng_ipc objects) by connecting to -remote systems.

-
-
- - - - - -
- - -The nng_ipc_dialer object is used for raw IPC connections, and -should not be confused with a dialer object created using the -nng_ipc(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_ipc(7) transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_dialer_alloc(3ipc), -nng_ipc_dialer_close(3ipc), -nng_ipc_dialer_dial(3ipc), -nng_ipc_dialer_free(3ipc), -nng_ipc(5), -nng_ipc_options(5), -nng_ipc_listener(5), -nng_ipc(7)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_alloc.3ipc.html b/man/tip/nng_ipc_dialer_alloc.3ipc.html deleted file mode 100644 index 2fe353e8..00000000 --- a/man/tip/nng_ipc_dialer_alloc.3ipc.html +++ /dev/null @@ -1,590 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_alloc(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_dialer_alloc(nng_ipc_dialer *dp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_alloc() allocates an IPC dialer, which can be used -to create outgoing connections over IPC, and stores a pointer to it -it in the location referenced by dp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_dialer_close(3ipc), -nng_ipc_dialer_dial(3ipc), -nng_ipc_dialer_free(3ipc), -nng_ipc_dialer(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_close.3ipc.html b/man/tip/nng_ipc_dialer_close.3ipc.html deleted file mode 100644 index 9371e37d..00000000 --- a/man/tip/nng_ipc_dialer_close.3ipc.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_close(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_dialer_close(nng_ipc_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_close() function closes the supplied IPC dialer d, -but does not free the underlying resources associated with it.

-
-
-

If any dial operations using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the dialer d will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the dialer, so the -application should still free the memory using -nng_ipc_dialer_free(3ipc) -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_dialer_alloc(3ipc), -nng_ipc_dialer_dial(3ipc), -nng_ipc_dialer_free(3ipc), -nng_ipc_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_dial.3ipc.html b/man/tip/nng_ipc_dialer_dial.3ipc.html deleted file mode 100644 index 75689523..00000000 --- a/man/tip/nng_ipc_dialer_dial.3ipc.html +++ /dev/null @@ -1,650 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_dial(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_dialer_dial(nng_ipc_dialer *d, const nng_sockaddr *sa, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_dial() attempts to establish an IPC connection to the -remote peer identified by sa, using the dialer d. -The operation is completed asynchronously, using aio.

-
-
-

The address sa must be in the NNG_AF_IPC family, -and have a valid path for IPC.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_ipc stored as its first output. -(See nng_aio_get_output().)

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_EADDRINVAL - -

The address specified is invalid.

-
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_ECONNREFUSED - -

The connection was refused by the server.

-
-NNG_ECONNRESET - -

The connection was reset by the server.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_EPERM - -

Insufficient permission to access the IPC path.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_dialer_alloc(3ipc), -nng_ipc_dialer_close(3ipc), -nng_ipc_dialer_free(3ipc), -nng_aio(5), -nng_sockaddr(5), -nng_ipc(5), -nng_ipc_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_free.3ipc.html b/man/tip/nng_ipc_dialer_free.3ipc.html deleted file mode 100644 index 6a91ee7d..00000000 --- a/man/tip/nng_ipc_dialer_free.3ipc.html +++ /dev/null @@ -1,598 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_free(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_dialer_free(nng_ipc_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_free() function closes the supplied IPC dialer d, -and frees the underlying resources associated with it.

-
-
-

If any dial operations - using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to d, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_dialer_alloc(3ipc), -nng_ipc_dialer_close(3ipc), -nng_ipc_dialer_dial(3ipc), -nng_ipc_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_getopt.3ipc.html b/man/tip/nng_ipc_dialer_getopt.3ipc.html deleted file mode 100644 index aa03da47..00000000 --- a/man/tip/nng_ipc_dialer_getopt.3ipc.html +++ /dev/null @@ -1,632 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_getopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_getopt(nng_ipc_dialer *d, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_getopt() is used to retrieve the value of the option name for the IPC dialer d. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

There are no predefined options for IPC dialers at this time.

-
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_dialer_setopt(3ipc), -nng_ipc_getopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5), -nng_ipc_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_dialer_setopt.3ipc.html b/man/tip/nng_ipc_dialer_setopt.3ipc.html deleted file mode 100644 index ddb45213..00000000 --- a/man/tip/nng_ipc_dialer_setopt.3ipc.html +++ /dev/null @@ -1,627 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_dialer_setopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_dialer_setopt(nng_ipc_dialer *d, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_dialer_setopt() is used to set the option name for the -IPC dialer d. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

There are no predefined options for IPC dialers at this time.

-
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_dialer_getopt(3ipc), -nng_ipc_setopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5), -nng_ipc_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_free.3ipc.html b/man/tip/nng_ipc_free.3ipc.html deleted file mode 100644 index 79345b20..00000000 --- a/man/tip/nng_ipc_free.3ipc.html +++ /dev/null @@ -1,613 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_free(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_free(nng_ipc *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_free() function closes the supplied IPC connection, conn, -and frees the underlying resources associated with it.

-
-
-

If any operations are pending (such as nng_ipc_send() -or nng_ipc_recv()) they will be terminated with -an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to conn, as the memory backing it will be reclaimed for other uses. -
-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -have completely transmitted. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_close(3ipc), -nng_ipc_recv(3ipc), -nng_ipc_send(3ipc), -nng_ipc(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_getopt.3ipc.html b/man/tip/nng_ipc_getopt.3ipc.html deleted file mode 100644 index 0fc84ecc..00000000 --- a/man/tip/nng_ipc_getopt.3ipc.html +++ /dev/null @@ -1,653 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_getopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_getopt(nng_ipc *conn, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_getopt() is used to retrieve the value of the option name for -the IPC connection conn. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from IPC connections are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_setopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener.5.html b/man/tip/nng_ipc_listener.5.html deleted file mode 100644 index 2f2100cf..00000000 --- a/man/tip/nng_ipc_listener.5.html +++ /dev/null @@ -1,595 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-typedef struct nng_ipc_dialer_s nng_ipc_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_ipc_listener is a handle to an IPC “listener”, which is responsible -for accepting connections (nng_ipc objects) from remote -systems.

-
-
- - - - - -
- - -The nng_ipc_listener object is used for raw IPC connections, and -should not be confused with a listener object created using the -nng_ipc(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_ipc(7) transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_listener_accept(3ipc), -nng_ipc_listener_alloc(3ipc), -nng_ipc_listener_close(3ipc), -nng_ipc_listener_free(3ipc), -nng_ipc_listener_listen(3ipc), -nng_ipc(5), -nng_ipc_dialer(5), -nng_ipc_options(5), -nng_ipc(7)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_accept.3ipc.html b/man/tip/nng_ipc_listener_accept.3ipc.html deleted file mode 100644 index 78150f51..00000000 --- a/man/tip/nng_ipc_listener_accept.3ipc.html +++ /dev/null @@ -1,634 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_accept(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_listener_accept(nng_ipc_listener *l, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_accept() attempts to accept an incoming IPC connection -from a remote peer, using the listener l. -The operation is completed asynchronously, using aio.

-
-
-

This operation can only be done after the listener is already bound to -an IPC path and is listening.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_ipc stored as its first output. -(See nng_aio_get_output().)

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_ECONNRESET - -

The connection was reset by the peer.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_ESTATE - -

The listener is not not listening.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_listener_alloc(3ipc), -nng_ipc_listener_close(3ipc), -nng_ipc_listener_free(3ipc), -nng_ipc_listener_listen(3ipc), -nng_aio(5), -nng_ipc(5), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_alloc.3ipc.html b/man/tip/nng_ipc_listener_alloc.3ipc.html deleted file mode 100644 index 73cc0e57..00000000 --- a/man/tip/nng_ipc_listener_alloc.3ipc.html +++ /dev/null @@ -1,591 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_alloc(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_listener_alloc(nng_ipc_listener *lp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_alloc() allocates an IPC listener, which can be used -to accept incoming connections over IPC, and stores a pointer to it -it in the location referenced by lp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_listener_accept(3ipc), -nng_ipc_listener_close(3ipc), -nng_ipc_listener_free(3ipc), -nng_ipc_listener_listen(3ipc), -nng_ipc_listener(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_close.3ipc.html b/man/tip/nng_ipc_listener_close.3ipc.html deleted file mode 100644 index fa795e64..00000000 --- a/man/tip/nng_ipc_listener_close.3ipc.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_close(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_listener_close(nng_ipc_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_close() function closes the supplied IPC listener l, -but does not free the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the listener l will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the listener, so the -application should still free the memory using -nng_ipc_listener_free() -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_listener_alloc(3ipc), -nng_ipc_listener_accept(3ipc), -nng_ipc_listener_free(3ipc), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_free.3ipc.html b/man/tip/nng_ipc_listener_free.3ipc.html deleted file mode 100644 index 7e84af9a..00000000 --- a/man/tip/nng_ipc_listener_free.3ipc.html +++ /dev/null @@ -1,596 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_free(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_listener_free(nng_ipc_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_free() function closes the supplied IPC listener l, -and frees the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to l, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_listener_alloc(3ipc), -nng_ipc_listener_close(3ipc), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_getopt.3ipc.html b/man/tip/nng_ipc_listener_getopt.3ipc.html deleted file mode 100644 index a645db6f..00000000 --- a/man/tip/nng_ipc_listener_getopt.3ipc.html +++ /dev/null @@ -1,639 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_getopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_listener_getopt(nng_ipc_listener *l, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_getopt() is used to retrieve the value of the option name for the IPC listener l. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The only option specifically suppported for retrieval from IPC listeners is:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_listener_setopt(3ipc), -nng_ipc_getopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_listen.3ipc.html b/man/tip/nng_ipc_listener_listen.3ipc.html deleted file mode 100644 index 180c570e..00000000 --- a/man/tip/nng_ipc_listener_listen.3ipc.html +++ /dev/null @@ -1,625 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_listen(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_listener_listen(nng_ipc_listener l, const nng_sockaddr *sa);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_listen() attempts to bind the listener l -to the local address specified by sa, which must be in the -NNG_AF_IPC address family and must have a valid IPC path.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - -
-NNG_EADDRINUSE - -

The address specified by sa is already in use.

-
-NNG_EADDRINVAL - -

The address specified by sa is invalid or unavailable.

-
-NNG_ECLOSED - -

The listener l has been closed.

-
-NNG_EPERM - -

Insufficient permission to create the specified IPC path.

-
-NNG_ESTATE - -

The listener l is already bound.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_ipc_listener_accept(3ipc), -nng_ipc_listener_alloc(3ipc), -nng_ipc_listener_close(3ipc), -nng_ipc_listener_free(3ipc), -nng_ipc_listener_getopt(3ipc), -nng_sockaddr(5), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_listener_setopt.3ipc.html b/man/tip/nng_ipc_listener_setopt.3ipc.html deleted file mode 100644 index fb91cb11..00000000 --- a/man/tip/nng_ipc_listener_setopt.3ipc.html +++ /dev/null @@ -1,649 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_listener_setopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_listener_setopt(nng_ipc_listener *l, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_listener_setopt() is used to set the option name for the -IPC listener l. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on IPC listeners are:

-
-
- -
-
- - - - - -
- - -Availability of the above options is platform-specific. -
-
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_listener_getopt(3ipc), -nng_ipc_setopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5), -nng_ipc_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_options.5.html b/man/tip/nng_ipc_options.5.html index cd4168de..86788f89 100644 --- a/man/tip/nng_ipc_options.5.html +++ b/man/tip/nng_ipc_options.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_ipc_options(5) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_ipc_recv.3ipc.html b/man/tip/nng_ipc_recv.3ipc.html deleted file mode 100644 index ab07281f..00000000 --- a/man/tip/nng_ipc_recv.3ipc.html +++ /dev/null @@ -1,660 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_recv(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_recv(nng_ipc *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_recv() function starts an asynchronous receive from the -IPC connection conn, into the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_ipc_close(3ipc), -nng_ipc_send(3ipc), -nng_ipc(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_register.3.html b/man/tip/nng_ipc_register.3.html index 9a95c2f0..268fb22f 100644 --- a/man/tip/nng_ipc_register.3.html +++ b/man/tip/nng_ipc_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_ipc_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_ipc_send.3ipc.html b/man/tip/nng_ipc_send.3ipc.html deleted file mode 100644 index 4bef078f..00000000 --- a/man/tip/nng_ipc_send.3ipc.html +++ /dev/null @@ -1,659 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_send(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_send(nng_ipc *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_send() function starts an asynchronous send over the -IPC connection conn from the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_ipc_close(3ipc), -nng_ipc_recv(3ipc), -nng_ipc(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_ipc_setopt.3ipc.html b/man/tip/nng_ipc_setopt.3ipc.html deleted file mode 100644 index c1e2508c..00000000 --- a/man/tip/nng_ipc_setopt.3ipc.html +++ /dev/null @@ -1,625 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_ipc_setopt(3ipc) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-int nng_ipc_setopt(nng_ipc *conn, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_ipc_setopt() is used to set the option name for the -IPC connection conn. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

There are no options defined for modification on IPC connections at this time.

-
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_ipc_getopt(3ipc), -nng_ipc_options(5), -nng_options(5), -nng_strerror(3), -nng_ipc(5)

-
-
-
-
- - diff --git a/man/tip/nng_listen.3.html b/man/tip/nng_listen.3.html index af26efdc..09c2e035 100644 --- a/man/tip/nng_listen.3.html +++ b/man/tip/nng_listen.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_listen(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_body.3.html b/man/tip/nng_msg_body.3.html index f5dfb904..5e5ed888 100644 --- a/man/tip/nng_msg_body.3.html +++ b/man/tip/nng_msg_body.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_body(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_chop.3.html b/man/tip/nng_msg_chop.3.html index 76a6ab21..7fc3bab4 100644 --- a/man/tip/nng_msg_chop.3.html +++ b/man/tip/nng_msg_chop.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_chop(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_clear.3.html b/man/tip/nng_msg_clear.3.html index 6c2d9295..712172f3 100644 --- a/man/tip/nng_msg_clear.3.html +++ b/man/tip/nng_msg_clear.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_clear(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_dup.3.html b/man/tip/nng_msg_dup.3.html index 3b6d1adc..be8b7e45 100644 --- a/man/tip/nng_msg_dup.3.html +++ b/man/tip/nng_msg_dup.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_dup(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_free.3.html b/man/tip/nng_msg_free.3.html index af8c06ec..9f646788 100644 --- a/man/tip/nng_msg_free.3.html +++ b/man/tip/nng_msg_free.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_free(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_get_pipe.3.html b/man/tip/nng_msg_get_pipe.3.html index 67b5260d..ed2a0aac 100644 --- a/man/tip/nng_msg_get_pipe.3.html +++ b/man/tip/nng_msg_get_pipe.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_get_pipe(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header.3.html b/man/tip/nng_msg_header.3.html index 862381a3..c733fe94 100644 --- a/man/tip/nng_msg_header.3.html +++ b/man/tip/nng_msg_header.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_append.3.html b/man/tip/nng_msg_header_append.3.html index 37ae6a05..db46f6c1 100644 --- a/man/tip/nng_msg_header_append.3.html +++ b/man/tip/nng_msg_header_append.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_append(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_chop.3.html b/man/tip/nng_msg_header_chop.3.html index 694d325e..f7a4523c 100644 --- a/man/tip/nng_msg_header_chop.3.html +++ b/man/tip/nng_msg_header_chop.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_chop(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_clear.3.html b/man/tip/nng_msg_header_clear.3.html index 2c9f94b8..0194d303 100644 --- a/man/tip/nng_msg_header_clear.3.html +++ b/man/tip/nng_msg_header_clear.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_clear(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_insert.3.html b/man/tip/nng_msg_header_insert.3.html index f06e2b5d..35f7495b 100644 --- a/man/tip/nng_msg_header_insert.3.html +++ b/man/tip/nng_msg_header_insert.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_insert(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_len.3.html b/man/tip/nng_msg_header_len.3.html index 70d35785..f34f486b 100644 --- a/man/tip/nng_msg_header_len.3.html +++ b/man/tip/nng_msg_header_len.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_len(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_header_trim.3.html b/man/tip/nng_msg_header_trim.3.html index b539570a..0e54cab1 100644 --- a/man/tip/nng_msg_header_trim.3.html +++ b/man/tip/nng_msg_header_trim.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_header_trim(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_insert.3.html b/man/tip/nng_msg_insert.3.html index b4f4803a..5555b345 100644 --- a/man/tip/nng_msg_insert.3.html +++ b/man/tip/nng_msg_insert.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_insert(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_len.3.html b/man/tip/nng_msg_len.3.html index 4b533e73..e2276c22 100644 --- a/man/tip/nng_msg_len.3.html +++ b/man/tip/nng_msg_len.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_len(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_realloc.3.html b/man/tip/nng_msg_realloc.3.html index ebd4b57c..61d0f2fa 100644 --- a/man/tip/nng_msg_realloc.3.html +++ b/man/tip/nng_msg_realloc.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_msg_realloc(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_msg_set_pipe.3.html b/man/tip/nng_msg_set_pipe.3.html index 279b7881..1150660d 100644 --- a/man/tip/nng_msg_set_pipe.3.html +++ b/man/tip/nng_msg_set_pipe.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_msg_get_pipe(3) + +nng_msg_set_pipe(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_pipe.5.html b/man/tip/nng_pipe.5.html index caf9d45c..23d54ffd 100644 --- a/man/tip/nng_pipe.5.html +++ b/man/tip/nng_pipe.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe(5) - + -
-

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.

@@ -613,20 +117,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/tip/nng_pipe_close.3.html b/man/tip/nng_pipe_close.3.html index d88f3469..dfa6a3de 100644 --- a/man/tip/nng_pipe_close.3.html +++ b/man/tip/nng_pipe_close.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_close(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_pipe_dialer.3.html b/man/tip/nng_pipe_dialer.3.html index 339a654a..60c2b370 100644 --- a/man/tip/nng_pipe_dialer.3.html +++ b/man/tip/nng_pipe_dialer.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_dialer(3) - + - @@ -570,12 +74,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/tip/nng_pipe_get.3.html b/man/tip/nng_pipe_get.3.html new file mode 100644 index 00000000..c8ef3459 --- /dev/null +++ b/man/tip/nng_pipe_get.3.html @@ -0,0 +1,279 @@ + + + + + + + +nng_pipe_get(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_pipe_get(nng_pipe p, const char *opt, void *val, size_t *valszp);
+
+int nng_pipe_get_bool(nng_pipe p, const char *opt, bool *bvalp);
+
+int nng_pipe_get_int(nng_pipe p, const char *opt, int *ivalp);
+
+int nng_pipe_get_ms(nng_pipe p, const char *opt, nng_duration *durp);
+
+int nng_pipe_get_ptr(nng_pipe p, const char *opt, void **ptr);
+
+int nng_pipe_get_addr(nng_pipe p, const char *opt, nng_sockaddr *sap);
+
+int nng_pipe_get_string(nng_pipe p, const char *opt, char **strp);
+
+int nng_pipe_get_size(nng_pipe p, const char *opt, size_t *zp);
+
+int nng_pipe_get_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
+
+
+
+
+
+

DESCRIPTION

+
+
+

+The nng_pipe_get() functions are used to retrieve option values for +the pipe p. +The actual options that may be retrieved in this way +vary, and many are documented in nng_options(5). +Additionally some transport-specific options and protocol-specific options are +documented with the transports 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(). +
+
+
+

Any option that is set on a dialer or listener will normally be retrievable +from pipes created by that dialer or listener.

+
+
+

Forms

+
+

In all of these forms, the option opt is retrieved from the pipe p.

+
+
+

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

+
+
+
+
nng_pipe_get()
+
+

This is untyped, and can be used to retrieve the value of any option. +A pointer to a buffer to receive the value in val, and the size of the +buffer shall be stored at the location referenced by valszp.
+
+When the function returns, the actual size of the data copied (or that +would have been copied if sufficient space were present) is stored at +the location referenced by valszp. +If the caller’s buffer is not large enough to hold the entire object, +then the copy is truncated. +Therefore the caller should check for truncation by verifying that the +size returned in valszp does not exceed the original buffer size.
+
+It is acceptable to pass NULL for val if the value in valszp is zero. +This can be used to determine the size of the buffer needed to receive +the object.

+
+
+
+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
+
nng_pipe_get_bool()
+
+

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

+
+
nng_pipe_get_int()
+
+

This function is for options which take an integer (int). +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 +durp.

+
+
nng_pipe_get_ptr()
+
+

This function is used to retrieve a pointer, ptr, to structured data. +The data referenced by ptr is generally managed using other functions. +Note that this form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied.

+
+
nng_pipe_get_size()
+
+

This function is used to retrieve a size into the pointer zp, +typically for buffer sizes, message maximum sizes, and similar options.

+
+
nng_pipe_get_addr()
+
+

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() +and consequently must be freed by the caller using +nng_strfree() when it is no longer needed.

+
+
nng_pipe_get_uint64()
+
+

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

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+NNG_EBADTYPE + +

Incorrect type for option.

+
+NNG_ECLOSED + +

Parameter p does not refer to an open pipe.

+
+NNG_ENOTSUP + +

The option opt is not supported.

+
+NNG_ENOMEM + +

Insufficient memory exists.

+
+NNG_EINVAL + +

Size of destination val too small for object.

+
+NNG_EWRITEONLY + +

The option opt is write-only.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_pipe_getopt.3.html b/man/tip/nng_pipe_getopt.3.html index 41557e92..04426036 100644 --- a/man/tip/nng_pipe_getopt.3.html +++ b/man/tip/nng_pipe_getopt.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_getopt(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_pipe_listener.3.html b/man/tip/nng_pipe_listener.3.html index 2fc1032e..96f2de41 100644 --- a/man/tip/nng_pipe_listener.3.html +++ b/man/tip/nng_pipe_listener.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_listener(3) - + - @@ -570,12 +74,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/tip/nng_pipe_notify.3.html b/man/tip/nng_pipe_notify.3.html index e215cbcb..78d92ee1 100644 --- a/man/tip/nng_pipe_notify.3.html +++ b/man/tip/nng_pipe_notify.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_notify(3) - + - @@ -550,7 +54,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.

@@ -568,7 +72,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.

@@ -596,7 +100,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. @@ -659,14 +163,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/tip/nng_pipe_socket.3.html b/man/tip/nng_pipe_socket.3.html index eec050f0..6fe201e5 100644 --- a/man/tip/nng_pipe_socket.3.html +++ b/man/tip/nng_pipe_socket.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_pipe_socket(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_push_open.3.html b/man/tip/nng_push_open.3.html index d1b580d7..3a12703e 100644 --- a/man/tip/nng_push_open.3.html +++ b/man/tip/nng_push_open.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_push_open(3) - + - @@ -591,13 +95,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/tip/nng_random.3supp.html b/man/tip/nng_random.3supp.html index 60ea0778..ae7141b9 100644 --- a/man/tip/nng_random.3supp.html +++ b/man/tip/nng_random.3supp.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_random(3supp) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_recv.3.html b/man/tip/nng_recv.3.html index 1d305df1..9862ef98 100644 --- a/man/tip/nng_recv.3.html +++ b/man/tip/nng_recv.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_recv(3) - + - @@ -561,12 +65,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().

@@ -586,11 +90,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. @@ -696,15 +200,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/tip/nng_recv_aio.3.html b/man/tip/nng_recv_aio.3.html index d9aca9fd..55a5f250 100644 --- a/man/tip/nng_recv_aio.3.html +++ b/man/tip/nng_recv_aio.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_recv_aio(3) - + -

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 @@ -621,7 +125,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.

@@ -631,12 +135,13 @@ This is more fully documented in the req manual

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/tip/nng_rep_open.3.html b/man/tip/nng_rep_open.3.html index e9b1e437..33668bbb 100644 --- a/man/tip/nng_rep_open.3.html +++ b/man/tip/nng_rep_open.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_rep_open(3) - + - @@ -542,13 +48,13 @@ 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 -in raw mode and returns it at the location pointed to by s.

+

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.

@@ -589,13 +95,14 @@ in raw mode and returns it at the location pointed to by 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/tip/nng_req.7.html b/man/tip/nng_req.7.html index 1c488f70..e642acde 100644 --- a/man/tip/nng_req.7.html +++ b/man/tip/nng_req.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_req(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_respondent.7.html b/man/tip/nng_respondent.7.html index ba55f316..98570c3b 100644 --- a/man/tip/nng_respondent.7.html +++ b/man/tip/nng_respondent.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_respondent(7) - + -

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 @@ -584,15 +88,15 @@ reply will be sent to surveyor from whom the last survey was received.

Respondents may discard a survey by simply not replying to it.

-

Raw mode sockets (set with NNG_OPT_RAW) +

Raw mode sockets (set with NNG_OPT_RAW) 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. @@ -625,7 +129,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.

@@ -634,12 +138,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/tip/nng_respondent_open.3.html b/man/tip/nng_respondent_open.3.html index d3186e74..7c14c841 100644 --- a/man/tip/nng_respondent_open.3.html +++ b/man/tip/nng_respondent_open.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_respondent_open(3) - + - @@ -594,13 +98,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/tip/nng_send.3.html b/man/tip/nng_send.3.html index 891770ba..fbc47968 100644 --- a/man/tip/nng_send.3.html +++ b/man/tip/nng_send.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_send(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_socket_set.3.html b/man/tip/nng_socket_set.3.html new file mode 100644 index 00000000..2ee26c91 --- /dev/null +++ b/man/tip/nng_socket_set.3.html @@ -0,0 +1,246 @@ + + + + + + + +nng_socket_set(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_socket_set(nng_socket s, const char *opt, const void *val, size_t valsz);
+
+int nng_socket_set_bool(nng_socket s, const char *opt, bool bval);
+
+int nng_socket_set_int(nng_socket s, const char *opt, int ival);
+
+int nng_socket_set_ms(nng_socket s, const char *opt, nng_duration dur);
+
+int nng_socket_set_ptr(nng_socket s, const char *opt, void *ptr);
+
+int nng_socket_set_size(nng_socket s, const char *opt, size_t z);
+
+int nng_socket_set_string(nng_socket s, const char *opt, const char *str);
+
+int nng_socket_set_uint64(nng_socket s, const char *opt, uint64_t u64);
+
+
+
+
+
+

DESCRIPTION

+
+
+

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

+
+
+

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

+
+
+

Forms

+
+

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

+
+
+
+
nng_socket_set()
+
+

This function is untyped, and can be used to configure any arbitrary data. +The val pointer addresses the data to copy, and valsz is the +size of the objected located at val.

+
+
+
+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
+
nng_socket_set_bool()
+
+

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

+
+
nng_socket_set_int()
+
+

This function is for options which take an integer (int). +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. +The duration dur is an integer number of milliseconds.

+
+
nng_socket_set_ptr()
+
+

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()) +can be passed this way.

+
+
+
+
+ + + + + +
+ + +This form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied. +
+
+
+
+
nng_socket_set_size()
+
+

This function is used to configure a size, z, typically for buffer sizes, +message maximum sizes, and similar options.

+
+
nng_socket_set_string()
+
+

This function is used to pass configure a string, str. +Strings passed this way must be legal UTF-8 or ASCII strings, terminated +with a NUL (\0) byte. +(Other constraints may apply as well, see the documentation for each option +for details.)

+
+
nng_socket_set_uint64()
+
+

This function is used to configure a 64-bit unsigned value, u64. +This is typically used for options related to identifiers, network numbers, +and similar.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

Parameter s does not refer to an open socket.

+
+NNG_EINVAL + +

The value being passed is invalid.

+
+NNG_ENOTSUP + +

The option opt is not supported.

+
+NNG_EREADONLY + +

The option opt is read-only.

+
+NNG_ESTATE + +

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

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stat.5.html b/man/tip/nng_stat.5.html index 78eb374e..63520036 100644 --- a/man/tip/nng_stat.5.html +++ b/man/tip/nng_stat.5.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_socket(5) + +nng_stat(5) - + - + + + - + \ No newline at end of file diff --git a/man/tip/nng_stat_child.3.html b/man/tip/nng_stat_child.3.html index ff32d874..695adef4 100644 --- a/man/tip/nng_stat_child.3.html +++ b/man/tip/nng_stat_child.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_child(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stat_desc.3.html b/man/tip/nng_stat_desc.3.html index 9dc9a7b2..06473076 100644 --- a/man/tip/nng_stat_desc.3.html +++ b/man/tip/nng_stat_desc.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_desc(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stat_find.3.html b/man/tip/nng_stat_find.3.html new file mode 100644 index 00000000..4522e3b1 --- /dev/null +++ b/man/tip/nng_stat_find.3.html @@ -0,0 +1,102 @@ + + + + + + + +nng_stat_find(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+
+nng_stat *nng_stat_find(nng_stat *stat, const char *name);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stat_find() function searches the statistics tree stat, looking for a statistic whose name is name. +If it finds one, it returns it. +Otherwise NULL is returned.

+
+
+ + + + + +
+ + +If multiple statistics have that name, then only the first match is returned. +
+
+
+
+
+

RETURN VALUES

+
+
+

The matching statistic, or NULL if no match is found.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

libnng(3), +nng_stat_child(3), +nng_stat_find_dialer(3), +nng_stat_find_listner(3), +nng_stat_find_socket(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stat_find_dialer.3.html b/man/tip/nng_stat_find_dialer.3.html new file mode 100644 index 00000000..dbe8f535 --- /dev/null +++ b/man/tip/nng_stat_find_dialer.3.html @@ -0,0 +1,97 @@ + + + + + + + +nng_stat_find_dialer(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+typedef struct nng_dialer nng_dialer;
+
+nng_stat *nng_stat_find_dialer(nng_stat *stat, nng_dialer dialer);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stat_find_dialer() function returns the statistics tree within stat associated with the dialer dialer, if such a tree exists. +Otherwise NULL is returned.

+
+
+

Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +nng_stat_find(3) +or by walking the tree with +nng_stat_child(3).

+
+
+
+
+

RETURN VALUES

+
+
+

The matching statistic, or NULL if no match is found.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

libnng(3), +nng_stat_child(3), +nng_stat_find(3), +nng_stat_find_listener(3), +nng_stat_find_socket(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stat_find_listener.3.html b/man/tip/nng_stat_find_listener.3.html new file mode 100644 index 00000000..f9ff07c3 --- /dev/null +++ b/man/tip/nng_stat_find_listener.3.html @@ -0,0 +1,97 @@ + + + + + + + +nng_stat_find_listener(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+typedef struct nng_listener nng_listener;
+
+nng_stat *nng_stat_find_listener(nng_stat *stat, nng_listener listener);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stat_find_listener() function returns the statistics tree within stat associated with the listener listener, if such a tree exists. +Otherwise NULL is returned.

+
+
+

Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +nng_stat_find(3) +or by walking the tree with +nng_stat_child(3).

+
+
+
+
+

RETURN VALUES

+
+
+

The matching statistic, or NULL if no match is found.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

libnng(3), +nng_stat_child(3), +nng_stat_find(3), +nng_stat_find_dialer(3), +nng_stat_find_socket(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stat_find_socket.3.html b/man/tip/nng_stat_find_socket.3.html new file mode 100644 index 00000000..c8e66131 --- /dev/null +++ b/man/tip/nng_stat_find_socket.3.html @@ -0,0 +1,97 @@ + + + + + + + +nng_stat_find_socket(3) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stat nng_stat;
+typedef struct nng_socket nng_socket;
+
+nng_stat *nng_stat_find_socket(nng_stat *stat, nng_socket socket);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stat_find_socket() function returns the statistics tree within stat associated with the socket socket, if such a tree exists. +Otherwise NULL is returned.

+
+
+

Generally, there will be child statistics of the returned value, each corresponding to a specific metric. +These can be further scanned using either +nng_stat_find(3) +or by walking the tree with +nng_stat_child(3).

+
+
+
+
+

RETURN VALUES

+
+
+

The matching statistic, or NULL if no match is found.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

libnng(3), +nng_stat_child(3), +nng_stat_find(3), +nng_stat_find_dialer(3), +nng_stat_find_listener(3), +nng_stats_get(3), +nng_stat(5), +nng(7)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stat_name.3.html b/man/tip/nng_stat_name.3.html index d6e8b133..01aaf792 100644 --- a/man/tip/nng_stat_name.3.html +++ b/man/tip/nng_stat_name.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_name(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stat_next.3.html b/man/tip/nng_stat_next.3.html index 0ed5275d..a6fc04bc 100644 --- a/man/tip/nng_stat_next.3.html +++ b/man/tip/nng_stat_next.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_next(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stat_string.3.html b/man/tip/nng_stat_string.3.html index 2585cb76..c3651014 100644 --- a/man/tip/nng_stat_string.3.html +++ b/man/tip/nng_stat_string.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_string(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stat_value.3.html b/man/tip/nng_stat_value.3.html index 4e7beee6..cee6bece 100644 --- a/man/tip/nng_stat_value.3.html +++ b/man/tip/nng_stat_value.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_version(3) + +nng_stat_value(3) - + - @@ -546,8 +50,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_stat_value() function returns a numeric value for the statistic stat. If the statistic has a boolean value, then zero is returned for false, and one is returned for true. -Otherwise, if the string is not of numeric type, then zero is returned. -See nng_stat_type() for a description of statistic types.

+Otherwise, if the statistic is not of numeric type, then zero is returned. +See nng_stat_type() for a description of statistic types.

@@ -571,15 +75,16 @@ See nng_stat_type() for a description

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/tip/nng_stats_free.3.html b/man/tip/nng_stats_free.3.html index 1d18af19..6da6a577 100644 --- a/man/tip/nng_stats_free.3.html +++ b/man/tip/nng_stats_free.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_free(3) + +nng_stats_free(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_stats_get.3.html b/man/tip/nng_stats_get.3.html index e5e5b30f..1a3dcf0e 100644 --- a/man/tip/nng_stats_get.3.html +++ b/man/tip/nng_stats_get.3.html @@ -1,514 +1,18 @@ ---- -version: tip -layout: refman ---- - + - -nng_alloc(3) + +nng_stats_get(3) - + - @@ -566,13 +70,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.

@@ -648,21 +152,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/tip/nng_strdup.3.html b/man/tip/nng_strdup.3.html index 39d7b89c..70581c6b 100644 --- a/man/tip/nng_strdup.3.html +++ b/man/tip/nng_strdup.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_strdup(3) - + -
-

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

@@ -591,12 +95,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/tip/nng_stream.5.html b/man/tip/nng_stream.5.html new file mode 100644 index 00000000..1b1421c5 --- /dev/null +++ b/man/tip/nng_stream.5.html @@ -0,0 +1,133 @@ + + + + + + + +nng_stream(5) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stream nng_stream;
+
+
+
+
+
+

DESCRIPTION

+
+
+

An nng_stream represents a byte stream. +This may correspond to an underlying connection such a TCP connection or +a connected UNIX domain socket or named pipe.

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

These objects are created either establishing an outgoing connection +with +nng_stream_dialer_dial() +or by accepting in incoming connection with +nng_stream_listener_accept().

+
+
+

Byte streams are “reliable” in that data +will not be delivered out of order, or with portions missing.

+
+
+

Data can be sent using +nng_stream_send() or +received with +nng_stream_recv().

+
+
+

When the connection is no longer needed, it should be freed with +nng_stream_free().

+
+
+ + + + + +
+ + +It is possible to close the connection, without freeing it, by +using +nng_stream_close(). +
+
+
+

Byte streams may, depending on the underlying technology, +support various +options, which +can be accessed using the +nng_stream_get() and +nng_stream_set() family of +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),

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_close.3str.html b/man/tip/nng_stream_close.3str.html new file mode 100644 index 00000000..bbdc1e3c --- /dev/null +++ b/man/tip/nng_stream_close.3str.html @@ -0,0 +1,124 @@ + + + + + + + +nng_stream_close(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_close(nng_stream *s);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_close() function closes the +byte stream s.

+
+
+

If any operations are pending, such as +nng_stream_send() +or +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 +is closed.

+
+
+ + + + + +
+ + +Closing the connection while data is in transmission will likely +lead to loss of that data. +There is no automatic linger or flush to ensure that the socket send buffers +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(). +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_dialer.5.html b/man/tip/nng_stream_dialer.5.html new file mode 100644 index 00000000..c098c0f0 --- /dev/null +++ b/man/tip/nng_stream_dialer.5.html @@ -0,0 +1,84 @@ + + + + + + + +nng_stream_dialer(5) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stream_dialer nng_stream_dialer;
+
+
+
+
+
+

DESCRIPTION

+
+
+

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

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_dialer_alloc.3str.html b/man/tip/nng_stream_dialer_alloc.3str.html new file mode 100644 index 00000000..867cc7c0 --- /dev/null +++ b/man/tip/nng_stream_dialer_alloc.3str.html @@ -0,0 +1,132 @@ + + + + + + + +nng_stream_dialer_alloc(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_dialer_alloc(nng_stream_dialer **dp, const char *addr);
+
+int nng_stream_dialer_alloc_url(nng_stream_dialer **dp, const nng_url *url);
+
+
+
+
+
+

DESCRIPTION

+
+
+

These functions allocates a dialer for byte streams. +Dialers create +nng_stream objects by initiating outgoing +connections, via the +nng_stream_dialer_dial() function.

+
+
+

The first form, nng_stream_dialer_alloc(), connects to the address +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.

+
+
+

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

+
+
+

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

+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

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

Insufficient free memory exists.

+
+NNG_ENOTSUP + +

The URL scheme is not supported by the implementation.

+
+NNG_EADDRINVAL + +

The URL requested is invalid.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_dialer_close.3str.html b/man/tip/nng_stream_dialer_close.3str.html new file mode 100644 index 00000000..0340cd09 --- /dev/null +++ b/man/tip/nng_stream_dialer_close.3str.html @@ -0,0 +1,110 @@ + + + + + + + +nng_stream_dialer_close(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_dialer_close(nng_stream_dialer *d);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_dialer_close() function closes the supplied byte stream +dialer d, +but does not free the underlying resources associated with it.

+
+
+

If any +dial +operations using d are +in progress, they will be terminated with an NNG_ECLOSED error condition.

+
+
+

Furthermore any future accesses to the dialer d will also result in +NNG_ECLOSED.

+
+
+ + + + + +
+ + +This function does not release the memory for the dialer, so the +application should still free the memory using +nng_stream_dialer_free() +once it is certain that nothing else is using it. +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_dialer_dial.3str.html b/man/tip/nng_stream_dialer_dial.3str.html new file mode 100644 index 00000000..bba85227 --- /dev/null +++ b/man/tip/nng_stream_dialer_dial.3str.html @@ -0,0 +1,157 @@ + + + + + + + +nng_stream_dialer_dial(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_dialer_dial(nng_stream_dialer *d, nng_aio *aio);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_dialer_dial() attempts to establish a connection to the +remote peer for the dialer d. +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(). +
+
+
+

If a connection is successfully established, the aio will have the +resulting +nng_stream object stored as its first output. +(See +nng_aio_get_output().)

+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+NNG_EADDRINVAL + +

The address specified is invalid.

+
+NNG_ECANCELED + +

The operation was aborted.

+
+NNG_ECLOSED + +

The dialer is closed.

+
+NNG_ECONNREFUSED + +

The connection was refused by the server.

+
+NNG_ECONNRESET + +

The connection was reset by the server.

+
+NNG_ENOMEM + +

Insufficient free memory exists.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_dialer_free.3str.html b/man/tip/nng_stream_dialer_free.3str.html new file mode 100644 index 00000000..2855b743 --- /dev/null +++ b/man/tip/nng_stream_dialer_free.3str.html @@ -0,0 +1,103 @@ + + + + + + + +nng_stream_dialer_free(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_dialer_free(nng_stream_dialer *d);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_dialer_free() function closes the supplied +byte stream dialer d, +and frees the underlying resources associated with it.

+
+
+

If any +dial operations using d are +in progress, they will be terminated with an NNG_ECLOSED error condition.

+
+
+ + + + + +
+ + +It is important that the application ensure that no further accesses +are made to d, as the memory backing it will be reclaimed for other uses. +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_dialer_get.3str.html b/man/tip/nng_stream_dialer_get.3str.html new file mode 100644 index 00000000..f852359d --- /dev/null +++ b/man/tip/nng_stream_dialer_get.3str.html @@ -0,0 +1,252 @@ + + + + + + + +nng_stream_dialer_get(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_dialer_get(nng_stream_dialer *d, const char *opt, void *val, size_t *sizep);
+
+int nng_stream_dialer_get_bool(nng_stream_dialer *d, const char *opt, bool *valp);
+
+int nng_stream_dialer_get_int(nng_stream_dialer *d, const char *opt, int *valp);
+
+int nng_stream_dialer_get_ms(nng_stream_dialer *d, const char *opt, nng_duration *valp);
+
+int nng_stream_dialer_get_ptr(nng_stream_dialer *d, const char *opt, void **valp);
+
+int nng_stream_dialer_get_size(nng_stream_dialer *d, const char *opt, size_t *valp);
+
+int nng_stream_dialer_get_addr(nng_stream_dialer *d, const char *opt, nng_sockaddr *valp);
+
+int nng_stream_dialer_get_string(nng_stream_dialer *d, const char *opt, char **valp);
+
+int nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *opt, uint64_t *valp);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_dialer_get() functions are used to retrieve option values for the +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.

+
+
+

Forms

+
+

In all of these forms, the option opt is retrieved from the connected +byte stream dialer d. +The forms vary based on the type of the option they take.

+
+
+

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

+
+
+
+
nng_stream_dialer_get()
+
+

This function is untyped and can be used to retrieve the value of any option. +The caller must store a pointer to a buffer to receive the value in val, +and the size of the buffer shall be stored at the location referenced by +sizep.

+
+

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

+
+
+

It is acceptable to pass NULL for val if the value in sizep is zero. +This can be used to determine the size of the buffer needed to receive +the object.

+
+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_dialer_get_bool()
+
+

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

+
+
nng_stream_dialer_get_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_dialer_get_ms()
+
+

This function is used to retrieve time +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.)

+
+
nng_stream_dialer_get_ptr()
+
+

This function is used to retrieve a pointer to structured data. +The data referenced is generally managed using other functions. +Note that this form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied.

+
+ + + + + +
+ + +Care must be taken to ensure that the application respects any +considerations about the lifetime of the underyling object. +See the documentation for the option for more specific guidance. +
+
+
+
nng_stream_dialer_get_size()
+
+

This function is used to retrieve a size, +typically for buffer sizes, message maximum sizes, and similar options.

+
+
nng_stream_dialer_get_addr()
+
+

This function is used to retrieve a +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() +and consequently must be freed by the caller using +nng_strfree() when it is no longer needed.

+
+
nng_stream_dialer_get_uint64()
+
+

This function is used to retrieve a 64-bit unsigned value. +This is typically used for identifiers, network +numbers, and similar options.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The dialer is closed.

+
+NNG_EINVAL + +

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

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EWRITEONLY + +

The option may not read.

+
+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_dialer_set.3str.html b/man/tip/nng_stream_dialer_set.3str.html new file mode 100644 index 00000000..7e160a22 --- /dev/null +++ b/man/tip/nng_stream_dialer_set.3str.html @@ -0,0 +1,239 @@ + + + + + + + +nng_stream_dialer_set(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_dialer_set(nng_stream_dialer *d, const char *name, const void *data, size_t size);
+
+int nng_stream_dialer_set_bool(nng_stream_dialer *d, const char *opt, bool val);
+
+int nng_stream_dialer_set_int(nng_stream_dialer *d, const char *opt, int val);
+
+int nng_stream_dialer_set_ms(nng_stream_dialer *d, const char *opt, nng_duration val);
+
+int nng_stream_dialer_set_ptr(nng_stream_dialer *d, const char *opt, void *val);
+
+int nng_stream_dialer_set_size(nng_stream_dialer *d, const char *opt, size_t val);
+
+int nng_stream_dialer_set_string(nng_stream_dialer *d, const char *opt, const char *val);
+
+int nng_stream_dialer_set_uint64(nng_stream_dialer *d, const char *opt, uint64_t val);
+
+int nng_stream_dialer_set_addr(nng_stream_dialer *d, const char *opt, const nng_sockaddr *val);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_dialer_set() functions are used to configure options for the +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).

+
+
+

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

+
+
+

Forms

+
+

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

+
+
+
+
nng_stream_dialer_set()
+
+

This function is untyped, and can be used to configure any arbitrary data. +The val pointer addresses the data to copy, and size is the +size of the objected located at val.

+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_dialer_set_bool()
+
+

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

+
+
nng_stream_dialer_set_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_dialer_set_ms()
+
+

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

+
+
nng_stream_dialer_set_ptr()
+
+

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() +can be passed this way.

+
+ + + + + +
+ + +This form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied. +Please see the documentation for the specific option for further details. +
+
+
+
nng_stream_dialer_set_size()
+
+

This function is used to configure a size, typically for buffer sizes, +message maximum sizes, and similar options.

+
+
nng_stream_dialer_set_string()
+
+

This function is used to pass configure a string. +Strings passed this way must be legal UTF-8 or ASCII strings, terminated +with a NUL (\0) byte. +(Other constraints may apply as well, see the documentation for each option +for details.)

+
+
nng_stream_dialer_set_uint64()
+
+

This function is used to configure a 64-bit unsigned value/ +This is typically used for identifiers, network numbers, +and similar options.

+
+
nng_stream_dialer_set_addr()
+
+

This function is used to configure a +socket address. +The value is copied, and thus the caller may discard the supplied +value immediately after this function returns.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

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

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The dialer is closed.

+
+NNG_EINVAL + +

Either data or size are invalid.

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EREADONLY + +

The option may not be modified.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_free.3str.html b/man/tip/nng_stream_free.3str.html new file mode 100644 index 00000000..f638cf65 --- /dev/null +++ b/man/tip/nng_stream_free.3str.html @@ -0,0 +1,120 @@ + + + + + + + +nng_stream_free(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_free(nng_stream *s);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_free() function closes the +byte stream s, +and frees the underlying resources associated with it.

+
+
+

If any operations are pending, such as +nng_stream_send() +or +nng_stream_recv(), +they will be terminated with an NNG_ECLOSED error condition.

+
+
+ + + + + +
+ + +It is important that the application ensure that no further accesses +are made to s, as the memory backing it will be reclaimed for other uses. +
+
+
+ + + + + +
+ + +Closing the connection while data is in transmission will likely +lead to loss of that data. +There is no automatic linger or flush to ensure that the socket send buffers +have completely transmitted. +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_get.3str.html b/man/tip/nng_stream_get.3str.html new file mode 100644 index 00000000..c6beaceb --- /dev/null +++ b/man/tip/nng_stream_get.3str.html @@ -0,0 +1,255 @@ + + + + + + + +nng_stream_get(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_get(nng_stream *s, const char *opt, void *val, size_t *sizep);
+
+int nng_stream_get_bool(nng_stream *s, const char *opt, bool *valp);
+
+int nng_stream_get_int(nng_stream *s, const char *opt, int *valp);
+
+int nng_stream_get_ms(nng_stream *s, const char *opt, nng_duration *valp);
+
+int nng_stream_get_ptr(nng_stream *s, const char *opt, void **valp);
+
+int nng_stream_get_size(nng_stream *s, const char *opt, size_t *valp);
+
+int nng_stream_get_addr(nng_stream *s, const char *opt, nng_sockaddr *valp);
+
+int nng_stream_get_string(nng_stream *s, const char *opt, char **valp);
+
+int nng_stream_get_uint64(nng_stream *s, const char *opt, uint64_t *valp);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_get() functions are used to retrieve option values for the +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.

+
+
+

Forms

+
+

In all of these forms, the option opt is retrieved from the connected +byte stream s. +The forms vary based on the type of the option they take.

+
+
+

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

+
+
+
+
nng_stream_get()
+
+

This function is untyped and can be used to retrieve the value of any option. +The caller must store a pointer to a buffer to receive the value in val, +and the size of the buffer shall be stored at the location referenced by +sizep.

+
+

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

+
+
+

It is acceptable to pass NULL for val if the value in sizep is zero. +This can be used to determine the size of the buffer needed to receive +the object.

+
+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_get_bool()
+
+

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

+
+
nng_stream_get_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_get_ms()
+
+

This function is used to retrieve time +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.)

+
+
nng_stream_get_ptr()
+
+

This function is used to retrieve a pointer to structured data. +The data referenced is generally managed using other functions. +Note that this form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied.

+
+ + + + + +
+ + +Care must be taken to ensure that the application respects any +considerations about the lifetime of the underyling object. +See the documentation for the option for more specific guidance. +
+
+
+
nng_stream_get_size()
+
+

This function is used to retrieve a size, +typically for buffer sizes, message maximum sizes, and similar options.

+
+
nng_stream_get_addr()
+
+

This function is used to retrieve a +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() +and consequently must be freed by the caller using +nng_strfree() when it is no longer needed.

+
+
nng_stream_get_uint64()
+
+

This function is used to retrieve a 64-bit unsigned value. +This is typically used for identifiers, network +numbers, and similar options.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

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

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The connection is closed.

+
+NNG_EINVAL + +

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

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EWRITEONLY + +

The option may not read.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_listener.5.html b/man/tip/nng_stream_listener.5.html new file mode 100644 index 00000000..410b07ea --- /dev/null +++ b/man/tip/nng_stream_listener.5.html @@ -0,0 +1,86 @@ + + + + + + + +nng_stream_listener(5) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_stream_listener nng_stream_listener;
+
+
+
+
+
+

DESCRIPTION

+
+
+

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

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

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_listener_accept.3str.html b/man/tip/nng_stream_listener_accept.3str.html new file mode 100644 index 00000000..5cf759f5 --- /dev/null +++ b/man/tip/nng_stream_listener_accept.3str.html @@ -0,0 +1,140 @@ + + + + + + + +nng_stream_listener_accept(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_listener_accept(nng_stream_listener *l, nng_aio *aio);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_accept() attempts to accept an incoming byte stream +connection from a remote peer, using the listener l. +The operation is completed asynchronously, using aio.

+
+
+

This operation can only be done after the listener is already +listening.

+
+
+

If a connection is successfully established, the aio will have the +resulting +nng_stream object stored as its first output, +which can be retrieved with +nng_aio_get_output().

+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+NNG_ECANCELED + +

The operation was aborted.

+
+NNG_ECLOSED + +

The listener is closed.

+
+NNG_ECONNRESET + +

The connection was reset by the peer.

+
+NNG_ENOMEM + +

Insufficient free memory exists.

+
+NNG_ESTATE + +

The listener is not not listening.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_listener_alloc.3str.html b/man/tip/nng_stream_listener_alloc.3str.html new file mode 100644 index 00000000..f507fef5 --- /dev/null +++ b/man/tip/nng_stream_listener_alloc.3str.html @@ -0,0 +1,134 @@ + + + + + + + +nng_stream_listener_alloc(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_listener_alloc(nng_stream_listener **lp, const char *addr);
+
+int nng_stream_listener_alloc_url(nng_stream_listener **lp, const nng_url *url);
+
+
+
+
+
+

DESCRIPTION

+
+
+

These functions allocates a listener for byte streams. +Listeners create +nng_stream objects by accepting incoming +connections, via the +nng_stream_listener_accept() +function.

+
+
+

The first form, nng_stream_listener_alloc(), connects to the address +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.

+
+
+

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

+
+
+

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

+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

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

Insufficient free memory exists.

+
+NNG_ENOTSUP + +

The URL scheme is not supported by the implementation.

+
+NNG_EADDRINVAL + +

The URL requested is invalid.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_listener_close.3str.html b/man/tip/nng_stream_listener_close.3str.html new file mode 100644 index 00000000..ecb783be --- /dev/null +++ b/man/tip/nng_stream_listener_close.3str.html @@ -0,0 +1,110 @@ + + + + + + + +nng_stream_listener_close(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_listener_close(nng_stream_listener *l);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_close() function closes the supplied connected byte +stream listener l, +but does not free the underlying resources associated with it.

+
+
+

If any +accept +operations using d are +in progress, they will be terminated with an NNG_ECLOSED error condition.

+
+
+

Furthermore any future accesses to the listener l will also result in +NNG_ECLOSED.

+
+
+ + + + + +
+ + +This function does not release the memory for the listener, so the +application should still free the memory using +nng_stream_listener_free() +once it is certain that nothing else is using it. +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_listener_free.3str.html b/man/tip/nng_stream_listener_free.3str.html new file mode 100644 index 00000000..c422e8bb --- /dev/null +++ b/man/tip/nng_stream_listener_free.3str.html @@ -0,0 +1,103 @@ + + + + + + + +nng_stream_listener_free(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_listener_free(nng_stream_listener *)l;
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_free() function closes the supplied +byte stream listener l, +and frees the underlying resources associated with it.

+
+
+

If any +accept operations using __l are +in progress, they will be terminated with an NNG_ECLOSED error condition.

+
+
+ + + + + +
+ + +It is important that the application ensure that no further accesses +are made to l, as the memory backing it will be reclaimed for other uses. +
+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_listener_get.3str.html b/man/tip/nng_stream_listener_get.3str.html new file mode 100644 index 00000000..77785a96 --- /dev/null +++ b/man/tip/nng_stream_listener_get.3str.html @@ -0,0 +1,253 @@ + + + + + + + +nng_stream_listener_get(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_listener_get(nng_stream_listener *l, const char *opt, void *val, size_t *sizep);
+
+int nng_stream_listener_get_bool(nng_stream_listener *l, const char *opt, bool *valp);
+
+int nng_stream_listener_get_int(nng_stream_listener *l, const char *opt, int *valp);
+
+int nng_stream_listener_get_ms(nng_stream_listener *l, const char *opt, nng_duration *valp);
+
+int nng_stream_listener_get_ptr(nng_stream_listener *l, const char *opt, void **valp);
+
+int nng_stream_listener_get_size(nng_stream_listener *l, const char *opt, size_t *valp);
+
+int nng_stream_listener_get_addr(nng_stream_listener *l, const char *opt, nng_sockaddr *valp);
+
+int nng_stream_listener_get_string(nng_stream_listener *l, const char *opt, char **valp);
+
+int nng_stream_listener_get_uint64(nng_stream_listener *l, const char *opt, uint64_t *valp);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_get() functions are used to retrieve option values +for the +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.

+
+
+

Forms

+
+

In all of these forms, the option opt is retrieved from the connected +byte stream listener l. +The forms vary based on the type of the option they take.

+
+
+

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

+
+
+
+
nng_stream_listener_get()
+
+

This function is untyped and can be used to retrieve the value of any option. +The caller must store a pointer to a buffer to receive the value in val, +and the size of the buffer shall be stored at the location referenced by +sizep.

+
+

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

+
+
+

It is acceptable to pass NULL for val if the value in sizep is zero. +This can be used to determine the size of the buffer needed to receive +the object.

+
+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_listener_get_bool()
+
+

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

+
+
nng_stream_listener_get_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_listener_get_ms()
+
+

This function is used to retrieve time +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.)

+
+
nng_stream_listener_get_ptr()
+
+

This function is used to retrieve a pointer to structured data. +The data referenced is generally managed using other functions. +Note that this form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied.

+
+ + + + + +
+ + +Care must be taken to ensure that the application respects any +considerations about the lifetime of the underyling object. +See the documentation for the option for more specific guidance. +
+
+
+
nng_stream_listener_get_size()
+
+

This function is used to retrieve a size, +typically for buffer sizes, message maximum sizes, and similar options.

+
+
nng_stream_listener_get_addr()
+
+

This function is used to retrieve a +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() +and consequently must be freed by the caller using +nng_strfree() when it is no longer needed.

+
+
nng_stream_listener_get_uint64()
+
+

This function is used to retrieve a 64-bit unsigned value. +This is typically used for identifiers, network +numbers, and similar options.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

These functions return 0 on success, and non-zero otherwise.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The listener is closed.

+
+NNG_EINVAL + +

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

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EWRITEONLY + +

The option may not read.

+
+
+
+
+
+

SEE ALSO

+
+
+

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/tip/nng_stream_listener_listen.3str.html b/man/tip/nng_stream_listener_listen.3str.html new file mode 100644 index 00000000..edf91f0e --- /dev/null +++ b/man/tip/nng_stream_listener_listen.3str.html @@ -0,0 +1,136 @@ + + + + + + + +nng_stream_listener_listen(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_listener_listen(nng_stream_listener *l);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_listen() attempts to bind the listener l +to the local address specified when the listener was created.

+
+
+

This must generally be done before accepting incoming connections using +nng_stream_listener_accept().

+
+
+

For some transports this will also perform other actiosn. For example, +with TCP listeners it will configure the +underlying port into passive mode, ready to +accept an incoming connection, and established a listen queue +for receiving incoming connections.

+
+
+

If binding the listener requires allocation of an address (for example +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(), +typically with the +NNG_OPT_LOCADDR option.

+
+
+
+
+

RETURN VALUES

+
+
+

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

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_EADDRINUSE + +

The address is already in use.

+
+NNG_EADDRINVAL + +

The address is invalid or unavailable.

+
+NNG_ECLOSED + +

The listener has been closed.

+
+NNG_ESTATE + +

The listener is already bound.

+
+
+
+
+
+

SEE ALSO

+
+
+

nng_stream_listener_accept(3str), +nng_strerror(3), +nng_stream_listener(5)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_listener_set.3str.html b/man/tip/nng_stream_listener_set.3str.html new file mode 100644 index 00000000..bb9fd3ee --- /dev/null +++ b/man/tip/nng_stream_listener_set.3str.html @@ -0,0 +1,239 @@ + + + + + + + +nng_stream_listener_set(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_listener_set(nng_stream_listener *l, const char *name, const void *data, size_t size);
+
+int nng_stream_listener_set_bool(nng_stream_listener *l, const char *opt, bool val);
+
+int nng_stream_listener_set_int(nng_stream_listener *l, const char *opt, int val);
+
+int nng_stream_listener_set_ms(nng_stream_listener *l, const char *opt, nng_duration val);
+
+int nng_stream_listener_set_ptr(nng_stream_listener *l, const char *opt, void *val);
+
+int nng_stream_listener_set_size(nng_stream_listener *l, const char *opt, size_t val);
+
+int nng_stream_listener_set_string(nng_stream_listener *l, const char *opt, const char *val);
+
+int nng_stream_listener_set_uint64(nng_stream_listener *l, const char *opt, uint64_t val);
+
+int nng_stream_listener_set_addr(nng_stream_listener *l, const char *opt, const nng_sockaddr *val);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_listener_set() functions are used to configure options for the +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).

+
+
+

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

+
+
+

Forms

+
+

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

+
+
+
+
nng_stream_listener_set()
+
+

This function is untyped, and can be used to configure any arbitrary data. +The val pointer addresses the data to copy, and size is the +size of the objected located at val.

+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_listener_set_bool()
+
+

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

+
+
nng_stream_listener_set_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_listener_set_ms()
+
+

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

+
+
nng_stream_listener_set_ptr()
+
+

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() +can be passed this way.

+
+ + + + + +
+ + +This form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied. +Please see the documentation for the specific option for further details. +
+
+
+
nng_stream_listener_set_size()
+
+

This function is used to configure a size, typically for buffer sizes, +message maximum sizes, and similar options.

+
+
nng_stream_listener_set_string()
+
+

This function is used to pass configure a string. +Strings passed this way must be legal UTF-8 or ASCII strings, terminated +with a NUL (\0) byte. +(Other constraints may apply as well, see the documentation for each option +for details.)

+
+
nng_stream_listener_set_uint64()
+
+

This function is used to configure a 64-bit unsigned value/ +This is typically used for identifiers, network numbers, +and similar options.

+
+
nng_stream_listener_set_addr()
+
+

This function is used to configure a +socket address. +The value is copied, and thus the caller may discard the supplied +value immediately after this function returns.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

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

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The listener is closed.

+
+NNG_EINVAL + +

Either data or size are invalid.

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EREADONLY + +

The option may not be modified.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_recv.3str.html b/man/tip/nng_stream_recv.3str.html new file mode 100644 index 00000000..e782b20e --- /dev/null +++ b/man/tip/nng_stream_recv.3str.html @@ -0,0 +1,174 @@ + + + + + + + +nng_stream_recv(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_recv(nng_stream *s, nng_aio *aio);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_recv() function starts an asynchronous receive from the +byte stream s +into the scatter/gather vector located in the +asynchronous I/O structure aio.

+
+
+ + + + + +
+ + +The +nng_aio_set_iov() function must have been +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(). +That result will either be zero or an error code.

+
+
+

The I/O operation completes as soon as at least one byte has been +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().

+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NNG_ECANCELED + +

The operation was canceled.

+
+NNG_ECLOSED + +

The connection was closed.

+
+NNG_ECONNRESET + +

The peer closed the connection.

+
+NNG_ECONNSHUT + +

Remote peer shutdown after sending data.

+
+NNG_EINVAL + +

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

+
+NNG_ENOMEM + +

Insufficient free memory to perform the operation.

+
+NNG_ETIMEDOUT + +

Timeout waiting for data from the connection.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_send.3str.html b/man/tip/nng_stream_send.3str.html new file mode 100644 index 00000000..f188b1a7 --- /dev/null +++ b/man/tip/nng_stream_send.3str.html @@ -0,0 +1,167 @@ + + + + + + + +nng_stream_send(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+void nng_stream_send(nng_stream *s, nng_aio *aio);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_send() function starts an asynchronous send over the +byte stream s +from the scatter/gather vector located in the +asynchronous I/O structure aio.

+
+
+ + + + + +
+ + +The +nng_aio_set_iov() +function must have been +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(). +That result will either be zero or an error code.

+
+
+

The I/O operation completes as soon as at least one byte has been +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().

+
+
+
+
+

RETURN VALUES

+
+
+

None.

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+NNG_ECANCELED + +

The operation was canceled.

+
+NNG_ECLOSED + +

The connection was closed.

+
+NNG_ECONNRESET + +

The peer closed the connection.

+
+NNG_EINVAL + +

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

+
+NNG_ENOMEM + +

Insufficient free memory to perform the operation.

+
+NNG_ETIMEDOUT + +

Timeout waiting for data from the connection.

+
+
+
+
+
+

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_recv(3str), +nng_stream(5)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_stream_set.3str.html b/man/tip/nng_stream_set.3str.html new file mode 100644 index 00000000..68bc8ae3 --- /dev/null +++ b/man/tip/nng_stream_set.3str.html @@ -0,0 +1,239 @@ + + + + + + + +nng_stream_set(3str) + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_stream_set(nng_stream *s, const char *name, const void *data, size_t size);
+
+int nng_stream_set_bool(nng_stream *s, const char *opt, bool val);
+
+int nng_stream_set_int(nng_stream *s, const char *opt, int val);
+
+int nng_stream_set_ms(nng_stream *s, const char *opt, nng_duration val);
+
+int nng_stream_set_ptr(nng_stream *s, const char *opt, void *val);
+
+int nng_stream_set_size(nng_stream *s, const char *opt, size_t val);
+
+int nng_stream_set_string(nng_stream *s, const char *opt, const char *val);
+
+int nng_stream_set_uint64(nng_stream *s, const char *opt, uint64_t val);
+
+int nng_stream_set_addr(nng_stream *s, const char *opt, const nng_sockaddr *val);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_stream_set() functions are used to configure options for the +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).

+
+
+

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

+
+
+

Forms

+
+

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

+
+
+
+
nng_stream_set()
+
+

This function is untyped, and can be used to configure any arbitrary data. +The val pointer addresses the data to copy, and size is the +size of the objected located at val.

+
+ + + + + +
+ + +It may be easier to use one of the typed forms of this function. +
+
+
+
nng_stream_set_bool()
+
+

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

+
+
nng_stream_set_int()
+
+

This function is for options which take an integer (int).

+
+
nng_stream_set_ms()
+
+

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

+
+
nng_stream_set_ptr()
+
+

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() +can be passed this way.

+
+ + + + + +
+ + +This form is somewhat special in that the object is generally +not copied, but instead the pointer to the object is copied. +Please see the documentation for the specific option for further details. +
+
+
+
nng_stream_set_size()
+
+

This function is used to configure a size, typically for buffer sizes, +message maximum sizes, and similar options.

+
+
nng_stream_set_string()
+
+

This function is used to pass configure a string. +Strings passed this way must be legal UTF-8 or ASCII strings, terminated +with a NUL (\0) byte. +(Other constraints may apply as well, see the documentation for each option +for details.)

+
+
nng_stream_set_uint64()
+
+

This function is used to configure a 64-bit unsigned value/ +This is typically used for identifiers, network numbers, +and similar options.

+
+
nng_stream_set_addr()
+
+

This function is used to configure a +socket address. +The value is copied, and thus the caller may discard the supplied +value immediately after this function returns.

+
+
+
+
+
+
+
+

RETURN VALUES

+
+
+

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

+
+
+
+
+

ERRORS

+
+
+ + + + + + + + + + + + + + + + + +
+NNG_ECLOSED + +

The connection is closed.

+
+NNG_EINVAL + +

Either data or size are invalid.

+
+NNG_ENOTSUP + +

The option is not supported.

+
+NNG_EREADONLY + +

The option may not be modified.

+
+
+
+
+
+

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)

+
+
+
+
+ + + \ No newline at end of file diff --git a/man/tip/nng_strerror.3.html b/man/tip/nng_strerror.3.html index 29155b18..d54dfb83 100644 --- a/man/tip/nng_strerror.3.html +++ b/man/tip/nng_strerror.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_strerror(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_strfree.3.html b/man/tip/nng_strfree.3.html index 91f82072..7de45051 100644 --- a/man/tip/nng_strfree.3.html +++ b/man/tip/nng_strfree.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_strfree(3) - + -

NAME

-

nng_free - free memory

+

nng_strfree - free memory

@@ -542,7 +46,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.

@@ -554,8 +58,8 @@ the size.

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. @@ -570,9 +74,9 @@ 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.) @@ -600,13 +104,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/tip/nng_sub.7.html b/man/tip/nng_sub.7.html index a12a61ab..098c6524 100644 --- a/man/tip/nng_sub.7.html +++ b/man/tip/nng_sub.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_sub(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tcp.7.html b/man/tip/nng_tcp.7.html index 90dcae8b..f2693af5 100644 --- a/man/tip/nng_tcp.7.html +++ b/man/tip/nng_tcp.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tcp(7) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tcp_close.3tcp.html b/man/tip/nng_tcp_close.3tcp.html deleted file mode 100644 index d7a303f2..00000000 --- a/man/tip/nng_tcp_close.3tcp.html +++ /dev/null @@ -1,615 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_close(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_close(nng_tcp *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_close() function closes the supplied TCP connection, conn.

-
-
-

If any operations are pending (such as nng_tcp_send() -or nng_tcp_recv() they will be terminated with -an NNG_ECLOSED error condition. -Also, any new operations will fail with NNG_ECLOSED after the connection -is closed.

-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -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_tcp_free(). -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_free(3tcp), -nng_tcp_recv(3tcp), -nng_tcp_send(3tcp), -nng_tcp(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer.5.html b/man/tip/nng_tcp_dialer.5.html deleted file mode 100644 index d2eea485..00000000 --- a/man/tip/nng_tcp_dialer.5.html +++ /dev/null @@ -1,593 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-typedef struct nng_tcp_dialer_s nng_tcp_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_tcp_dialer is a handle to a TCP “dialer”, which is responsible for -creating connections (nng_tcp objects) by connecting to -remote systems.

-
-
- - - - - -
- - -The nng_tcp_dialer object is used for raw TCP connections, and -should not be confused with a dialer object created using the -nng_tcp(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_tcp transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_tcp_dialer_alloc(3tcp), -nng_tcp_dialer_close(3tcp), -nng_tcp_dialer_dial(3tcp), -nng_tcp_dialer_free(3tcp), -nng_tcp(5), -nng_tcp_listener(5), -nng_tcp(7)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_alloc.3tcp.html b/man/tip/nng_tcp_dialer_alloc.3tcp.html deleted file mode 100644 index 1ade6959..00000000 --- a/man/tip/nng_tcp_dialer_alloc.3tcp.html +++ /dev/null @@ -1,592 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_alloc(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_dialer_alloc(nng_tcp_dialer *dp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_alloc() allocates a TCP dialer, which can be used -to create outgoing connections over TCP, and stores a pointer to it -it in the location referenced by dp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_close(3tcp), -nng_tcp_dialer_dial(3tcp), -nng_tcp_dialer_free(3tcp), -nng_tcp_dialer_getopt(3tcp), -nng_tcp_dialer_setopt(3tcp), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_close.3tcp.html b/man/tip/nng_tcp_dialer_close.3tcp.html deleted file mode 100644 index 64c6baca..00000000 --- a/man/tip/nng_tcp_dialer_close.3tcp.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_close(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_dialer_close(nng_tcp_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_close() function closes the supplied TCP dialer d, -but does not free the underlying resources associated with it.

-
-
-

If any dial operations using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the dialer d will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the dialer, so the -application should still free the memory using -nng_tcp_dialer_free() -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_alloc(3tcp), -nng_tcp_dialer_dial(3tcp), -nng_tcp_dialer_free(3tcp), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_dial.3tcp.html b/man/tip/nng_tcp_dialer_dial.3tcp.html deleted file mode 100644 index db89331a..00000000 --- a/man/tip/nng_tcp_dialer_dial.3tcp.html +++ /dev/null @@ -1,642 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_dial(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_dialer_dial(nng_tcp_dialer *d, const nng_sockaddr *sa, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_dial() attempts to establish a TCP connection to the -remote peer identified by sa, using the dialer d. -The operation is completed asynchronously, using aio.

-
-
-

The address sa must be in the NNG_AF_INET or NNG_AF_INET6 families, -and have a valid IPv4 or IPv6 address and TCP port number.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_tcp stored as its first output. -(See nng_aio_get_output().)

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_EADDRINVAL - -

The address specified is invalid.

-
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_ECONNREFUSED - -

The connection was refused by the server.

-
-NNG_ECONNRESET - -

The connection was reset by the server.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_alloc(3tcp), -nng_tcp_dialer_close(3tcp), -nng_tcp_dialer_free(3tcp), -nng_aio(5), -nng_sockaddr(5), -nng_tcp(5), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_free.3tcp.html b/man/tip/nng_tcp_dialer_free.3tcp.html deleted file mode 100644 index f0421175..00000000 --- a/man/tip/nng_tcp_dialer_free.3tcp.html +++ /dev/null @@ -1,597 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_free(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_dialer_free(nng_tcp_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_free() function closes the supplied TCP dialer d, -and frees the underlying resources associated with it.

-
-
-

If any dial operations using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to d, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_alloc(3tcp), -nng_tcp_dialer_close(3tcp), -nng_tcp_dialer_dial(3tcp), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_getopt.3tcp.html b/man/tip/nng_tcp_dialer_getopt.3tcp.html deleted file mode 100644 index 6dc544bc..00000000 --- a/man/tip/nng_tcp_dialer_getopt.3tcp.html +++ /dev/null @@ -1,646 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_getopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_getopt(nng_tcp_dialer *d, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_getopt() is used to retrieve the value of the option name -for the TCP dialer d. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TCP dialers are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_setopt(3tcp), -nng_tcp_getopt(3tcp), -nng_options(5), -nng_tcp_options(5), -nng_tcp(5), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_dialer_setopt.3tcp.html b/man/tip/nng_tcp_dialer_setopt.3tcp.html deleted file mode 100644 index 03c7bb35..00000000 --- a/man/tip/nng_tcp_dialer_setopt.3tcp.html +++ /dev/null @@ -1,640 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_dialer_setopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_dialer_setopt(nng_tcp_dialer *d, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_dialer_setopt() is used to set the option name for the -TCP dialer d. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TCP dialers are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_dialer_getopt(3tcp), -nng_tcp_setopt(3tcp), -nng_options(5), -nng_tcp_options(5), -nng_tcp(5), -nng_tcp_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_free.3tcp.html b/man/tip/nng_tcp_free.3tcp.html deleted file mode 100644 index f2aca4cd..00000000 --- a/man/tip/nng_tcp_free.3tcp.html +++ /dev/null @@ -1,613 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_free(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_free(nng_tcp *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_free() function closes the supplied TCP connection, conn, -and frees the underlying resources associated with it.

-
-
-

If any operations are pending (such as nng_tcp_send() -or nng_tcp_recv() they will be terminated with -an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to conn, as the memory backing it will be reclaimed for other uses. -
-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -have completely transmitted. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_close(3tcp), -nng_tcp_recv(3tcp), -nng_tcp_send(3tcp), -nng_tcp(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_getopt.3tcp.html b/man/tip/nng_tcp_getopt.3tcp.html deleted file mode 100644 index d002ffb9..00000000 --- a/man/tip/nng_tcp_getopt.3tcp.html +++ /dev/null @@ -1,647 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_getopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_getopt(nng_tcp *conn, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_getopt() is used to retrieve the value of the option name for -the TCP connection conn. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TCP connections are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_setopt(3tcp), -nng_options(5), -nng_tcp_options(5), -nng_tcp(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener.5.html b/man/tip/nng_tcp_listener.5.html deleted file mode 100644 index 09b0f61b..00000000 --- a/man/tip/nng_tcp_listener.5.html +++ /dev/null @@ -1,596 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-typedef struct nng_tcp_dialer_s nng_tcp_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_tcp_listener is a handle to a TCP “listener”, which is responsible -for accepting connections (nng_tcp objects) from remote -systems.

-
-
- - - - - -
- - -The nng_tcp_listener object is used for raw TCP connections, and -should not be confused with a listener object created using the -nng_tcp(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_tcp(7) transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_tcp_listener_accept(3tcp), -nng_tcp_listener_alloc(3tcp), -nng_tcp_listener_close(3tcp), -nng_tcp_listener_free(3tcp), -nng_tcp_listener_getopt(3tcp), -nng_tcp_listener_listen(3tcp), -nng_tcp_listener_setopt(3tcp), -nng_tcp(5), -nng_tcp_dialer(5), -nng_tcp(7)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_accept.3tcp.html b/man/tip/nng_tcp_listener_accept.3tcp.html deleted file mode 100644 index d9a19f02..00000000 --- a/man/tip/nng_tcp_listener_accept.3tcp.html +++ /dev/null @@ -1,640 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_accept(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_listener_accept(nng_tcp_listener *l, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_accept() attempts to accept an incoming TCP connection -from a remote peer, using the listener l. -The operation is completed asynchronously, using aio.

-
-
-

This operation can only be done after the listener is already bound to -a TCP port and is listening.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_tcp stored as its first output. -(See nng_aio_get_output().)

-
-
-

The address of the remote peer can be determined using the -NNG_OPT_REMADDR option with the -nng_tcp_getopt() function on the -returned nng_tcp.

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_ECONNRESET - -

The TCP connection was reset by the peer.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_ESTATE - -

The listener is not not listening.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_alloc(3tcp), -nng_tcp_listener_close(3tcp), -nng_tcp_listener_free(3tcp), -nng_tcp_listener_listen(3tcp), -nng_aio(5), -nng_tcp(5), -nng_tcp_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_alloc.3tcp.html b/man/tip/nng_tcp_listener_alloc.3tcp.html deleted file mode 100644 index 01df0f38..00000000 --- a/man/tip/nng_tcp_listener_alloc.3tcp.html +++ /dev/null @@ -1,593 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_alloc(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_listener_alloc(nng_tcp_listener *lp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_alloc() allocates a TCP listener, which can be used -to accept incoming connections over TCP, and stores a pointer to it -it in the location referenced by lp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_accept(3tcp), -nng_tcp_listener_close(3tcp), -nng_tcp_listener_free(3tcp), -nng_tcp_listener_getopt(3tcp), -nng_tcp_listener_listen(3tcp), -nng_tcp_listener_setopt(3tcp), -nng_tcp_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_close.3tcp.html b/man/tip/nng_tcp_listener_close.3tcp.html deleted file mode 100644 index 7273103e..00000000 --- a/man/tip/nng_tcp_listener_close.3tcp.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_close(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_listener_close(nng_tcp_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_close() function closes the supplied TCP listener l, -but does not free the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the listener l will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the listener, so the -application should still free the memory using -nng_tcp_listener_free() -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_alloc(3tcp), -nng_tcp_listener_accept(3tcp), -nng_tcp_listener_free(3tcp), -nng_tcp_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_free.3tcp.html b/man/tip/nng_tcp_listener_free.3tcp.html deleted file mode 100644 index 14970ea0..00000000 --- a/man/tip/nng_tcp_listener_free.3tcp.html +++ /dev/null @@ -1,596 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_free(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_listener_free(nng_tcp_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_free() function closes the supplied TCP listener l, -and frees the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to l, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_alloc(3tcp), -nng_tcp_listener_close(3tcp), -nng_tcp_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_getopt.3tcp.html b/man/tip/nng_tcp_listener_getopt.3tcp.html deleted file mode 100644 index 70169f07..00000000 --- a/man/tip/nng_tcp_listener_getopt.3tcp.html +++ /dev/null @@ -1,645 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_getopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_listener_getopt(nng_tcp_listener *l, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_getopt() is used to retrieve the value of the option name for the TCP listener l. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TCP listeners are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_setopt(3tcp), -nng_tcp_getopt(3tcp), -nng_options(5), -nng_tcp(5), -nng_tcp_listener(5), -nng_tcp_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_listen.3tcp.html b/man/tip/nng_tcp_listener_listen.3tcp.html deleted file mode 100644 index 0ab34e69..00000000 --- a/man/tip/nng_tcp_listener_listen.3tcp.html +++ /dev/null @@ -1,637 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_listen(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_listener_listen(nng_tcp_listener l, const nng_sockaddr *sa);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_listen() attempts to bind the listener l -to the local address specified by sa, which must be in the -NNG_AF_INET or NNG_AF_INET6 address family.

-
-
-

This also sets the underlying port into passive mode, ready to -accept an incoming connection, and established a listen queue -for receiving incoming connections. (The queue depth is system -specific, but typically 128.)

-
-
-

The actual IPv4 or IPv6 address in sa may refer either to a locally -configured interface address, or to a zero-valued adddress to indicate -that all interfaces on the system should be bound.

-
-
-

The TCP port number may also be zero. In this case the system will -choose a free TCP port at random, and use it.

-
-
-

The chosen port number may be retrieved using the -NNG_OPT_LOCADDR option with the -nng_tcp_listener_getopt() function.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_EADDRINUSE - -

The address specified by sa is already in use.

-
-NNG_EADDRINVAL - -

The address specified by sa is invalid or unavailable.

-
-NNG_ECLOSED - -

The listener l has been closed.

-
-NNG_ESTATE - -

The listener l is already bound.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_accept(3tcp), -nng_tcp_listener_alloc(3tcp), -nng_tcp_listener_close(3tcp), -nng_tcp_listener_free(3tcp), -nng_tcp_listener_getopt(3tcp), -nng_sockaddr(5), -nng_tcp_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_listener_setopt.3tcp.html b/man/tip/nng_tcp_listener_setopt.3tcp.html deleted file mode 100644 index 9c67b28b..00000000 --- a/man/tip/nng_tcp_listener_setopt.3tcp.html +++ /dev/null @@ -1,637 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_listener_setopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_listener_setopt(nng_tcp_listener *l, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_listener_setopt() is used to set the option name for the -TCP listener l. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TCP listeners are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tcp_listener_getopt(3tcp), -nng_tcp_setopt(3tcp), -nng_options(5), -nng_tcp(5), -nng_tcp_listener(5), -nng_tcp_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_options.5.html b/man/tip/nng_tcp_options.5.html index 2ff4f66c..8ac7b416 100644 --- a/man/tip/nng_tcp_options.5.html +++ b/man/tip/nng_tcp_options.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tcp_options(5) - + - @@ -655,6 +159,22 @@ middleware from being expiring due to lack of activity. +
+
+
NNG_OPT_TCP_BOUND_PORT
+
+

(int) +This option is available on listeners, after the listern has bound to +a port, and provides the port bound to in native byte order. +This is most useful when using a listener with an ephemeral port +(configured by using port 0 at configuration time), as it allows +the caller to determine the actual ephemeral port that was chosen by the +system. +While the value is of type int, it will be a legal TCP port number, that +is a value between 1 and 65535, inclusive.

+
+
+

Inherited Options

@@ -665,10 +185,10 @@ when appropriate for the context:

@@ -679,17 +199,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/tip/nng_tcp_recv.3tcp.html b/man/tip/nng_tcp_recv.3tcp.html deleted file mode 100644 index 1af27986..00000000 --- a/man/tip/nng_tcp_recv.3tcp.html +++ /dev/null @@ -1,673 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_recv(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_recv(nng_tcp *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_recv() function starts an asynchronous receive from the -TCP connection conn, into the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
- - - - - -
- - -While TCP has the notion of urgent (out-of-band) delivery, that is -used by very few protocols and this API does not support it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_strerror(3), -nng_tcp_close(3tcp), -nng_tcp_send(3tcp), -nng_tcp(5)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_register.3.html b/man/tip/nng_tcp_register.3.html index 2626bc08..208e8d39 100644 --- a/man/tip/nng_tcp_register.3.html +++ b/man/tip/nng_tcp_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tcp_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tcp_send.3tcp.html b/man/tip/nng_tcp_send.3tcp.html deleted file mode 100644 index bdb61222..00000000 --- a/man/tip/nng_tcp_send.3tcp.html +++ /dev/null @@ -1,672 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_send(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-void nng_tcp_send(nng_tcp *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_send() function starts an asynchronous send over the -TCP connection conn from the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
- - - - - -
- - -While TCP has the notion of urgent (out-of-band) delivery, that is -used by very few protocols and this API does not support it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_tcp_close(3tcp), -nng_tcp_recv(3tcp), -nng_tcp(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_tcp_setopt.3tcp.html b/man/tip/nng_tcp_setopt.3tcp.html deleted file mode 100644 index 600165db..00000000 --- a/man/tip/nng_tcp_setopt.3tcp.html +++ /dev/null @@ -1,636 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tcp_setopt(3tcp) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-int nng_tcp_setopt(nng_tcp *conn, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tcp_setopt() is used to set the option name for the -TCP connection conn. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TCP -connections are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_tcp_getopt(3tcp), -nng_options(5), -nng_tcp_options(5), -nng_strerror(3), -nng_tcp(5)

-
-
-
-
- - diff --git a/man/tip/nng_thread_create.3supp.html b/man/tip/nng_thread_create.3supp.html index ac7495be..60e67c17 100644 --- a/man/tip/nng_thread_create.3supp.html +++ b/man/tip/nng_thread_create.3supp.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_thread_create(3supp) - + -

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

@@ -606,9 +110,9 @@ to any system threading functions. The system may impose limits on the number of threads that can be created. -Typically applications should not create more than a few dozen of these. +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. @@ -621,8 +125,8 @@ an asynchronous model using nng_aio structu Threads can be synchronized using -mutexes and -condition variables. +mutexes and +condition variables. @@ -658,15 +162,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/tip/nng_thread_destroy.3supp.html b/man/tip/nng_thread_destroy.3supp.html index b9b4118c..64fbca6c 100644 --- a/man/tip/nng_thread_destroy.3supp.html +++ b/man/tip/nng_thread_destroy.3supp.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_thread_destroy(3supp) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls.5.html b/man/tip/nng_tls.5.html index d6922759..1efb4316 100644 --- a/man/tip/nng_tls.5.html +++ b/man/tip/nng_tls.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls(5) - + -

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

@@ -602,7 +106,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().
@@ -611,25 +115,25 @@ 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.

@@ -643,21 +147,22 @@ accessed using the nng_tls_getopt()SEE ALSO
-

libnng(3), -nng_tls_close(3tls), -nng_tls_dialer_dial(3tls), -nng_tls_free(3tls), -nng_tls_getopt(3tls), -nng_tls_listener_accept(3tls), -nng_tls_recv(3tls), -nng_tls_send(3tls), -nng_tls_setopt(3tls), -nng_options(5), -nng_tls_options(5), -nng(7)

+

libnng(3), +nng_tls_close(3tls), +nng_tls_dialer_dial(3tls), +nng_tls_free(3tls), +nng_tls_getopt(3tls), +nng_tls_listener_accept(3tls), +nng_tls_recv(3tls), +nng_tls_send(3tls), +nng_tls_setopt(3tls), +nng_options(5), +nng_tls_options(5), +nng(7)

+ - + \ No newline at end of file diff --git a/man/tip/nng_tls.7.html b/man/tip/nng_tls.7.html index 8d94daa3..56857f09 100644 --- a/man/tip/nng_tls.7.html +++ b/man/tip/nng_tls.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls(7) - + -
@@ -713,10 +217,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).

@@ -728,34 +232,34 @@ Note that setting these must be done before the transport is started.

@@ -766,17 +270,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/tip/nng_tls_close.3tls.html b/man/tip/nng_tls_close.3tls.html deleted file mode 100644 index 3bedc39d..00000000 --- a/man/tip/nng_tls_close.3tls.html +++ /dev/null @@ -1,615 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_close(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_close(nng_tls *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_close() function closes the supplied TLS connection, conn.

-
-
-

If any operations are pending (such as nng_tls_send() -or nng_tls_recv() they will be terminated with -an NNG_ECLOSED error condition. -Also, any new operations will fail with NNG_ECLOSED after the connection -is closed.

-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -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_tls_free(). -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_free(3tls), -nng_tls_recv(3tls), -nng_tls_send(3tls), -nng_tls(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_config.5.html b/man/tip/nng_tls_config.5.html index d50d6382..02712efd 100644 --- a/man/tip/nng_tls_config.5.html +++ b/man/tip/nng_tls_config.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config(5) - + -

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.

@@ -567,17 +71,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/tip/nng_tls_config_alloc.3tls.html b/man/tip/nng_tls_config_alloc.3tls.html index c28b5bd8..5cd0cbe7 100644 --- a/man/tip/nng_tls_config_alloc.3tls.html +++ b/man/tip/nng_tls_config_alloc.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_alloc(3tls) - + -

Also note that a TLS configuration object becomes “read-only” after it @@ -620,18 +124,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/tip/nng_tls_config_auth_mode.3tls.html b/man/tip/nng_tls_config_auth_mode.3tls.html index 0ebb4d68..0aeee043 100644 --- a/man/tip/nng_tls_config_auth_mode.3tls.html +++ b/man/tip/nng_tls_config_auth_mode.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_auth_mode(3tls) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_ca_chain.3tls.html b/man/tip/nng_tls_config_ca_chain.3tls.html index a00833bf..718a55be 100644 --- a/man/tip/nng_tls_config_ca_chain.3tls.html +++ b/man/tip/nng_tls_config_ca_chain.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_ca_chain(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_ca_file.3tls.html b/man/tip/nng_tls_config_ca_file.3tls.html index c964d226..6f353da2 100644 --- a/man/tip/nng_tls_config_ca_file.3tls.html +++ b/man/tip/nng_tls_config_ca_file.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_ca_file(3tls) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_cert_key_file.3tls.html b/man/tip/nng_tls_config_cert_key_file.3tls.html index f9c2c112..c4c97cd6 100644 --- a/man/tip/nng_tls_config_cert_key_file.3tls.html +++ b/man/tip/nng_tls_config_cert_key_file.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_cert_key_file(3tls) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_free.3tls.html b/man/tip/nng_tls_config_free.3tls.html index a2324ea4..307d3fb7 100644 --- a/man/tip/nng_tls_config_free.3tls.html +++ b/man/tip/nng_tls_config_free.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_free(3tls) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_hold.3tls.html b/man/tip/nng_tls_config_hold.3tls.html index 3ebbccc2..7d8dd212 100644 --- a/man/tip/nng_tls_config_hold.3tls.html +++ b/man/tip/nng_tls_config_hold.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_hold(3tls) - + -

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 @@ -576,12 +80,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/tip/nng_tls_config_own_cert.3tls.html b/man/tip/nng_tls_config_own_cert.3tls.html index 1ffc5d3f..e4c4a38d 100644 --- a/man/tip/nng_tls_config_own_cert.3tls.html +++ b/man/tip/nng_tls_config_own_cert.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_own_cert(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_config_server_name.3tls.html b/man/tip/nng_tls_config_server_name.3tls.html index de9120a1..c8d928c9 100644 --- a/man/tip/nng_tls_config_server_name.3tls.html +++ b/man/tip/nng_tls_config_server_name.3tls.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_config_server_name(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_dialer.5.html b/man/tip/nng_tls_dialer.5.html deleted file mode 100644 index 457b1605..00000000 --- a/man/tip/nng_tls_dialer.5.html +++ /dev/null @@ -1,594 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-typedef struct nng_tls_dialer_s nng_tls_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_tls_dialer is a handle to a TLS “dialer”, which is responsible for -creating connections (nng_tls objects) by connecting to -remote systems.

-
-
- - - - - -
- - -The nng_tls_dialer object is used for raw IPC connections, and -should not be confused with a dialer object created using the -nng_tls(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_tls(7) transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_tls_dialer_alloc(3tls), -nng_tls_dialer_close(3tls), -nng_tls_dialer_dial(3tls), -nng_tls_dialer_free(3tls), -nng_tls(5), -nng_tls_listener(5), -nng_tls_options(5), -nng_tls(7)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_alloc.3tls.html b/man/tip/nng_tls_dialer_alloc.3tls.html deleted file mode 100644 index 61021f26..00000000 --- a/man/tip/nng_tls_dialer_alloc.3tls.html +++ /dev/null @@ -1,600 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_alloc(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_dialer_alloc(nng_tls_dialer *dp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_alloc() allocates a TLS dialer, which can be used -to create outgoing connections over TLS, and stores a pointer to it -it in the location referenced by dp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_ENOTSUP - -

TLS support not configured in library.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_close(3tls), -nng_tls_dialer_dial(3tls), -nng_tls_dialer_free(3tls), -nng_tls_dialer_getopt(3tls), -nng_tls_dialer_setopt(3tls), -nng_tls_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_close.3tls.html b/man/tip/nng_tls_dialer_close.3tls.html deleted file mode 100644 index 86e23e38..00000000 --- a/man/tip/nng_tls_dialer_close.3tls.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_close(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_dialer_close(nng_tls_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_close() function closes the supplied TCP dialer d, -but does not free the underlying resources associated with it.

-
-
-

If any dial operations using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the dialer d will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the dialer, so the -application should still free the memory using -nng_tls_dialer_free() -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_alloc(3tls), -nng_tls_dialer_dial(3tls), -nng_tls_dialer_free(3tls), -nng_tls_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_dial.3tls.html b/man/tip/nng_tls_dialer_dial.3tls.html deleted file mode 100644 index 8086b01f..00000000 --- a/man/tip/nng_tls_dialer_dial.3tls.html +++ /dev/null @@ -1,650 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_dial(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_dialer_dial(nng_tls_dialer *d, const nng_sockaddr *sa, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_dial() attempts to establish a TLS connection to the -remote peer identified by sa, using the dialer d. -The operation is completed asynchronously, using aio.

-
-
-

The address sa must be in the NNG_AF_INET or NNG_AF_INET6 families, -and have a valid IPv4 or IPv6 address and TCP port number.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_tls stored as its first output. -(See nng_aio_get_output().)

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_EADDRINVAL - -

The address specified is invalid.

-
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_ECONNREFUSED - -

The connection was refused by the server.

-
-NNG_ECONNRESET - -

The connection was reset by the server.

-
-NNG_ECRYPTO - -

Cryptographic or certificate validation error.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_alloc(3tls), -nng_tls_dialer_close(3tls), -nng_tls_dialer_free(3tls), -nng_aio(5), -nng_sockaddr(5), -nng_tls(5), -nng_tls_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_free.3tls.html b/man/tip/nng_tls_dialer_free.3tls.html deleted file mode 100644 index 99e968ee..00000000 --- a/man/tip/nng_tls_dialer_free.3tls.html +++ /dev/null @@ -1,597 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_free(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_dialer_free(nng_tls_dialer *d);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_free() function closes the supplied TLS dialer d, -and frees the underlying resources associated with it.

-
-
-

If any dial operations using d are -in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to d, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_alloc(3tls), -nng_tls_dialer_close(3tls), -nng_tls_dialer_dial(3tls), -nng_tls_dialer(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_getopt.3tls.html b/man/tip/nng_tls_dialer_getopt.3tls.html deleted file mode 100644 index 3e117cc1..00000000 --- a/man/tip/nng_tls_dialer_getopt.3tls.html +++ /dev/null @@ -1,651 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_getopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_getopt(nng_tls_dialer *d, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_getopt() is used to retrieve the value of the option name -for the TLS dialer d. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TLS dialers are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_setopt(3tls), -nng_tls_getopt(3tls), -nng_options(5), -nng_tcp_options(5), -nng_tls(5), -nng_tls_config(5), -nng_tls_dialer(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_dialer_setopt.3tls.html b/man/tip/nng_tls_dialer_setopt.3tls.html deleted file mode 100644 index b40f740d..00000000 --- a/man/tip/nng_tls_dialer_setopt.3tls.html +++ /dev/null @@ -1,656 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_dialer_setopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_dialer_setopt(nng_tls_dialer *d, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_dialer_setopt() is used to set the option name for the -TLS dialer d. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TLS dialers are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_dialer_getopt(3tls), -nng_tls_setopt(3tls), -nng_options(5), -nng_tcp_options(5), -nng_tls(5), -nng_tls_dialer(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_free.3tls.html b/man/tip/nng_tls_free.3tls.html deleted file mode 100644 index 734a6e5d..00000000 --- a/man/tip/nng_tls_free.3tls.html +++ /dev/null @@ -1,613 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_free(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_free(nng_tls *conn);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_free() function closes the supplied TLS connection, conn, -and frees the underlying resources associated with it.

-
-
-

If any operations are pending (such as nng_tls_send() -or nng_tls_recv() they will be terminated with -an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to conn, as the memory backing it will be reclaimed for other uses. -
-
-
- - - - - -
- - -Closing the connection while data is in transmission will likely -lead to loss of that data. -There is no automatic linger or flush to ensure that the socket send buffers -have completely transmitted. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_close(3tls), -nng_tls_recv(3tls), -nng_tls_send(3tls), -nng_tls(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_getopt.3tls.html b/man/tip/nng_tls_getopt.3tls.html deleted file mode 100644 index fe61ed5c..00000000 --- a/man/tip/nng_tls_getopt.3tls.html +++ /dev/null @@ -1,651 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_getopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_getopt(nng_tls *conn, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_getopt() is used to retrieve the value of the option name for -the TLS connection conn. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TLS connections are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_setopt(3tls), -nng_options(5), -nng_tcp_options(5), -nng_tlsp(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener.5.html b/man/tip/nng_tls_listener.5.html deleted file mode 100644 index cac301c1..00000000 --- a/man/tip/nng_tls_listener.5.html +++ /dev/null @@ -1,596 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener(5) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-typedef struct nng_tls_dialer_s nng_tls_dialer;
-
-
-
-
-
-

DESCRIPTION

-
-
-

-An nng_tls_listener is a handle to a TLS “listener”, which is responsible -for accepting connections (nng_tls objects) from remote -systems.

-
-
- - - - - -
- - -The nng_tls_listener object is used for raw TLS over TCP connections, and -should not be confused with a listener object created using the -nng_tls(7) transport. -
-
-
- - - - - -
- - -Most NNG applications should not use this, but instead use the -nng_tls(7) transport instead. -
-
-
-
-
-

SEE ALSO

-
-
-

nng_tls_listener_accept(3tls), -nng_tls_listener_alloc(3tls), -nng_tls_listener_close(3tls), -nng_tls_listener_free(3tls), -nng_tls_listener_getopt(3tls), -nng_tls_listener_listen(3tls), -nng_tls_listener_setopt(3tls), -nng_tls(5), -nng_tls_dialer(5), -nng_tls(7)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_accept.3tls.html b/man/tip/nng_tls_listener_accept.3tls.html deleted file mode 100644 index 12a3909e..00000000 --- a/man/tip/nng_tls_listener_accept.3tls.html +++ /dev/null @@ -1,642 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_accept(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_listener_accept(nng_tls_listener *l, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_accept() attempts to accept an incoming TLS connection -from a remote peer, using the listener l. -The operation is completed asynchronously, using aio.

-
-
-

This operation can only be done after the listener is already bound to -a TCP port and is listening.

-
-
-

If a connection is successfully established, the aio will have the -resulting nng_tls stored as its first output. -(See nng_aio_get_output().)

-
-
-

The address of the remote peer can be determined using the -NNG_OPT_REMADDR option with the -nng_tls_getopt() function on the -returned nng_tls.

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was aborted.

-
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_ECONNRESET - -

The connection was reset by the peer.

-
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_ESTATE - -

The listener is not not listening.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_alloc(3tls), -nng_tls_listener_close(3tls), -nng_tls_listener_free(3tls), -nng_tls_listener_listen(3tls), -nng_aio(5), -nng_tls(5), -nng_options(5), -nng_tls_listener(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_alloc.3tls.html b/man/tip/nng_tls_listener_alloc.3tls.html deleted file mode 100644 index 7023e05d..00000000 --- a/man/tip/nng_tls_listener_alloc.3tls.html +++ /dev/null @@ -1,601 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_alloc(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_listener_alloc(nng_tls_listener *lp);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_alloc() allocates a TLS listener, which can be used -to accept incoming connections over TLS, and stores a pointer to it -it in the location referenced by lp.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - -
-NNG_ENOMEM - -

Insufficient free memory exists.

-
-NNG_ENOTSUP - -

TLS support not configured in library.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_accept(3tls), -nng_tls_listener_close(3tls), -nng_tls_listener_free(3tls), -nng_tls_listener_getopt(3tls), -nng_tls_listener_listen(3tls), -nng_tls_listener_setopt(3tls), -nng_tls_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_close.3tls.html b/man/tip/nng_tls_listener_close.3tls.html deleted file mode 100644 index 8a12da29..00000000 --- a/man/tip/nng_tls_listener_close.3tls.html +++ /dev/null @@ -1,603 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_close(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_listener_close(nng_tls_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_close() function closes the supplied TLS listener l, -but does not free the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
-

Furthermore any future accesses to the listener l will also result in -NNG_ECLOSED.

-
-
- - - - - -
- - -This function does not release the memory for the listener, so the -application should still free the memory using -nng_tls_listener_free() -once it is certain that nothing else is using it. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_alloc(3tls), -nng_tls_listener_accept(3tls), -nng_tls_listener_free(3tls), -nng_tls_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_free.3tls.html b/man/tip/nng_tls_listener_free.3tls.html deleted file mode 100644 index 4efd7b28..00000000 --- a/man/tip/nng_tls_listener_free.3tls.html +++ /dev/null @@ -1,596 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_free(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_listener_free(nng_tls_listener *l);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_free() function closes the supplied TLS listener l, -and frees the underlying resources associated with it.

-
-
-

If any accept operations using l -are in progress, they will be terminated with an NNG_ECLOSED error condition.

-
-
- - - - - -
- - -It is important that the application ensure that no further accesses -are made to l, as the memory backing it will be reclaimed for other uses. -
-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
-

None.

-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_alloc(3tls), -nng_tls_listener_close(3tls), -nng_tls_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_getopt.3tls.html b/man/tip/nng_tls_listener_getopt.3tls.html deleted file mode 100644 index 1a619f9c..00000000 --- a/man/tip/nng_tls_listener_getopt.3tls.html +++ /dev/null @@ -1,650 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_getopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_listener_getopt(nng_tls_listener *l, const char *name, void *data, size_t *sizep);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_getopt() is used to retrieve the value of the option -name for the TLS listener l. -The size of the buffer located at data to receive the copy is passed by the -caller at the location referenced by sizep. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by data. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of sizep.

-
-
-

Options

-
-

The options specifically suppported for retrieval from TLS listeners are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The dialer is closed.

-
-NNG_EINVAL - -

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

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EWRITEONLY - -

The option name may not read.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_setopt(3tls), -nng_tls_getopt(3tls), -nng_options(5), -nng_tcp_options(5), -nng_tls(5), -nng_tls_listener(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_listen.3tls.html b/man/tip/nng_tls_listener_listen.3tls.html deleted file mode 100644 index cdd2b769..00000000 --- a/man/tip/nng_tls_listener_listen.3tls.html +++ /dev/null @@ -1,646 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_listen(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_listener_listen(nng_tls_listener l, const nng_sockaddr *sa);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_listen() attempts to bind the listener l -to the local address specified by sa, which must be in the -NNG_AF_INET or NNG_AF_INET6 address family.

-
-
-

This also sets the underlying port into passive mode, ready to -accept an incoming connection, and established a listen queue -for receiving incoming connections. (The queue depth is system -specific, but typically 128.)

-
-
-

The actual IPv4 or IPv6 address in sa may refer either to a locally -configured interface address, or to a zero-valued adddress to indicate -that all interfaces on the system should be bound.

-
-
-

The TCP port number may also be zero. In this case the system will -choose a free TCP port at random, and use it.

-
-
-

The chosen port number may be retrieved using the -NNG_OPT_LOCADDR option with the -nng_tls_listener_getopt() function.

-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - -
-NNG_EADDRINUSE - -

The address specified by sa is already in use.

-
-NNG_EADDRINVAL - -

The address specified by sa is invalid or unavailable.

-
-NNG_ECLOSED - -

The listener l has been closed.

-
-NNG_ECRYPTO - -

Cryptographic or certificate error.

-
-NNG_ESTATE - -

The listener l is already bound.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_accept(3tls), -nng_tls_listener_alloc(3tls), -nng_tls_listener_close(3tls), -nng_tls_listener_free(3tls), -nng_tls_listener_getopt(3tls), -nng_options(5), -nng_sockaddr(5), -nng_tls_listener(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_listener_setopt.3tls.html b/man/tip/nng_tls_listener_setopt.3tls.html deleted file mode 100644 index 73243aed..00000000 --- a/man/tip/nng_tls_listener_setopt.3tls.html +++ /dev/null @@ -1,652 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_listener_setopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_listener_setopt(nng_tls_listener *l, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_listener_setopt() is used to set the option name for the -TLS listener l. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TLS listeners are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The listener is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_listener_getopt(3tls), -nng_tls_setopt(3tls), -nng_options(5), -nng_tls(5), -nng_tls_listener(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_options.5.html b/man/tip/nng_tls_options.5.html index 6797dd30..961189c1 100644 --- a/man/tip/nng_tls_options.5.html +++ b/man/tip/nng_tls_options.5.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_options(5) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_recv.3tls.html b/man/tip/nng_tls_recv.3tls.html deleted file mode 100644 index 5ecbd612..00000000 --- a/man/tip/nng_tls_recv.3tls.html +++ /dev/null @@ -1,668 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_recv(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_recv(nng_tls *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_recv() function starts an asynchronous receive from the -TLS connection conn, into the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECRYPTO - -

Cryptographic or certificate error.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_strerror(3), -nng_tls_close(3tls), -nng_tls_send(3tls), -nng_tls(5)

-
-
-
-
- - diff --git a/man/tip/nng_tls_register.3.html b/man/tip/nng_tls_register.3.html index 1d6a48e4..7639e01c 100644 --- a/man/tip/nng_tls_register.3.html +++ b/man/tip/nng_tls_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_tls_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_tls_send.3tls.html b/man/tip/nng_tls_send.3tls.html deleted file mode 100644 index abaf3e3a..00000000 --- a/man/tip/nng_tls_send.3tls.html +++ /dev/null @@ -1,667 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_send(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-void nng_tls_send(nng_tls *conn, nng_aio *aio);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_send() function starts an asynchronous send over the -TLS connection conn from the scatter/gather vector located in the -asynchronous I/O structure aio.

-
-
- - - - - -
- - -The nng_aio_set_iov() function must have been -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(). -That result will either be zero or an error code.

-
-
-

The I/O operation completes as soon as at least one byte has been -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().

-
-
-
-
-

RETURN VALUES

-
-
-

None.

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NNG_ECANCELED - -

The operation was canceled.

-
-NNG_ECLOSED - -

The connection was closed.

-
-NNG_ECONNRESET - -

The peer closed the connection.

-
-NNG_ECRYPTO - -

Cryptographic or certificate error.

-
-NNG_EINVAL - -

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

-
-NNG_ENOMEM - -

Insufficient free memory to perform the operation.

-
-NNG_ETIMEDOUT - -

Timeout waiting for data from the connection.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_aio_alloc(3), -nng_aio_count(3), -nng_aio_result(3), -nng_aio_set_iov(3), -nng_tls_close(3tls), -nng_tls_recv(3tls), -nng_tls(5), -nng_strerror(3)

-
-
-
-
- - diff --git a/man/tip/nng_tls_setopt.3tls.html b/man/tip/nng_tls_setopt.3tls.html deleted file mode 100644 index d866e51e..00000000 --- a/man/tip/nng_tls_setopt.3tls.html +++ /dev/null @@ -1,636 +0,0 @@ ---- -version: tip -layout: refman ---- - - - - - - - -nng_tls_setopt(3tls) - - - - - - - -
-
-

SYNOPSIS

-
-
-
-
#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_setopt(nng_tls *conn, const char *name, const void *data, size_t size);
-
-
-
-
-
-

DESCRIPTION

-
-
-

The nng_tls_setopt() is used to set the option name for the -TLS connection conn. -The value to set is copied from data, which should be size bytes -in length.

-
-
-

Options

-
-

The options specifically suppported for modification on TLS connections are:

-
-
- -
-
-
-
-
-

RETURN VALUES

-
-
-

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

-
-
-
-
-

ERRORS

-
-
- - - - - - - - - - - - - - - - - -
-NNG_ECLOSED - -

The connection conn is closed.

-
-NNG_EINVAL - -

Either data or size are invalid.

-
-NNG_ENOTSUP - -

The option name is not supported.

-
-NNG_EREADONLY - -

The option name may not be modified.

-
-
-
-
-
-

SEE ALSO

-
-
-

nng_strerror(3), -nng_tls_getopt(3tls), -nng_options(5), -nng_tcp_options(5), -nng_tls(5), -nng_tls_options(5)

-
-
-
-
- - diff --git a/man/tip/nng_url_clone.3.html b/man/tip/nng_url_clone.3.html index a907b9e3..9ecd46c4 100644 --- a/man/tip/nng_url_clone.3.html +++ b/man/tip/nng_url_clone.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_url_clone(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_url_free.3.html b/man/tip/nng_url_free.3.html index 6df08968..1685501c 100644 --- a/man/tip/nng_url_free.3.html +++ b/man/tip/nng_url_free.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_url_free(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_url_parse.3.html b/man/tip/nng_url_parse.3.html index d8f57a1a..a0754873 100644 --- a/man/tip/nng_url_parse.3.html +++ b/man/tip/nng_url_parse.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_url_parse(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_ws.7.html b/man/tip/nng_ws.7.html index 13af5508..80d52ca6 100644 --- a/man/tip/nng_ws.7.html +++ b/man/tip/nng_ws.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_ws(7) - + -
@@ -621,10 +125,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).

@@ -696,7 +200,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.

@@ -719,7 +223,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
@@ -727,13 +231,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
@@ -751,14 +255,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/tip/nng_ws_register.3.html b/man/tip/nng_ws_register.3.html index d55c09ae..49eb988d 100644 --- a/man/tip/nng_ws_register.3.html +++ b/man/tip/nng_ws_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_ws_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nng_wss_register.3.html b/man/tip/nng_wss_register.3.html index bb220928..5cea8f65 100644 --- a/man/tip/nng_wss_register.3.html +++ b/man/tip/nng_wss_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_wss_register(3) - + -

NAME

-

nng_ws_register - register WebSocket secure transport

+

nng_wss_register - register WebSocket secure transport

@@ -583,11 +87,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/tip/nng_zerotier.7.html b/man/tip/nng_zerotier.7.html index ce6c7c19..d89d8a62 100644 --- a/man/tip/nng_zerotier.7.html +++ b/man/tip/nng_zerotier.7.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_zerotier(7) - + -

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.

@@ -793,7 +297,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.

@@ -816,7 +320,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.

@@ -873,11 +377,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/tip/nng_zt_register.3.html b/man/tip/nng_zt_register.3.html index dd1da5b1..aab243e7 100644 --- a/man/tip/nng_zt_register.3.html +++ b/man/tip/nng_zt_register.3.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nng_zt_register(3) - + - + - + \ No newline at end of file diff --git a/man/tip/nngcat.1.html b/man/tip/nngcat.1.html index 3b54faf9..6d3b4baa 100644 --- a/man/tip/nngcat.1.html +++ b/man/tip/nngcat.1.html @@ -1,510 +1,14 @@ ---- -version: tip -layout: refman ---- - + - + nngcat(1) - + - + - + \ No newline at end of file diff --git a/man/tip/pygments-default.css b/man/tip/pygments-default.css new file mode 100644 index 00000000..16d4c78e --- /dev/null +++ b/man/tip/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