diff options
| author | Jake Woltersdorf <jake@playruyi.com> | 2019-03-04 12:35:19 +0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-04-07 19:13:44 -0700 |
| commit | c3e062661388f70386d6766e3ce648030af340ee (patch) | |
| tree | a6d247bd24a17e3201a75b1a164e75d16e37196c /docs/man/libnng.3.adoc | |
| parent | 989c5e90d48066b12ad44ed903cfc163d8e89b29 (diff) | |
| download | nng-c3e062661388f70386d6766e3ce648030af340ee.tar.gz nng-c3e062661388f70386d6766e3ce648030af340ee.tar.bz2 nng-c3e062661388f70386d6766e3ce648030af340ee.zip | |
fixes #901 shorter option get/set functions for all types
- Renamed internal nng_*_getx/setx methods with "nni" prefix
- Moved stream get/set option definition macros to options.h and added "NNI_" prefix
- "_PTR" variant of get/set option definition macros is for when first arg is passed as pointer (`nng_stream *s` vs `nng_pipe s`)
- New get/set option functions for `nng_socket` are `nng_socket_get_X` eschewing the previous `nng_getopt` pattern
- Macro-fy legacy getopt/setopt and implement in terms of "new" API
- nng_setopt* use "new" shorter API. Add missing uint64 set functions.
- Shorter get/set option functions get own man page and old getopt/setopt link to them
- Built with -DNNG_ENABLE_DOC=ON and part of central libnng index
- Update copyright
Diffstat (limited to 'docs/man/libnng.3.adoc')
| -rw-r--r-- | docs/man/libnng.3.adoc | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index 3aebcf76..bf2a602d 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -50,7 +50,9 @@ The following functions operate on sockets. |xref:nng_recv.3.adoc[nng_recv()]|receive data |xref:nng_send.3.adoc[nng_send()]|send data |xref:nng_setopt.3.adoc[nng_setopt()]|set socket option +|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 |=== === Connection Management @@ -62,19 +64,24 @@ Listeners accept incoming connection requests, and dialers make them. |xref:nng_dial.3.adoc[nng_dial()]|create and start dialer |xref:nng_dialer_close.3.adoc[nng_dialer_close()]|close dialer |xref:nng_dialer_create.3.adoc[nng_dialer_create()]|create dialer +|xref:nng_dialer_get.3.adoc[nng_dialer_get()]|get dialer option |xref:nng_dialer_getopt.3.adoc[nng_dialer_getopt()]|get dialer option |xref:nng_dialer_id.3.adoc[nng_dialer_id()]|get numeric dialer identifier +|xref:nng_dialer_set.3.adoc[nng_dialer_set()]|set dialer option |xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt()]|set dialer option |xref:nng_dialer_start.3.adoc[nng_dialer_start()]|start dialer |xref:nng_listen.3.adoc[nng_listen()]|create and start listener |xref:nng_listener_close.3.adoc[nng_listener_close()]|close listener |xref:nng_listener_create.3.adoc[nng_listener_create()]|create listener +|xref:nng_listener_get.3.adoc[nng_listener_get()]|get listener option |xref:nng_listener_getopt.3.adoc[nng_listener_getopt()]|get listener option |xref:nng_listener_id.3.adoc[nng_listener_id()]|get numeric listener identifier +|xref:nng_listener_set.3.adoc[nng_listener_set()]|set listener option |xref:nng_listener_setopt.3.adoc[nng_listener_setopt()]|set listener option |xref:nng_listener_start.3.adoc[nng_listener_start()]|start listener |xref:nng_pipe_close.3.adoc[nng_pipe_close()]|close pipe |xref:nng_pipe_dialer.3.adoc[nng_pipe_dialer()]|return dialer that created pipe +|xref:nng_pipe_get.3.adoc[nng_pipe_get()]|get pipe option |xref:nng_pipe_getopt.3.adoc[nng_pipe_getopt()]|get pipe option |xref:nng_pipe_id.3.adoc[nng_pipe_id()]|get numeric pipe identifier |xref:nng_pipe_listener.3.adoc[nng_pipe_listener()]|return listener that created pipe @@ -215,11 +222,13 @@ concurrent applications. |=== |xref:nng_ctx_close.3.adoc[nng_ctx_close()]|close context +|xref:nng_ctx_get.3.adoc[nng_ctx_get()]|get context option |xref:nng_ctx_getopt.3.adoc[nng_ctx_getopt()]|get context option |xref:nng_ctx_id.3.adoc[nng_ctx_id()]|get numeric context identifier |xref:nng_ctx_open.3.adoc[nng_ctx_open()]|create context |xref:nng_ctx_recv.3.adoc[nng_ctx_recv()]|receive message using context asynchronously |xref:nng_ctx_send.3.adoc[nng_ctx_send()]|send message using context asynchronously +|xref:nng_ctx_set.3.adoc[nng_ctx_set()]|set context option |xref:nng_ctx_setopt.3.adoc[nng_ctx_setopt()]|set context option |=== |
