From bbb0f13f783789cfd8e6e39cc64a2de564dd2c46 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 31 Dec 2024 14:11:49 -0800 Subject: docs: clean up some old stuff --- docs/man/libnng.3.adoc | 162 ++----------------------------------------------- 1 file changed, 4 insertions(+), 158 deletions(-) (limited to 'docs/man/libnng.3.adoc') diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index 9cef1e0f..e49aa0a1 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -15,46 +15,18 @@ libnng - nanomsg next generation library -== SYNOPSIS - -*cc* [_flags_] _files_ *-lnng* [_libraries_] - -== DESCRIPTION - -xref:nng.7.adoc[_NNG_] provides a common messaging framework -intended to solve common communication problems in distributed applications. - -It provides a C language API. - - === Socket Functions The following functions operate on sockets. |=== -|xref:nng_socket_close.3.adoc[nng_socket_close()]|close socket |xref:nng_dial.3.adoc[nng_dial()]|create and start dialer |xref:nng_get.3.adoc[nng_get()]|get socket option |xref:nng_listen.3.adoc[nng_listen()]|create and start listener |xref:nng_recv.3.adoc[nng_recv()]|receive data |xref:nng_send.3.adoc[nng_send()]|send data |xref:nng_socket_get.3.adoc[nng_socket_get()]|get socket option -|xref:nng_socket_id.3.adoc[nng_socket_id()]|get numeric socket identifier |xref:nng_socket_set.3.adoc[nng_socket_set()]|set socket option |=== @@ -98,21 +70,6 @@ user-payload and the header carries protocol specific header information. Most applications will only interact with the body. |=== -// |xref:nng_msg_alloc.3.adoc[nng_msg_alloc()]|allocate a message -// |xref:nng_msg_append.3.adoc[nng_msg_append()]|append to message body -// |xref:nng_msg_body.3.adoc[nng_msg_body()]|return message body -// |xref:nng_msg_capacity.3.adoc[nng_msg_capacity()]|return capacity allocated for message body -// |xref:nng_msg_chop.3.adoc[nng_msg_chop()]|remove data from end of message body -// |xref:nng_msg_clear.3.adoc[nng_msg_clear()]|clear message body -// |xref:nng_msg_dup.3.adoc[nng_msg_dup()]|duplicate a message -// |xref:nng_msg_free.3.adoc[nng_msg_free()]|free a message -// |xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe()]|get pipe for message -// |xref:nng_msg_insert.3.adoc[nng_msg_insert()]|prepend to message body -// |xref:nng_msg_len.3.adoc[nng_msg_len()]|return the message body length -// |xref:nng_msg_realloc.3.adoc[nng_msg_realloc()]|reallocate a message -// |xref:nng_msg_reserve.3.adoc[nng_msg_reserve()]|reserve storage for message body -// |xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe()]|set pipe for message -// |xref:nng_msg_trim.3.adoc[nng_msg_trim()]|remove data from start of message body |xref:nng_recvmsg.3.adoc[nng_recvmsg()]|receive a message |xref:nng_sendmsg.3.adoc[nng_sendmsg()]|send a message |=== @@ -158,48 +115,15 @@ Only a single asynchronous operation may be associated with an The following functions are used in the asynchronous model: |=== -// |xref:nng_aio_abort.3.adoc[nng_aio_abort()]|abort asynchronous I/O operation -// |xref:nng_aio_alloc.3.adoc[nng_aio_alloc()]|allocate asynchronous I/O handle |xref:nng_aio_reset.3.adoc[nng_aio_reset()]|reset asynchronous I/O operation -// |xref:nng_aio_busy.3.adoc[nng_aio_busy()]|test if asynchronous I/O is busy -// |xref:nng_aio_cancel.3.adoc[nng_aio_cancel()]|cancel asynchronous I/O operation -// |xref:nng_aio_count.3.adoc[nng_aio_count()]|return number of bytes transferred |xref:nng_aio_start.3.adoc[nng_aio_start()]|start asynchronous I/O operation |xref:nng_aio_finish.3.adoc[nng_aio_finish()]|finish asynchronous I/O operation -// |xref:nng_aio_free.3.adoc[nng_aio_free()]|free asynchronous I/O handle |xref:nng_aio_get_input.3.adoc[nng_aio_get_input()]|return input parameter -// |xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg()]|get message from an asynchronous receive -// |xref:nng_aio_get_output.3.adoc[nng_aio_get_output()]|return output result -// |xref:nng_aio_free.3.adoc[nng_aio_reap()]|reap asynchronous I/O handle -// |xref:nng_aio_result.3.adoc[nng_aio_result()]|return result of asynchronous operation -// |xref:nng_aio_set_input.3.adoc[nng_aio_set_input()]|set input parameter -// |xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov()]|set scatter/gather vector -// |xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg()]|set message for an asynchronous send |xref:nng_aio_set_output.3.adoc[nng_aio_set_output()]|set output result -// |xref:nng_aio_set_timeout.3.adoc[nng_aio_set_timeout()]|set asynchronous I/O timeout -// |xref:nng_aio_stop.3.adoc[nng_aio_stop()]|stop asynchronous I/O operation -// |xref:nng_aio_wait.3.adoc[nng_aio_wait()]|wait for asynchronous I/O operation |xref:nng_recv_aio.3.adoc[nng_recv_aio()]|receive message asynchronously |xref:nng_send_aio.3.adoc[nng_send_aio()]|send message asynchronously -// |xref:nng_sleep_aio.3.adoc[nng_sleep_aio()]|sleep asynchronously |=== -=== Protocols - -The following functions are used to construct a socket with a specific protocol: - -|=== -|xref:nng_bus_open.3.adoc[nng_bus_open()]|open a bus socket -|xref:nng_pair_open.3.adoc[nng_pair_open()]|open a pair socket -|xref:nng_pub_open.3.adoc[nng_pub_open()]|open a pub socket -|xref:nng_pull_open.3.adoc[nng_pull_open()]|open a pull socket -|xref:nng_push_open.3.adoc[nng_push_open()]|open a push socket -|xref:nng_rep_open.3.adoc[nng_rep_open()]|open a rep socket -|xref:nng_req_open.3.adoc[nng_req_open()]|open a req socket -|xref:nng_respondent_open.3.adoc[nng_respondent_open()]|open a respondent socket -|xref:nng_sub_open.3.adoc[nng_sub_open()]|open a sub socket -|xref:nng_surveyor_open.3.adoc[nng_surveyor_open()]|open a surveyor socket -|=== === Protocol Contexts @@ -229,94 +153,16 @@ that route messages from one socket to another. |xref:nng_device.3.adoc[nng_device()]|message forwarding device |=== -// === Statistics - -// The following functions provide access to statistics which can be used -// to observe program behaviors and as an aid in troubleshooting. - -// |=== -// |xref:nng_stat_bool.3.adoc[nng_stat_bool()]|get statistic Boolean value -// |xref:nng_stat_child.3.adoc[nng_stat_child()]|get child statistic -// |xref:nng_stat_desc.3.adoc[nng_stat_name()]|get statistic description -// |xref:nng_stat_find.3.adoc[nng_stat_find()]|find statistic by name -// |xref:nng_stat_find_dialer.3.adoc[nng_stat_find_dialer()]|find dialer statistics -// |xref:nng_stat_find_listener.3.adoc[nng_stat_find_listener()]|find listener statistics -// |xref:nng_stat_find_socket.3.adoc[nng_stat_find_socket()]|find socket statistics -// |xref:nng_stat_name.3.adoc[nng_stat_name()]|get statistic name -// |xref:nng_stat_next.3.adoc[nng_stat_next()]|get next statistic -// |xref:nng_stat_string.3.adoc[nng_stat_string()]|get statistic string value -// |xref:nng_stat_timestamp.3.adoc[nng_stat_timestamp()]|get statistic timestamp -// |xref:nng_stat_type.3.adoc[nng_stat_type()]|get statistic type -// |xref:nng_stat_unit.3.adoc[nng_stat_unit()]|get statistic unit -// |xref:nng_stat_value.3.adoc[nng_stat_value()]|get statistic numeric value -// |xref:nng_stats_free.3.adoc[nng_stats_free()]|free statistics -// |xref:nng_stats_get.3.adoc[nng_stats_get()]|get statistics -// |=== - -// === URL Object - -// Common functionality is supplied for parsing and handling -// universal resource locators (URLS). - -// |=== -// |xref:nng_url_clone.3.adoc[nng_url_clone()]|clone URL structure -// |xref:nng_url_free.3.adoc[nng_url_free()]|free URL structure -// |xref:nng_url_parse.3.adoc[nng_url_parse()]|create URL structure from string -// |=== - -// === Logging Support - -// Common functionality for message logging. - -// |=== -// |xref:nng_log.3.adoc[nng_log()]|log a message -// |xref:nng_log_facility.3.adoc[nng_log_set_facility()]|set log facility -// |xref:nng_log_level.3.adoc[nng_log_set_level()]|set log level -// |xref:nng_log_logger.3.adoc[nng_log_set_logger()]|set logging handler -// |=== - -// === Supplemental API - -// NOTE: All these functions have been moved to new mdbook docs. - -// These supplemental functions are not intrinsic to building -// network applications with _NNG_, but they are made available -// as a convenience to aid in creating portable applications. -// -// |=== -// |xref:nng_clock.3supp.adoc[nng_clock()]|get time -// |xref:nng_cv_alloc.3supp.adoc[nng_cv_alloc()]|allocate condition variable -// |xref:nng_cv_free.3supp.adoc[nng_cv_free()]|free condition variable -// |xref:nng_cv_until.3supp.adoc[nng_cv_until()]|wait for condition or timeout -// |xref:nng_cv_wait.3supp.adoc[nng_cv_wait()]|wait for condition -// |xref:nng_cv_wake.3supp.adoc[nng_cv_wake()]|wake all waiters -// |xref:nng_cv_wake1.3supp.adoc[nng_cv_wake1()]|wake one waiter -// |xref:nng_id_map.3supp.adoc[nng_id_map]|identifier based mapping table -// |xref:nng_msleep.3supp.adoc[nng_msleep()]|sleep for milliseconds -// |xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc()]|allocate mutex -// |xref:nng_mtx_free.3supp.adoc[nng_mtx_free()]|free mutex -// |xref:nng_mtx_lock.3supp.adoc[nng_mtx_lock()]|lock mutex -// |xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock()]|unlock mutex -// |xref:nng_opts_parse.3supp.adoc[nng_opts_parse()]|parse command line options -// |xref:nng_random.3supp.adoc[nng_random()]|get random number -// |xref:nng_socket_pair.3supp.adoc[nng_socket_pair()]|create connected pair of BSD sockets -// |xref:nng_thread_create.3supp.adoc[nng_thread_create()]|create thread -// |xref:nng_thread_destroy.3supp.adoc[nng_thread_destroy()]|reap thread -// |xref:nng_thread_set_name.3supp.adoc[nng_thread_set_name()]|set thread name -// |=== - === Byte Streams These functions are available for use with byte streams. They are considered low-level, for uses where the higher level functions using Scalability Protocols are inappropriate. -Byte streams, represented by -xref:nng_stream.5.adoc[`nng_stream`] objects, correspond to underlying -connections such as TCP connections or named pipes. -They are created by either -xref:nng_stream_dialer.5.adoc[`nng_stream_dialer`] or -xref:nng_stream_listener.5.adoc[`nng_stream_listener`] objects. +|=== +|xref:nng_stream_dialer.5.adoc[`nng_stream_dialer`] or +|xref:nng_stream_listener.5.adoc[`nng_stream_listener`] objects. +|=== |=== |xref:nng_stream_close.3str.adoc[nng_stream_close()]|close byte stream -- cgit v1.2.3-70-g09d2