diff options
| -rw-r--r-- | docs/libnng.adoc | 114 | ||||
| -rw-r--r-- | docs/nng.adoc | 48 | ||||
| -rw-r--r-- | docs/nng_bus.adoc | 12 | ||||
| -rw-r--r-- | docs/nng_close.adoc | 14 | ||||
| -rw-r--r-- | docs/nng_inproc.adoc | 12 | ||||
| -rw-r--r-- | docs/nng_ipc.adoc | 12 | ||||
| -rw-r--r-- | docs/nng_pair.adoc | 22 | ||||
| -rw-r--r-- | docs/nng_pub.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_pull.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_push.adoc | 20 | ||||
| -rw-r--r-- | docs/nng_rep.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_req.adoc | 18 | ||||
| -rw-r--r-- | docs/nng_respondent.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_strerror.adoc | 12 | ||||
| -rw-r--r-- | docs/nng_sub.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_surveyor.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_tcp.adoc | 12 | ||||
| -rw-r--r-- | docs/nng_tls.adoc | 13 | ||||
| -rw-r--r-- | docs/nng_tls_config_alloc.adoc | 37 | ||||
| -rw-r--r-- | docs/nng_tls_config_auth_mode.adoc | 89 | ||||
| -rw-r--r-- | docs/nng_tls_config_ca_cert.adoc | 82 | ||||
| -rw-r--r-- | docs/nng_tls_config_cert.adoc | 86 | ||||
| -rw-r--r-- | docs/nng_tls_config_free.adoc | 16 | ||||
| -rw-r--r-- | docs/nng_tls_config_key.adoc | 82 | ||||
| -rw-r--r-- | docs/nng_tls_config_pass.adoc | 70 | ||||
| -rw-r--r-- | docs/nng_tls_config_server_name.adoc | 69 | ||||
| -rw-r--r-- | docs/nng_ws.adoc | 13 | ||||
| -rw-r--r-- | docs/nng_zerotier.adoc | 12 |
28 files changed, 721 insertions, 240 deletions
diff --git a/docs/libnng.adoc b/docs/libnng.adoc index 3c320bb1..a0d42874 100644 --- a/docs/libnng.adoc +++ b/docs/libnng.adoc @@ -4,8 +4,8 @@ libnng(3) :manmanual: nng :mansource: nng :icons: font -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -23,7 +23,7 @@ SYNOPSIS DESCRIPTION ----------- -The <<nng.adoc#,nng(7)>> library provides a common messaging framework +The <<nng#,nng(7)>> library provides a common messaging framework intended to solve common communication problems in distributed applications. It provides a C language API. @@ -34,10 +34,10 @@ The following common functions exist in _libnng_. [cols="1,4"] |=== -|<<nng_alloc.adoc#,nng_alloc(3)>>|allocate memory -|<<nng_dial.adoc#,nng_dial(3)>>|create and start a dialer -|<<nng_free.adoc#,nng_free(3)>>|free memory -|<<nng_strerror.adoc#,nng_strerror(3)>>|return an error description +|<<nng_alloc#,nng_alloc(3)>>|allocate memory +|<<nng_dial#,nng_dial(3)>>|create and start a dialer +|<<nng_free#,nng_free(3)>>|free memory +|<<nng_strerror#,nng_strerror(3)>>|return an error description |=== Socket Functions @@ -47,14 +47,14 @@ The following functions operate on sockets. [cols="1,4"] |=== -|<<nng_close.adoc#,nng_close(3)>>|close a socket -|<<nng_closeall.adoc#,nng_closeall(3)>>|close all open sockets -|<<nng_dial.adoc#,nng_dial(3)>>|create and start a dialer -|<<nng_getopt.adoc#,nng_getopt(3)>>|get a socket option -|<<nng_listen.adoc#,nng_listen(3)>>|create and start a listener -|<<nng_recv.adoc#,nng_recv(3)>>|receive data -|<<nng_send.adoc#,nng_send(3)>>|send data -|<<nng_setopt.adoc#,nng_setopt(3)>>|set a socket option +|<<nng_close#,nng_close(3)>>|close a socket +|<<nng_closeall#,nng_closeall(3)>>|close all open sockets +|<<nng_dial#,nng_dial(3)>>|create and start a dialer +|<<nng_getopt#,nng_getopt(3)>>|get a socket option +|<<nng_listen#,nng_listen(3)>>|create and start a listener +|<<nng_recv#,nng_recv(3)>>|receive data +|<<nng_send#,nng_send(3)>>|send data +|<<nng_setopt#,nng_setopt(3)>>|set a socket option |=== Message Functions @@ -70,22 +70,22 @@ Most applications will only interact with the body. [cols="1,4"] |=== -|<<nng_msg_alloc.adoc#,nng_msg_alloc(3)>>|allocate a message -|<<nng_msg_body.adoc#,nng_msg_body(3)>>|return the message body -|<<nng_msg_free.adoc#,nng_msg_free(3)>>|free a message -|<<nng_msg_header.adoc#,nng_msg_header(3)>>|return the message header -|<<nng_msg_header_len.adoc#,nng_msg_header_len(3)>>|return the message header length -|<<nng_msg_len.adoc#,nng_msg_len(3)>>|return the message body length -|<<nng_msg_realloc.adoc#,nng_msg_realloc(3)>>|reallocate a message -|<<nng_recv_msg.adoc#,nng_recvmsg(3)>>|receive a message -|<<nng_sendmsg.adoc#,nng_sendmsg(3)>>|send a message +|<<nng_msg_alloc#,nng_msg_alloc(3)>>|allocate a message +|<<nng_msg_body#,nng_msg_body(3)>>|return the message body +|<<nng_msg_free#,nng_msg_free(3)>>|free a message +|<<nng_msg_header#,nng_msg_header(3)>>|return the message header +|<<nng_msg_header_len#,nng_msg_header_len(3)>>|return the message header length +|<<nng_msg_len#,nng_msg_len(3)>>|return the message body length +|<<nng_msg_realloc#,nng_msg_realloc(3)>>|reallocate a message +|<<nng_recv_msg#,nng_recvmsg(3)>>|receive a message +|<<nng_sendmsg#,nng_sendmsg(3)>>|send a message |=== Asynchronous Operations ~~~~~~~~~~~~~~~~~~~~~~~ Most applications will interact with _nng_ synchronously; that is that -functions such as <<nng_send.adoc#,nng_send()>> will block the calling +functions such as <<nng_send#,nng_send()>> will block the calling thread until the operation has completed. NOTE: Synchronous operations which send messages may return before the @@ -107,17 +107,17 @@ The following functions are used in the asynchronous model: [cols="1,4"] |=== -|<<nng_aio_alloc.adoc#,nng_aio_alloc(3)>>|allocate asynchronous I/O context -|<<nng_aio_cancel.adoc#,nng_aio_cancel(3)>>|cancel asynchronous I/O operation -|<<nng_aio_free.adoc#,nng_aio_free(3)>>|free asynchronous I/O context -|<<nng_aio_get_msg.adoc#,nng_aio_get_msg(3)>>|get message from an asynchronous receive -|<<nng_aio_result.adoc#,nng_aio_result(3)>>|return result from asynchronous operation -|<<nng_aio_stop.adoc#,nng_aio_stop(3)>>|stop asynchronous I/O operation -|<<nng_aio_wait.adoc#,nng_aio_wait(3)>>|wait for an asynchronous I/O operation -|<<nng_aio_set_msg.adoc#,nng_aio_set_msg(3)>>|set message for an asynchronous send -|<<nng_aio_set_timeout.adoc#,nng_aio_set_timeout(3)>>|set timeout for an asynchronous send -|<<nng_recv_aio.adoc#,nng_recv_aio(3)>>|receive a message asynchronously -|<<nng_send_aio.adoc#,nng_send_aio(3)>>|send a message asynchronously +|<<nng_aio_alloc#,nng_aio_alloc(3)>>|allocate asynchronous I/O context +|<<nng_aio_cancel#,nng_aio_cancel(3)>>|cancel asynchronous I/O operation +|<<nng_aio_free#,nng_aio_free(3)>>|free asynchronous I/O context +|<<nng_aio_get_msg#,nng_aio_get_msg(3)>>|get message from an asynchronous receive +|<<nng_aio_result#,nng_aio_result(3)>>|return result from asynchronous operation +|<<nng_aio_stop#,nng_aio_stop(3)>>|stop asynchronous I/O operation +|<<nng_aio_wait#,nng_aio_wait(3)>>|wait for an asynchronous I/O operation +|<<nng_aio_set_msg#,nng_aio_set_msg(3)>>|set message for an asynchronous send +|<<nng_aio_set_timeout#,nng_aio_set_timeout(3)>>|set timeout for an asynchronous send +|<<nng_recv_aio#,nng_recv_aio(3)>>|receive a message asynchronously +|<<nng_send_aio#,nng_send_aio(3)>>|send a message asynchronously |=== Protocols @@ -128,14 +128,14 @@ protocol: [cols="1,4"] |=== -| <<nng_bus.adoc#,nng_bus_open(3)>>|open a bus socket -| <<nng_pair.adoc#,nng_pair_open(3)>>|open a pair socket -| <<nng_pub.adoc#,nng_pub_open(3)>>|open a pub socket -| <<nng_rep.adoc#,nng_rep_open(3)>>|open a rep socket -| <<nng_req.adoc#,nng_req_open(3)>>|open a req socket -| <<nng_respondent.adoc#,nng_respondent_open(3)>>|open a respondent socket -| <<nng_sub.adoc#,nng_sub_open(3)>>|open a sub socket -| <<nng_surveyor.adoc#,nng_surveyor_open(3)>>|open a surveyor socket +| <<nng_bus#,nng_bus_open(3)>>|open a bus socket +| <<nng_pair#,nng_pair_open(3)>>|open a pair socket +| <<nng_pub#,nng_pub_open(3)>>|open a pub socket +| <<nng_rep#,nng_rep_open(3)>>|open a rep socket +| <<nng_req#,nng_req_open(3)>>|open a req socket +| <<nng_respondent#,nng_respondent_open(3)>>|open a respondent socket +| <<nng_sub#,nng_sub_open(3)>>|open a sub socket +| <<nng_surveyor#,nng_surveyor_open(3)>>|open a surveyor socket |=== Transports @@ -145,13 +145,13 @@ The following functions are used to register a transport for use. [cols="1,4"] |=== -| <<nng_inproc.adoc#,nng_inproc_register(3)>>|register inproc transport -| <<nng_ipc.adoc#,nng_ipc_register(3)>>|register IPC transport -| <<nng_tcp.adoc#,nng_tcp_register(3)>>|register TCP transport -| <<nng_tls.adoc#,nng_tls_register(3)>>|register TLS transport -| <<nng_ws.adoc#,nng_ws_register(3)>>|register WebSocket transport -| <<nng_wss.adoc#,nng_wss_register(3)>>|register WebSocket Secure transport -| <<nng_zerotier.adoc#,nng_zerotier_register(3)>>|register ZeroTier transport +| <<nng_inproc#,nng_inproc_register(3)>>|register inproc transport +| <<nng_ipc#,nng_ipc_register(3)>>|register IPC transport +| <<nng_tcp#,nng_tcp_register(3)>>|register TCP transport +| <<nng_tls#,nng_tls_register(3)>>|register TLS transport +| <<nng_ws#,nng_ws_register(3)>>|register WebSocket transport +| <<nng_wss#,nng_wss_register(3)>>|register WebSocket Secure transport +| <<nng_zerotier#,nng_zerotier_register(3)>>|register ZeroTier transport |=== TLS Configuration Objects @@ -175,15 +175,15 @@ The following functions are used to manipulate TLS configuration objects. SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_compat.adoc#,nng_compat(3)>> +<<nng#,nng(7)>>, +<<nng_compat#,nng_compat(3)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng.adoc b/docs/nng.adoc index 6eadc2ce..5b5db87a 100644 --- a/docs/nng.adoc +++ b/docs/nng.adoc @@ -4,8 +4,8 @@ nng(7) :manmanual: nng :mansource: nng :icons: font -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -56,24 +56,24 @@ other languages please check the http://nanomsg.org/[website]. Protocols ~~~~~~~~~ -* <<nng_bus.adoc#,nng_bus(7)>> - Bus protocol -* <<nng_pair.adoc#,nng_pair(7)>> - Pair protocol -* <<nng_pub.adoc#,nng_pub(7)>> - Publisher side of publish/subscribe protocol -* <<nng_sub.adoc#,nng_sub(7)>> - Subscriber side of publish/subscribe protocol -* <<nng_rep.adoc#,nng_rep(7)>> - Reply side of request/reply protocol -* <<nng_req.adoc#,nng_req(7)>> - Request side of request/reply protocol -* <<nng_respondent.adoc#,nng_respondent(7)>> - Respondent side of survey protocol -* <<nng_surveyor.adoc#,nng_surveyor(7)>> - Surveyor side of survey protocol +* <<nng_bus#,nng_bus(7)>> - Bus protocol +* <<nng_pair#,nng_pair(7)>> - Pair protocol +* <<nng_pub#,nng_pub(7)>> - Publisher side of publish/subscribe protocol +* <<nng_sub#,nng_sub(7)>> - Subscriber side of publish/subscribe protocol +* <<nng_rep#,nng_rep(7)>> - Reply side of request/reply protocol +* <<nng_req#,nng_req(7)>> - Request side of request/reply protocol +* <<nng_respondent#,nng_respondent(7)>> - Respondent side of survey protocol +* <<nng_surveyor#,nng_surveyor(7)>> - Surveyor side of survey protocol Transports ~~~~~~~~~~ -* <<nng_inproc.adoc#,nng_inproc(7)>> - Intra-process transport -* <<nng_ipc.adoc#,nng_ipc(7)>> - Inter-process transport -* <<nng_tls.adoc#,nng_tls(7)>> - TLSv1.2 over TCP transport -* <<nng_tcp.adoc#,nng_tcp(7)>> - TCP (and TCPv6) transport -* <<nng_ws.adoc#,nng_ws(7)>> - WebSocket transport -* <<nng_zerotier.adoc#,nng_zerotier(7)>> - ZeroTier transport +* <<nng_inproc#,nng_inproc(7)>> - Intra-process transport +* <<nng_ipc#,nng_ipc(7)>> - Inter-process transport +* <<nng_tls#,nng_tls(7)>> - TLSv1.2 over TCP transport +* <<nng_tcp#,nng_tcp(7)>> - TCP (and TCPv6) transport +* <<nng_ws#,nng_ws(7)>> - WebSocket transport +* <<nng_zerotier#,nng_zerotier(7)>> - ZeroTier transport Conceptual Overview ~~~~~~~~~~~~~~~~~~~ @@ -84,14 +84,14 @@ one _nng_ protocol. Each socket can be used to send and receive messages (if the protocol) supports it, and implements the appropriate protocol semantics. For -example, <<nng_sub.adoc#,nng_sub(7)>> sockets automatically filter incoming +example, <<nng_sub#,nng_sub(7)>> sockets automatically filter incoming messages to discard those for topics that have not been subscribed. _nng_ sockets are message oriented, so that messages are either delivered wholly, or not at all. Partial delivery is not possible. Furthermore, _nng_ does not provide any other delivery or ordering guarantees; messages may be dropped or reordered. (Some protocols, such as -<<nng_req.adoc#,nng_req(7)>> may offer stronger guarantees by +<<nng_req#,nng_req(7)>> may offer stronger guarantees by performing their own retry and validation schemes.) Each socket can have zero, one, or many "endpoints", which are either @@ -121,18 +121,18 @@ other than in a few specific circumstances. API ~~~ -The library API is documented at <<libnng.adoc#,libnng(3)>>. +The library API is documented at <<libnng#,libnng(3)>>. SEE ALSO -------- -<<libnng.adoc#,libnng(3)>> -<<nng_compat.adoc#,nng_compat(3)>> +<<libnng#,libnng(3)>>, +<<nng_compat#,nng_compat(3)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_bus.adoc b/docs/nng_bus.adoc index 3ded27e7..886d2adf 100644 --- a/docs/nng_bus.adoc +++ b/docs/nng_bus.adoc @@ -5,8 +5,8 @@ nng_bus(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -77,13 +77,13 @@ The _nng_bus_ protocol has no protocol-specific headers. SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_close.adoc b/docs/nng_close.adoc index 7106293c..3475436e 100644 --- a/docs/nng_close.adoc +++ b/docs/nng_close.adoc @@ -6,8 +6,8 @@ nng_close(3) :manvolnum: 3 :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -56,16 +56,16 @@ ERRORS SEE ALSO -------- -<<nng_setopt#,nng_setopt(3)>> -<<nng_strerror#,nng_strerror(3)>> +<<nng_setopt#,nng_setopt(3)>>, +<<nng_strerror#,nng_strerror(3)>>, <<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_inproc.adoc b/docs/nng_inproc.adoc index 02b90649..9ba30fae 100644 --- a/docs/nng_inproc.adoc +++ b/docs/nng_inproc.adoc @@ -5,8 +5,8 @@ nng_inproc(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -90,13 +90,13 @@ The _inproc_ transport has no special options. SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_ipc.adoc b/docs/nng_ipc.adoc index a83804b6..6367a681 100644 --- a/docs/nng_ipc.adoc +++ b/docs/nng_ipc.adoc @@ -5,8 +5,8 @@ nng_ipc(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -94,13 +94,13 @@ options.footnote:[Options for security attributes and credentials are planned.] SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_pair.adoc b/docs/nng_pair.adoc index 37022d55..f528b827 100644 --- a/docs/nng_pair.adoc +++ b/docs/nng_pair.adoc @@ -5,8 +5,8 @@ nng_pair(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -54,9 +54,9 @@ able to receive the message. NOTE: Even though this mode may appear to be "reliable", because back-pressure prevents discarding messages most of the time, there are topologies involving -_devices_ (see <<nng_device.adoc#,nng_device(3)>>) or raw mode sockets where +_devices_ (see <<nng_device#,nng_device(3)>>) or raw mode sockets where messages may be discarded. Applications that require reliable delivery -semantics should consider using <<nng_req.adoc#,nng_req(7)>> sockets, or +semantics should consider using <<nng_req#,nng_req(7)>> sockets, or implement their own acknowledgement layer on top of pair sockets. In order to avoid head-of-line blocking conditions, _polyamorous_ mode pair @@ -74,7 +74,7 @@ including the legacy https://github.com/nanomsg/nanomsg[nanomsg] library or https://github.com/go-mangos/mangos[mangos]. Version 1 of the protocol offers improved protection against loops when -used with <<nng_device.adoc#,nng_device(3)>>. It also offers _polyamorous_ +used with <<nng_device#,nng_device(3)>>. It also offers _polyamorous_ mode for forming multiple partnerships on a single socket. NOTE: Version 1 of this protocol is considered experimental at this time. @@ -90,10 +90,10 @@ In _polyamorous_ mode, which is only available with version 1, a socket can support many one-to-one connections. In this mode, the application must choose the remote peer to receive an ougoing message by setting the value of the pipe ID on the outgoing message using -the <<nng_msg_set_pipe.adoc#,nng_msg_set_pipe(3)>> function. +the <<nng_msg_set_pipe#,nng_msg_set_pipe(3)>> function. Most often the value of the outgoing pipe ID will be obtained from an incoming -message using the <<nng_msg_get_pipe.adoc#,nng_msg_get_pipe(3)>> function, +message using the <<nng_msg_get_pipe#,nng_msg_get_pipe(3)>> function, such as when replying to an incoming message. In order to prevent head-of-line blocking, if the peer on the given pipe @@ -139,13 +139,13 @@ each time the message is received by a new node. SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_pub.adoc b/docs/nng_pub.adoc index d69c4f9b..14b10bc0 100644 --- a/docs/nng_pub.adoc +++ b/docs/nng_pub.adoc @@ -5,8 +5,8 @@ nng_pub(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -35,7 +35,7 @@ subscribers. The subscribing applications only see the data to which they have subscribed. The _nng_pub_ protocol is the publisher side, and the -<<nng_sub.adoc#,nng_sub(7)>> protocol is the subscriber side. +<<nng_sub#,nng_sub(7)>> protocol is the subscriber side. NOTE: In this implementation, the publisher delivers all messages to all subscribers. The subscribers maintain their own subscriptions, and filter @@ -71,14 +71,14 @@ The _nng_pub_ protocol has no protocol-specific headers. SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_sub.adoc#,nng_sub(7)>> +<<nng#,nng(7)>>, +<<nng_sub#,nng_sub(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_pull.adoc b/docs/nng_pull.adoc index 4054ce46..6c730e54 100644 --- a/docs/nng_pull.adoc +++ b/docs/nng_pull.adoc @@ -5,8 +5,8 @@ nng_pull(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -30,7 +30,7 @@ DESCRIPTION ----------- The _nng_pull_ protocol is one half of a pipeline pattern. The other half -is the <<nng_push.adoc#,nng_push(7)>> protocol. +is the <<nng_push#,nng_push(7)>> protocol. In the pipeline pattern, pushers distribute messages to pullers. Each message sent @@ -68,14 +68,14 @@ The _nng_pull_ protocol has no protocol-specific headers. SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_push.adoc#,nng_push(7)>> +<<nng#,nng(7)>>, +<<nng_push#,nng_push(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_push.adoc b/docs/nng_push.adoc index 5ec90bdb..521b07d4 100644 --- a/docs/nng_push.adoc +++ b/docs/nng_push.adoc @@ -5,8 +5,8 @@ nng_push(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -30,7 +30,7 @@ DESCRIPTION ----------- The _nng_push_ protocol is one half of a pipeline pattern. The -other side is the <<nng_pull.adoc#,nng_pull(7)>> protocol. +other side is the <<nng_pull#,nng_pull(7)>> protocol. In the pipeline pattern, pushers distribute messages to pullers. Each message sent @@ -55,7 +55,7 @@ NOTE: Although the pipeline protocol honors flow control, and attempts to avoid dropping messages, no guarantee of delivery is made. Furthermore, as there is no capability for message acknowledgement, applications that need reliable delivery are encouraged to consider the -<<nng_req.adoc#,nng_req(7)>> protocol instead. +<<nng_req#,nng_req(7)>> protocol instead. Protocol Versions ~~~~~~~~~~~~~~~~~ @@ -75,15 +75,15 @@ The _nng_push_ protocol has no protocol-specific headers. SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_pull.adoc#,nng_pull(7)>> -<<nng_req.adoc#,nng_req(7)>> +<<nng#,nng(7)>>, +<<nng_pull#,nng_pull(7)>>, +<<nng_req#,nng_req(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_rep.adoc b/docs/nng_rep.adoc index 8b017c36..7cddb629 100644 --- a/docs/nng_rep.adoc +++ b/docs/nng_rep.adoc @@ -5,8 +5,8 @@ nng_rep(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -39,7 +39,7 @@ is also "reliable", in that a the requester will keep retrying until a reply is received. The _nng_rep_ protocol is the replier side, and the -<<nng_req.adoc#,nng_req(7)>> protocol is the requester side. +<<nng_req#,nng_req(7)>> protocol is the requester side. Socket Operations ~~~~~~~~~~~~~~~~~ @@ -94,14 +94,14 @@ and randomly when a request is first issued.) SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_req.adoc#,nng_req(7)>> +<<nng#,nng(7)>>, +<<nng_req#,nng_req(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_req.adoc b/docs/nng_req.adoc index 5da88b16..37262d24 100644 --- a/docs/nng_req.adoc +++ b/docs/nng_req.adoc @@ -5,8 +5,8 @@ nng_req(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -47,11 +47,11 @@ The requester generally only has one outstanding request at a time unless in "raw" mode (via `NNG_OPT_RAW`), and it will generally attempt to spread work requests to different peer repliers. -TIP: This property, when combined with a <<nng_device.adoc#,device>> can +TIP: This property, when combined with a <<nng_device#,device>> can help provide a degree of load-balancing. The _nng_req_ protocol is the requester side, and the -<<nng_rep.adoc#,nng_rep(7)>> protocol is the replier side. +<<nng_rep#,nng_rep(7)>> protocol is the replier side. Socket Operations ~~~~~~~~~~~~~~~~~ @@ -122,14 +122,14 @@ and randomly when a request is first issued.) SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_rep.adoc#,nng_rep(7)>> +<<nng#,nng(7)>>, +<<nng_rep#,nng_rep(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_respondent.adoc b/docs/nng_respondent.adoc index 42c2a703..5382d94b 100644 --- a/docs/nng_respondent.adoc +++ b/docs/nng_respondent.adoc @@ -5,8 +5,8 @@ nng_respondent(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -40,7 +40,7 @@ election in cluster configurations, as well as certain kinds of service discovery problems. The _nng_respondent_ protocol is the respondent side, and the -<<nng_surveyor.adoc#,nng_surveyor(7)>> protocol is the surveyor side. +<<nng_surveyor#,nng_surveyor(7)>> protocol is the surveyor side. Socket Operations ~~~~~~~~~~~~~~~~~ @@ -96,14 +96,14 @@ having their high order bit set to one.) SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_surveyor.adoc#,nng_surveyor(7)>> +<<nng#,nng(7)>>, +<<nng_surveyor#,nng_surveyor(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_strerror.adoc b/docs/nng_strerror.adoc index 4d42e1fb..c78a1279 100644 --- a/docs/nng_strerror.adoc +++ b/docs/nng_strerror.adoc @@ -5,8 +5,8 @@ nng_strerror(3) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -52,15 +52,15 @@ by a `NUL` byte. SEE ALSO -------- -<<libnng#,libnng(3)>> +<<libnng#,libnng(3)>>, <<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_sub.adoc b/docs/nng_sub.adoc index 59287ea9..bae52b4f 100644 --- a/docs/nng_sub.adoc +++ b/docs/nng_sub.adoc @@ -5,8 +5,8 @@ nng_sub(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -35,7 +35,7 @@ subscribers. The subscribing applications only see the data to which they have subscribed. The _nng_sub_ protocol is the subscriber side, and the -<<nng_pub.adoc#,nng_pub(7)>> protocol is the publisher side. +<<nng_pub#,nng_pub(7)>> protocol is the publisher side. NOTE: In this implementation, the publisher delivers all messages to all subscribers. The subscribers maintain their own subscriptions, and filter @@ -88,14 +88,14 @@ The _nng_sub_ protocol has no protocol-specific headers. SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_pub.adoc#,nng_pub(7)>> +<<nng#,nng(7)>>, +<<nng_pub#,nng_pub(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_surveyor.adoc b/docs/nng_surveyor.adoc index 5b121cf0..9e7e5cc7 100644 --- a/docs/nng_surveyor.adoc +++ b/docs/nng_surveyor.adoc @@ -5,8 +5,8 @@ nng_surveyor(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -40,7 +40,7 @@ election in cluster configurations, as well as certain kinds of service discovery problems. The _nng_surveyor_ protocol is the surveyor side, and the -<<nng_respondent.adoc#,nng_respondent(7)>> protocol is the respondent side. +<<nng_respondent#,nng_respondent(7)>> protocol is the respondent side. Socket Operations ~~~~~~~~~~~~~~~~~ @@ -113,14 +113,14 @@ having their high order bit set to one.) SEE ALSO -------- -<<nng.adoc#,nng(7)>> -<<nng_respondent.adoc#,nng_respondent(7)>> +<<nng#,nng(7)>>, +<<nng_respondent#,nng_respondent(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tcp.adoc b/docs/nng_tcp.adoc index 4a21f1e4..57e57702 100644 --- a/docs/nng_tcp.adoc +++ b/docs/nng_tcp.adoc @@ -5,8 +5,8 @@ nng_tcp(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -121,13 +121,13 @@ options.footnote:[Options for TCP keepalive, linger, and nodelay are planned.] SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls.adoc b/docs/nng_tls.adoc index acf71d7b..7c7be533 100644 --- a/docs/nng_tls.adoc +++ b/docs/nng_tls.adoc @@ -5,9 +5,8 @@ nng_tls(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -242,14 +241,14 @@ if the `NNG_OPT_TLS_AUTH_MODE` option is set to SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> COPYRIGHT --------- -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc index 4b41258f..21b4755f 100644 --- a/docs/nng_tls_config_alloc.adoc +++ b/docs/nng_tls_config_alloc.adoc @@ -6,7 +6,8 @@ nng_tls_config_alloc(3) :manvolnum: 3 :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -35,12 +36,13 @@ DESCRIPTION ----------- The `nng_tls_config_alloc()` function creates a newly initialized -TLS (Transport Layer Security, see -https://tools.ietf.org/html/rfc5246[RFC 5246]) -configuration object. +https://tools.ietf.org/html/rfc5246[Transport Layer Security]) +configuration object, and stores a pointer to it in the value pointed +to by 'cfgp'. This object is initialized for use when acting as either a -client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`). +client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`), +depending on the value of 'mode'. A TLS object can be further modified by functions that set the security keys used, peeer certificates, protocol policies, and so forth. @@ -64,28 +66,29 @@ ERRORS ------ `NNG_ENOMEM`:: Insufficient memory is available to allocate the object. +`NNG_EINVAL`:: An invalid 'mode' was specified. SEE ALSO -------- -<<nng_setopt#,nng_setopt(3)>> -<<nng_strerror#,nng_strerror(3)>> -<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>> -<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>> -<<nng_tls_config_cert#,nng_tls_config_cert(3)>> -<<nng_tls_config_crl#,nng_tls_config_crl(3)>> -<<nng_tls_config_free#,nng_tls_config_free(3)>> -<<nng_tls_config_key#,nng_tls_config_key(3)>> -<<nng_tls_config_pass#,nng_tls_config_pass(3)>> -<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>> +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, +<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>>, +<<nng_tls_config_cert#,nng_tls_config_cert(3)>>, +<<nng_tls_config_crl#,nng_tls_config_crl(3)>>, +<<nng_tls_config_free#,nng_tls_config_free(3)>>, +<<nng_tls_config_key#,nng_tls_config_key(3)>>, +<<nng_tls_config_pass#,nng_tls_config_pass(3)>>, +<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>, <<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_auth_mode.adoc b/docs/nng_tls_config_auth_mode.adoc new file mode 100644 index 00000000..fc4f9cfd --- /dev/null +++ b/docs/nng_tls_config_auth_mode.adoc @@ -0,0 +1,89 @@ +nng_tls_config_auth_mode(3) +=========================== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_auth_mode - configure authentication mode + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +typedef enum nng_tls_auth_mode { + NNG_TLS_AUTH_MODE_NONE, + NNG_TLS_AUTH_MODE_OPTIONAL, + NNG_TLS_AUTH_MODE_REQUIRED +} nng_tls_auth_mode; + +int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_auth_mode()` function configures the authentication mode +to be used for TLS sessions using this configuration object. + +The possible modes are: + +`NNG_TLS_AUTH_MODE_NONE`:: +No authentication of the TLS peer is performed. This is the default for +TLS servers, which most typically do not authenticate their clients. + +`NNG_TLS_AUTH_MODE_OPTIONAL`:: +If a certificate is presented by the peer, then it is validated. However, +if the peer does not present a valid certificate, then the sesssion is allowed +to proceed without authentication. + +`NNG_TLS_AUTH_MODE_REQUIRED`:: +A check is made to ensure that the peer has presented a valid certificate +used for the session. If the peer's certificate is invalid or missing, then +the session is refused. This is the default for clients. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EINVAL`:: An invalid 'mode' was specified. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. + + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>>, +<<nng_tls_config_crl#,nng_tls_config_crl(3)>>, +<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_ca_cert.adoc b/docs/nng_tls_config_ca_cert.adoc new file mode 100644 index 00000000..26700139 --- /dev/null +++ b/docs/nng_tls_config_ca_cert.adoc @@ -0,0 +1,82 @@ +nng_tls_config_ca_cert(3) +========================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_ca_cert - configure certificate authority certificate chain + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_ca_cert(nni_tls_config *cfg, const uint8_t *chain, size_t size) +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_ca_cert()` function configures a certificate or +certificate chain to be used when validating peers using the configuragion +'cfg'. + +NOTE: This function *must* be called when the TLS authentication mode SYNOPSIS +`NNG_TLS_AUTH_MODE_REQUIRED` or `NNG_TLS_AUTH_MODE_OPTIONAL`. It will have +no effect if the authentication mode is `NNG_TLS_AUTH_MODE_NONE`. + +TIP: This function may be called multiple times, to add additional chains +to a configuration, without affecting those added previously. + +The certificates located in 'chain' may be in either +https://tools.ietf.org/html/rfc7468[PEM] or DER format. When the 'chain' is +in PEM format, the certificates will be ASCII encoded, and concatenated +together. In this case the value of 'size' will be length of the +corresponding string (without any terminating NUL byte). + +When using DER encoding, the 'size' will be the total number of bytes, after +encoding. + + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. +`NNG_EINVAL`:: An invalid 'chain' or 'size' was supplied. + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_cert.adoc b/docs/nng_tls_config_cert.adoc new file mode 100644 index 00000000..f0ae7351 --- /dev/null +++ b/docs/nng_tls_config_cert.adoc @@ -0,0 +1,86 @@ +nng_tls_config_cert(3) +====================== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_cert - configure own certificate + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_cert(nni_tls_config *cfg, const uint8_t *cert, size_t size) +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_cert()` function configures a certificate identifying +the local side of a TLS connection used with 'cfg'. The certificate may be +a chain, with the bottom-most signer first and the root at the end. The +self-signed certificate at the end can be omitted. (The client should already +have it, and will have to in order to validate this certificate anyway). + +NOTE: The certificate supplied always contains public keying material. In +order to actually use this, a private key will have to be supplied as well, +using the <<nng_tls_config_key#,nnt_tls_config_key(3)>> function. + +TIP: This function may be called multiple times, to add additional chains +to a configuration, without affecting those added previously. + +The certificate located in 'cert' may be in either +https://tools.ietf.org/html/rfc7468[PEM] or DER format. + +When the 'cert' is +in PEM format, the certificate will be ASCII encoded. Additionally a private +key may or may not be present as additional concatenated PEM data. The +value of 'size' is the length of the concatenated strings, without any +terminating NUL byte. + +When using DER encoding, the 'size' will be the total number of bytes, after +encoding. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. +`NNG_EINVAL`:: An invalid 'cert' or 'size' was supplied. + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_key#,nng_tls_config_key(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_free.adoc b/docs/nng_tls_config_free.adoc index 8e94e7f2..67fcd540 100644 --- a/docs/nng_tls_config_free.adoc +++ b/docs/nng_tls_config_free.adoc @@ -6,7 +6,8 @@ nng_tls_config_alloc(3) :manvolnum: 3 :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -29,9 +30,9 @@ void nng_tls_config_free(nni_tls_config *cfg); DESCRIPTION ----------- -The `nng_tls_config_free()` decrements the reference count on a -TLS configuration object, and if the resulting reference count is zero, -then deallocates the configuration object. +The `nng_tls_config_free()` decrements the reference count on the +TLS configuration object pointed to by 'cfg', and if the resulting +reference count is zero, then deallocates the configuration object. RETURN VALUES ------------- @@ -48,14 +49,15 @@ None. SEE ALSO -------- -<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, <<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_key.adoc b/docs/nng_tls_config_key.adoc new file mode 100644 index 00000000..69e33fea --- /dev/null +++ b/docs/nng_tls_config_key.adoc @@ -0,0 +1,82 @@ +nng_tls_config_key(3) +===================== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_key - configure certificate authority certificate chain + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_key(nni_tls_config *cfg, const uint8_t *key, size_t size) +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_key()` function configures a private 'key' to be used +along with a certificate established with +<<nng_tls_config_cert#,nng_tls_config_cert(3)>>, for the given configuration +'cfg'. + +This function should be called immediately after `nng_tls_config_cert()`, +with the appropriate private key. + +The 'key' may be in either https://tools.ietf.org/html/rfc7468[PEM] or DER +format. When the 'chain' is +in PEM format, the key will be ASCII encoded. A certificate may be present +as well. The value of 'size' corresponds to the PEM encoding, not including +any terminating NUL byte. + +When using DER encoding, the 'size' will be the total number of bytes, after +encoding. + +The key material may be encrypted with a password, which can be supplied +using the <<nng_tls_config_pass#,nng_tls_config_pass(3)>> function. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. +`NNG_EINVAL`:: An invalid 'key' or 'size' was supplied. + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_cert#,nng_tls_config_cert(3)>>, +<<nng_tls_config_pass#,nng_tls_config_pass(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_pass.adoc b/docs/nng_tls_config_pass.adoc new file mode 100644 index 00000000..ca6a17e2 --- /dev/null +++ b/docs/nng_tls_config_pass.adoc @@ -0,0 +1,70 @@ +nng_tls_config_pass(3) +====================== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_pass - configure private key password + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_pass(nni_tls_config *cfg, const char *password) +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_pass()` function configures 'password' used to decrypt +a private key previously configured on the configuration 'cfg' with +<<nng_tls_config_key#,nng_tls_config_key(3)>>. + +The 'password' is an ASCIIZ string. + +This function's affect is limited to decryption only the most recent +private key that was configured. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. +`NNG_EINVAL`:: No private key was configured. + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_key#,nng_tls_config_key(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_tls_config_server_name.adoc b/docs/nng_tls_config_server_name.adoc new file mode 100644 index 00000000..e31d0660 --- /dev/null +++ b/docs/nng_tls_config_server_name.adoc @@ -0,0 +1,69 @@ +nng_tls_config_server_name(3) +============================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_server_name - configure remote server name + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_server_name()` function configures the remote server name +to be used by a client when connection to a server. The supplied 'name' +is used when comparing the identity in the server's certificate. Furthermore, +when Server Name Indication (SNI) is used, the 'name' may be sent to the server +as a hint to tell it which of several possible certificates should be used. + +TIP: This function is only useful in configuring client behavior. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. + + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_ws.adoc b/docs/nng_ws.adoc index 66bcff67..0afb417e 100644 --- a/docs/nng_ws.adoc +++ b/docs/nng_ws.adoc @@ -5,9 +5,8 @@ nng_ws(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -168,14 +167,14 @@ This object is only available for `wss://` endpoints. SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> COPYRIGHT --------- -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_zerotier.adoc b/docs/nng_zerotier.adoc index b1545857..40ebabff 100644 --- a/docs/nng_zerotier.adoc +++ b/docs/nng_zerotier.adoc @@ -5,8 +5,8 @@ nng_zerotier(7) :mansource: nng :icons: font :source-highlighter: pygments -:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \ - Copyright 2017 Capitar IT Group BV <info@capitar.com> \ +:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -217,13 +217,13 @@ in this fashion. SEE ALSO -------- -<<nng.adoc#,nng(7)>> +<<nng#,nng(7)>> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. |