diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-02 15:43:43 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-02 17:02:40 -0800 |
| commit | c2deb4a479be750b054372e83154f4b3b051c95a (patch) | |
| tree | a6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs | |
| parent | 4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff) | |
| download | nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2 nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip | |
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs')
78 files changed, 790 insertions, 1416 deletions
diff --git a/docs/libnng.adoc b/docs/libnng.adoc index b23383cc..9d2a1983 100644 --- a/docs/libnng.adoc +++ b/docs/libnng.adoc @@ -2,12 +2,11 @@ :doctype: manpage :manmanual: nng :mansource: nng -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -117,15 +116,21 @@ be associated with an _aio_ at any time. The following functions are used in the asynchronous model: |=== +|<<nng_aio_abort#,nng_aio_abort(3)>>|abort asynchronous I/O operation |<<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_input#,nng_aio_get_input(3)>>|get input parameter |<<nng_aio_get_msg#,nng_aio_get_msg(3)>>|get message from an asynchronous receive +|<<nng_aio_get_output#,nng_aio_get_output(3)>>|get output result |<<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_input#,nng_aio_set_input(3)>>|set input parameter +|<<nng_aio_set_iov#,nng_aio_set_iov(3)>>|set scatter/gather vector |<<nng_aio_set_msg#,nng_aio_set_msg(3)>>|set message for an asynchronous send +|<<nng_aio_set_output#,nng_aio_set_input(3)>>|set output result |<<nng_aio_set_timeout#,nng_aio_set_timeout(3)>>|set timeout for an asynchronous send +|<<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_recv_aio#,nng_recv_aio(3)>>|receive a message asynchronously |<<nng_send_aio#,nng_send_aio(3)>>|send a message asynchronously |=== @@ -185,6 +190,15 @@ The following functions are used to work with HTTP requests, responses, and connections. |=== +| <<nng_http_conn_close#,nng_http_conn_close(3)>>|close HTTP connection +| <<nng_http_conn_read#,nng_http_conn_read(3)>>|read from HTTP connection +| <<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>|read all from HTTP connection +| <<nng_http_conn_read_req#,nng_http_conn_read_req(3)>>|read HTTP request +| <<nng_http_conn_read_res#,nng_http_conn_read_req(3)>>|read HTTP response +| <<nng_http_conn_write#,nng_http_conn_write(3)>>|write to HTTP connection +| <<nng_http_conn_write_all#,nng_http_conn_write_all(3)>>|write all to HTTP connection +| <<nng_http_conn_write_req#,nng_http_conn_write(3)>>|write HTTP request +| <<nng_http_conn_write_res#,nng_http_conn_write(3)>>|write HTTP response | <<nng_http_req_add_header#,nng_http_req_add_header(3)>>|add HTTP request header | <<nng_http_req_alloc#,nng_http_req_alloc(3)>>|allocate HTTP request structure | <<nng_http_req_copy_data#,nng_http_req_copy_data(3)>>|copy HTTP request body @@ -243,8 +257,4 @@ with TLS support. == 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]. +{copyright} diff --git a/docs/nng.adoc b/docs/nng.adoc index 62482d09..21288fff 100644 --- a/docs/nng.adoc +++ b/docs/nng.adoc @@ -2,12 +2,11 @@ :doctype: manpage :manmanual: nng :mansource: nng -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME nng - nanomsg next generation @@ -123,21 +122,21 @@ The URLs used in _nng_ are canonicalized as follows, mostly in accordance with https://tools.ietf.org/html/rfc3986#section-6.2.2[RFC 3986 6.2.2]: - 1. The URL is parsed into scheme, userinfo, host, port, path, query and - fragment components. (Not all of these members are necessarily present.) - 2. The scheme, hostname, and port if present, are converted to lower case. - 3. Percent-encoded values for - https://tools.ietf.org/html/rfc3986#section-2.3[unreserved characters] - converted to their unencoded forms. - 4. Additionally URL percent-encoded values for characters in the path - and with numeric values larger than 127 (i.e. not ASCII) are decoded. - 5. The resulting path is checked for invalid UTF-8 sequences, consisting - of surrogate pairs, illegal byte sequences, or overlong encodings. - If this check fails, then the entire URL is considered invalid. - 6. Path segments consisting of `.` and `..` are resolved as per - https://tools.ietf.org/html/rfc3986#section-6.2.2.3[RFC 3986 6.2.2.3]. - 7. Further, empty path segments are removed, meaning that duplicate - slash (`/`) separators are removed from the path. + . The URL is parsed into scheme, userinfo, host, port, path, query and + fragment components. (Not all of these members are necessarily present.) + . The scheme, hostname, and port if present, are converted to lower case. + . Percent-encoded values for + https://tools.ietf.org/html/rfc3986#section-2.3[unreserved characters] + converted to their unencoded forms. + . Additionally URL percent-encoded values for characters in the path + and with numeric values larger than 127 (i.e. not ASCII) are decoded. + . The resulting path is checked for invalid UTF-8 sequences, consisting + of surrogate pairs, illegal byte sequences, or overlong encodings. + If this check fails, then the entire URL is considered invalid. + . Path segments consisting of `.` and `..` are resolved as per + https://tools.ietf.org/html/rfc3986#section-6.2.2.3[RFC 3986 6.2.2.3]. + . Further, empty path segments are removed, meaning that duplicate + slash (`/`) separators are removed from the path. Note that steps 4, 5, and 7 are not specified by RFC 3986, but performing them is believed to improve both the usability and security of _nng_ @@ -154,8 +153,4 @@ The library API is documented at <<libnng#,libnng(3)>>. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_bus.adoc b/docs/nng_bus.adoc index 886d2adf..a8147a2f 100644 --- a/docs/nng_bus.adoc +++ b/docs/nng_bus.adoc @@ -1,23 +1,19 @@ -nng_bus(7) += nng_bus(7) ========== :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_bus - bus protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +22,7 @@ SYNOPSIS int nng_bus0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_bus_ protocol provides for building mesh networks where every peer is connected to every other peer. In this protocol, @@ -52,38 +47,29 @@ should not be used for high throughput communications. Furthermore, the more traffic _in aggregate_ that occurs across the topology, the more likely that message loss is to occur. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_bus0_open()` call creates a bus socket. This socket may be used to send and receive messages. Sending messages will attempt to deliver to each directly connected peer. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The _nng_bus_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_bus_ protocol has no protocol-specific headers. -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_close.adoc b/docs/nng_close.adoc index 3475436e..9a582f83 100644 --- a/docs/nng_close.adoc +++ b/docs/nng_close.adoc @@ -1,24 +1,19 @@ -nng_close(3) -============ += nng_close(3) :doctype: manpage :manmanual: nng :mansource: nng :manvolnum: 3 -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_close - close a socket -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -27,9 +22,7 @@ SYNOPSIS int nng_close(int s); ----------- - -DESCRIPTION ------------ +== DESCRIPTION The `nng_close()` function closes the supplied socket, 's'. Messages that have been submitted for sending may be flushed or delivered, @@ -40,32 +33,20 @@ Further attempts to use the socket after this call returns will result in `NNG_EBADF`. Threads waiting for operations on the socket when this call is executed may also return with an `NNG_EBADF` result. - -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. - -ERRORS ------- +== ERRORS `NNG_EBADF`:: The socket is already closed or was never opened. - -SEE ALSO --------- +== SEE ALSO <<nng_setopt#,nng_setopt(3)>>, <<nng_strerror#,nng_strerror(3)>>, <<nng#,nng(7)>> +== COPYRIGHT -COPYRIGHT ---------- - -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/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_add_header.adoc b/docs/nng_http_req_add_header.adoc index beffa97a..f929f676 100644 --- a/docs/nng_http_req_add_header.adoc +++ b/docs/nng_http_req_add_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -63,8 +62,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_alloc.adoc b/docs/nng_http_req_alloc.adoc index f15772f7..32e756be 100644 --- a/docs/nng_http_req_alloc.adoc +++ b/docs/nng_http_req_alloc.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -62,8 +61,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright} diff --git a/docs/nng_http_req_copy_data.adoc b/docs/nng_http_req_copy_data.adoc index 0ae54cf0..5410d486 100644 --- a/docs/nng_http_req_copy_data.adoc +++ b/docs/nng_http_req_copy_data.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -61,8 +60,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_del_header.adoc b/docs/nng_http_req_del_header.adoc index e58650db..2ad39f47 100644 --- a/docs/nng_http_req_del_header.adoc +++ b/docs/nng_http_req_del_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -53,8 +52,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_free.adoc b/docs/nng_http_req_free.adoc index 2b4dc840..711b146b 100644 --- a/docs/nng_http_req_free.adoc +++ b/docs/nng_http_req_free.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_get_header.adoc b/docs/nng_http_req_get_header.adoc index 9431f597..5faabf1a 100644 --- a/docs/nng_http_req_get_header.adoc +++ b/docs/nng_http_req_get_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -49,11 +48,6 @@ None. <<nng_http_req_set_header#,nng_http_req_set_header(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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_get_method.adoc b/docs/nng_http_req_get_method.adoc index 4ae03516..63d9970f 100644 --- a/docs/nng_http_req_get_method.adoc +++ b/docs/nng_http_req_get_method.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -46,8 +45,5 @@ None. == COPYRIGHT -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +{copyright} -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. diff --git a/docs/nng_http_req_get_uri.adoc b/docs/nng_http_req_get_uri.adoc index 982a28a1..dafdb722 100644 --- a/docs/nng_http_req_get_uri.adoc +++ b/docs/nng_http_req_get_uri.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -47,8 +46,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_get_version.adoc b/docs/nng_http_req_get_version.adoc index 5aaac194..584b494c 100644 --- a/docs/nng_http_req_get_version.adoc +++ b/docs/nng_http_req_get_version.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -46,8 +45,4 @@ None. == 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]. +{copyright} diff --git a/docs/nng_http_req_set_data.adoc b/docs/nng_http_req_set_data.adoc index e1b5f6f9..3d208544 100644 --- a/docs/nng_http_req_set_data.adoc +++ b/docs/nng_http_req_set_data.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -63,8 +62,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_set_header.adoc b/docs/nng_http_req_set_header.adoc index e4381906..68eb1f4a 100644 --- a/docs/nng_http_req_set_header.adoc +++ b/docs/nng_http_req_set_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_set_method.adoc b/docs/nng_http_req_set_method.adoc index 439f9bc5..1584e79b 100644 --- a/docs/nng_http_req_set_method.adoc +++ b/docs/nng_http_req_set_method.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -52,8 +51,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_set_uri.adoc b/docs/nng_http_req_set_uri.adoc index 3208958a..3c7ec97f 100644 --- a/docs/nng_http_req_set_uri.adoc +++ b/docs/nng_http_req_set_uri.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_req_set_version.adoc b/docs/nng_http_req_set_version.adoc index fdfe117c..1811ec57 100644 --- a/docs/nng_http_req_set_version.adoc +++ b/docs/nng_http_req_set_version.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_add_header.adoc b/docs/nng_http_res_add_header.adoc index 81203de6..6b2dc58b 100644 --- a/docs/nng_http_res_add_header.adoc +++ b/docs/nng_http_res_add_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -63,8 +62,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_alloc.adoc b/docs/nng_http_res_alloc.adoc index 73dbccf5..3c611257 100644 --- a/docs/nng_http_res_alloc.adoc +++ b/docs/nng_http_res_alloc.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -66,8 +65,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_alloc_error.adoc b/docs/nng_http_res_alloc_error.adoc index 21a40d5f..1a2dd7b9 100644 --- a/docs/nng_http_res_alloc_error.adoc +++ b/docs/nng_http_res_alloc_error.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -56,8 +55,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_copy_data.adoc b/docs/nng_http_res_copy_data.adoc index 2034c033..38c8a842 100644 --- a/docs/nng_http_res_copy_data.adoc +++ b/docs/nng_http_res_copy_data.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -61,8 +60,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_del_header.adoc b/docs/nng_http_res_del_header.adoc index 4c9b8719..8b3c7739 100644 --- a/docs/nng_http_res_del_header.adoc +++ b/docs/nng_http_res_del_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -53,8 +52,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_free.adoc b/docs/nng_http_res_free.adoc index 102ddb84..a100db32 100644 --- a/docs/nng_http_res_free.adoc +++ b/docs/nng_http_res_free.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_get_header.adoc b/docs/nng_http_res_get_header.adoc index 74bb2f9f..6c366d2a 100644 --- a/docs/nng_http_res_get_header.adoc +++ b/docs/nng_http_res_get_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -52,8 +51,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_get_reason.adoc b/docs/nng_http_res_get_reason.adoc index 12e25352..c296d70d 100644 --- a/docs/nng_http_res_get_reason.adoc +++ b/docs/nng_http_res_get_reason.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -48,8 +47,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_get_status.adoc b/docs/nng_http_res_get_status.adoc index 5a0db720..74aa6f7d 100644 --- a/docs/nng_http_res_get_status.adoc +++ b/docs/nng_http_res_get_status.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -118,8 +117,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_get_version.adoc b/docs/nng_http_res_get_version.adoc index 740dd661..fd8026d6 100644 --- a/docs/nng_http_res_get_version.adoc +++ b/docs/nng_http_res_get_version.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -46,8 +45,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_set_data.adoc b/docs/nng_http_res_set_data.adoc index a2f29ba1..e48d4a2f 100644 --- a/docs/nng_http_res_set_data.adoc +++ b/docs/nng_http_res_set_data.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -63,8 +62,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_set_header.adoc b/docs/nng_http_res_set_header.adoc index 630d9fc4..7c5f33cd 100644 --- a/docs/nng_http_res_set_header.adoc +++ b/docs/nng_http_res_set_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -56,8 +55,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_set_reason.adoc b/docs/nng_http_res_set_reason.adoc index 7321badb..73b32f6c 100644 --- a/docs/nng_http_res_set_reason.adoc +++ b/docs/nng_http_res_set_reason.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -56,8 +55,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_set_status.adoc b/docs/nng_http_res_set_status.adoc index f8a88c8e..21832c23 100644 --- a/docs/nng_http_res_set_status.adoc +++ b/docs/nng_http_res_set_status.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -124,8 +123,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_http_res_set_version.adoc b/docs/nng_http_res_set_version.adoc index 14ed046d..682089e5 100644 --- a/docs/nng_http_res_set_version.adoc +++ b/docs/nng_http_res_set_version.adoc @@ -3,13 +3,12 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. - +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + == NAME nng_http_res_set_version - set HTTP response protocol version @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_inproc.adoc b/docs/nng_inproc.adoc index 47a088a5..904fd15e 100644 --- a/docs/nng_inproc.adoc +++ b/docs/nng_inproc.adoc @@ -1,23 +1,18 @@ -nng_inproc(7) -============= += nng_inproc(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_inproc - intra-process transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_inproc_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_inproc_ transport provides communication support between _nng_ sockets within the same process. This may be used as an alternative @@ -42,8 +36,7 @@ Registration The _inproc_ transport is generally built-in to the _nng_ core, so no extra steps to use it should be necessary. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `inproc://`, followed by an arbitrary string of text, terminated by a `NUL` byte. @@ -55,8 +48,7 @@ Two applications may also use the same URI without interfering with each other, and they will be unable to communicate with each other using that URI. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is of type `struct nng_sockaddr_inproc`. This type has the following definition: @@ -82,20 +74,14 @@ The `sa_family` member will have the value `NNG_AF_INPROC`. The `sa_path` member is an ASCIIZ string, and may contain any characters, terminated by a `NUL` byte. -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The _inproc_ transport has no special options. -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_ipc.adoc b/docs/nng_ipc.adoc index c1fcd5c4..7fa376f4 100644 --- a/docs/nng_ipc.adoc +++ b/docs/nng_ipc.adoc @@ -1,23 +1,18 @@ -nng_ipc(7) -========== += nng_ipc(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_ipc - IPC transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_ipc_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_ipc_ transport provides communication support between _nng_ sockets within different processes on the same host. For POSIX @@ -37,14 +31,12 @@ have different implementation strategies. // We need to insert a reference to the nanomsg RFC. -Registration -~~~~~~~~~~~~ +=== Registration The _ipc_ transport is generally built-in to the _nng_ core, so no extra steps to use it should be necessary. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `ipc://`, followed by a an absolute path name in the file system where the socket or named pipe @@ -54,8 +46,7 @@ TIP: On Windows, all names are prefixed by `\.\pipe\` and do not occupy the normal file system. On POSIX platforms, the path is taken literally, and is relative to the root directory. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is of type `nng_sockaddr_ipc`. This is a `struct` type with the following definition: @@ -81,21 +72,15 @@ The `sa_family` member will have the value `NNG_AF_IPC`. The `sa_path` member is an ASCIIZ string, and may contain any legal path name (platform-dependent), terminated by a `NUL` byte. -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The _ipc_ transport has no special options.footnote:[Options for security attributes and credentials are planned.] -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_msg_alloc.adoc b/docs/nng_msg_alloc.adoc index 8446c358..0df5c5de 100644 --- a/docs/nng_msg_alloc.adoc +++ b/docs/nng_msg_alloc.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_append.adoc b/docs/nng_msg_append.adoc index 205863d7..419ac217 100644 --- a/docs/nng_msg_append.adoc +++ b/docs/nng_msg_append.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -56,8 +55,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_body.adoc b/docs/nng_msg_body.adoc index a5b1e536..f88bdad0 100644 --- a/docs/nng_msg_body.adoc +++ b/docs/nng_msg_body.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -59,8 +58,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_chop.adoc b/docs/nng_msg_chop.adoc index 547ed8d0..83ea86bb 100644 --- a/docs/nng_msg_chop.adoc +++ b/docs/nng_msg_chop.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -57,8 +56,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_clear.adoc b/docs/nng_msg_clear.adoc index b84f024a..fe0ab48f 100644 --- a/docs/nng_msg_clear.adoc +++ b/docs/nng_msg_clear.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_dup.adoc b/docs/nng_msg_dup.adoc index 7da8b7b0..b7b639c3 100644 --- a/docs/nng_msg_dup.adoc +++ b/docs/nng_msg_dup.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -47,8 +46,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_free.adoc b/docs/nng_msg_free.adoc index f1f66cd1..c1a03486 100644 --- a/docs/nng_msg_free.adoc +++ b/docs/nng_msg_free.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header.adoc b/docs/nng_msg_header.adoc index 46efd6d5..233e3537 100644 --- a/docs/nng_msg_header.adoc +++ b/docs/nng_msg_header.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -58,8 +57,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_append.adoc b/docs/nng_msg_header_append.adoc index 2b839759..4588ddbd 100644 --- a/docs/nng_msg_header_append.adoc +++ b/docs/nng_msg_header_append.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -55,8 +54,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_chop.adoc b/docs/nng_msg_header_chop.adoc index cafd1995..c1345d61 100644 --- a/docs/nng_msg_header_chop.adoc +++ b/docs/nng_msg_header_chop.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -55,8 +54,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_clear.adoc b/docs/nng_msg_header_clear.adoc index 3880ed6d..443fc22c 100644 --- a/docs/nng_msg_header_clear.adoc +++ b/docs/nng_msg_header_clear.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_insert.adoc b/docs/nng_msg_header_insert.adoc index 87c8428f..70a5df21 100644 --- a/docs/nng_msg_header_insert.adoc +++ b/docs/nng_msg_header_insert.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -55,8 +54,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_len.adoc b/docs/nng_msg_header_len.adoc index 48c411c2..9a16aca6 100644 --- a/docs/nng_msg_header_len.adoc +++ b/docs/nng_msg_header_len.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_header_trim.adoc b/docs/nng_msg_header_trim.adoc index 8c59272c..2918faee 100644 --- a/docs/nng_msg_header_trim.adoc +++ b/docs/nng_msg_header_trim.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -55,8 +54,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_insert.adoc b/docs/nng_msg_insert.adoc index 5b4377f5..19ce5e97 100644 --- a/docs/nng_msg_insert.adoc +++ b/docs/nng_msg_insert.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -59,8 +58,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_len.adoc b/docs/nng_msg_len.adoc index 5629f091..f5cd03b5 100644 --- a/docs/nng_msg_len.adoc +++ b/docs/nng_msg_len.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -43,8 +42,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_realloc.adoc b/docs/nng_msg_realloc.adoc index 3693eca2..e0c4f9b0 100644 --- a/docs/nng_msg_realloc.adoc +++ b/docs/nng_msg_realloc.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -63,8 +62,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_msg_trim.adoc b/docs/nng_msg_trim.adoc index 1b1a166e..05ddadcd 100644 --- a/docs/nng_msg_trim.adoc +++ b/docs/nng_msg_trim.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -56,8 +55,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_pair.adoc b/docs/nng_pair.adoc index f528b827..53c39628 100644 --- a/docs/nng_pair.adoc +++ b/docs/nng_pair.adoc @@ -1,23 +1,18 @@ -nng_pair(7) -=========== += nng_pair(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_pair - pair protocol -SYNOPSIS --------- +== SYNOPSIS .Version 0 [source,c] @@ -35,8 +30,7 @@ int nng_pair0_open(nng_socket *s); int nng_pair1_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_pair_ protocol implements a peer-to-peer pattern, where relationships between peers are one-to-one. @@ -45,8 +39,7 @@ Version 1 of this protocol supports an optional _polyamorous_ mode where a peer can maintain multiple partnerships. Using this mode requires some additional sophistication in the application. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_pair_open()` call creates a _pair_ socket. Normally, this pattern will block when attempting to send a message, if no peer is @@ -63,8 +56,7 @@ In order to avoid head-of-line blocking conditions, _polyamorous_ mode pair sockets (version 1 only) discard messages if they are unable to deliver them to a peer. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Version 0 is the legacy version of this protocol. It lacks any header information, and is suitable when building simple one-to-one topologies. @@ -79,8 +71,7 @@ mode for forming multiple partnerships on a single socket. NOTE: Version 1 of this protocol is considered experimental at this time. -Polyamorous Mode -~~~~~~~~~~~~~~~~ +=== Polyamorous Mode Normally pair sockets are for one-to-one communication, and a given peer will reject new connections if it already has an active connection to another @@ -101,8 +92,7 @@ is not able to receive (or the pipe is no longer available, such as if the peer has disconnected), then the message will be discarded with no notification to the sender. -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -126,8 +116,7 @@ maximum time-to-live, and performs its own checks before forwarding a message. Therefore it is helpful if all nodes in the topology use the same value for this option. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers Version 0 of the pair protocol has no protocol-specific headers. @@ -137,15 +126,10 @@ used in conjuction with the `NNG_OPT_MAXTTL` option to guard against device forwarding loops. This value is initialized to 1, and incremented each time the message is received by a new node. -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_pub.adoc b/docs/nng_pub.adoc index 14b10bc0..ac389772 100644 --- a/docs/nng_pub.adoc +++ b/docs/nng_pub.adoc @@ -1,23 +1,18 @@ -nng_pub(7) -========== += nng_pub(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_pub - publisher protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_pub0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_pub_ protocol is one half of a publisher/subscriber pattern. In this pattern, a publisher sends data, which is broadcast to all @@ -46,39 +40,30 @@ The topics that subscribers subscribe to is just the first part of the message body. Applications should construct their messages accordingly. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_pub0_open()` call creates a publisher socket. This socket may be used to send messages, but is unable to receive them. Attempts to receive messages will result in `NNG_ENOTSUP`. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The _nng_pub_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_pub_ protocol has no protocol-specific headers. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_sub#,nng_sub(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_pull.adoc b/docs/nng_pull.adoc index 6c730e54..3d9b506e 100644 --- a/docs/nng_pull.adoc +++ b/docs/nng_pull.adoc @@ -1,23 +1,18 @@ -nng_pull(7) -=========== += nng_pull(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_pull - pull protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_pull0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_pull_ protocol is one half of a pipeline pattern. The other half is the <<nng_push#,nng_push(7)>> protocol. @@ -39,8 +33,7 @@ chosen in a round-robin fashion from the set of connected peers available for receiving. This property makes this pattern useful in load-balancing scenarios. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_pull0_open()` call creates a puller socket. This socket may be used to receive messages, but is unable to send them. Attempts @@ -50,32 +43,24 @@ When receiving messages, the _nng_pull_ protocol accepts messages as they arrive from peers. If two peers both have a message ready, the order in which messages are handled is undefined. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The _nng_pull_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_pull_ protocol has no protocol-specific headers. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_push#,nng_push(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_push.adoc b/docs/nng_push.adoc index 521b07d4..47957819 100644 --- a/docs/nng_push.adoc +++ b/docs/nng_push.adoc @@ -1,23 +1,18 @@ -nng_push(7) -=========== += nng_push(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_push - push protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_push0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_push_ protocol is one half of a pipeline pattern. The other side is the <<nng_pull#,nng_pull(7)>> protocol. @@ -39,8 +33,7 @@ chosen in a round-robin fashion from the set of connected peers available for receiving. This property makes this pattern useful in load-balancing scenarios. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_push0_open()` call creates a pusher socket. This socket may be used to send messages, but is unable to receive them. Attempts @@ -57,33 +50,25 @@ as there is no capability for message acknowledgement, applications that need reliable delivery are encouraged to consider the <<nng_req#,nng_req(7)>> protocol instead. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The _nng_push_ protocol has no protocol-specific options. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_push_ protocol has no protocol-specific headers. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_pull#,nng_pull(7)>>, <<nng_req#,nng_req(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_rep.adoc b/docs/nng_rep.adoc index 7cddb629..2eae0feb 100644 --- a/docs/nng_rep.adoc +++ b/docs/nng_rep.adoc @@ -1,16 +1,12 @@ -nng_rep(7) -========== += nng_rep(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. NAME ---- diff --git a/docs/nng_req.adoc b/docs/nng_req.adoc index 37262d24..25da41ef 100644 --- a/docs/nng_req.adoc +++ b/docs/nng_req.adoc @@ -1,23 +1,18 @@ -nng_req(7) -========== += nng_req(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_req - request protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_req0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_req_ protocol is one half of a request/reply pattern. In this pattern, a requester sends a message to one replier, who @@ -53,8 +47,7 @@ help provide a degree of load-balancing. The _nng_req_ protocol is the requester side, and the <<nng_rep#,nng_rep(7)>> protocol is the replier side. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_req0_open()` call creates a requester socket. This socket may be used to send messages (requests), and then to receive replies. Generally @@ -72,14 +65,12 @@ in `NNG_ESTATE`. Raw mode sockets (set with `NNG_OPT_RAW`) ignore all these restrictions. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -102,8 +93,7 @@ The following protocol-specific options are available. of 0 may be used to disable the loop protection, allowing an infinite number of hops. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_req_ protocol uses a _backtrace_ in the header. This form uses an array of 32-bit big-endian identifiers, where the first @@ -119,17 +109,11 @@ and randomly when a request is first issued.) // TODO: Insert reference to RFC. - -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_rep#,nng_rep(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_respondent.adoc b/docs/nng_respondent.adoc index 7760e21a..8d2e95f7 100644 --- a/docs/nng_respondent.adoc +++ b/docs/nng_respondent.adoc @@ -1,23 +1,18 @@ -nng_respondent(7) -================= += nng_respondent(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_respondent - respondent protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_respondent0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_respondent_ protocol is one half of a survey pattern. In this pattern, a surveyor sends a survey, which is broadcast to all @@ -42,8 +36,7 @@ discovery problems. The _nng_respondent_ protocol is the respondent side, and the <<nng_surveyor#,nng_surveyor(7)>> protocol is the surveyor side. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_respondent0_open()` call creates a respondent socket. This socket may be used to receive messages, and then to send replies. Generally @@ -54,8 +47,7 @@ Respondents may discard a survey by simply not replying to it. Raw mode sockets (set with `NNG_OPT_RAW`) ignore all these restrictions. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined. An earlier and @@ -63,8 +55,7 @@ incompatible version of the protocol was used in older pre-releases of http://nanomsg.org[nanomsg], but was not released in any production version.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -77,8 +68,7 @@ The following protocol-specific options are available. of 0 may be used to disable the loop protection, allowing an infinite number of hops. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_respondent_ protocol uses a _backtrace_ in the header. This form uses an array of 32-bit big-endian identifiers, where the first @@ -94,16 +84,11 @@ having their high order bit set to one.) // TODO: Insert reference to RFC. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_surveyor#,nng_surveyor(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_strerror.adoc b/docs/nng_strerror.adoc index 568f1150..4babe142 100644 --- a/docs/nng_strerror.adoc +++ b/docs/nng_strerror.adoc @@ -2,12 +2,11 @@ :doctype: manpage :manmanual: nng :mansource: nng -: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 \ - be found online at https://opensource.org/licenses/MIT. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -47,8 +46,4 @@ by a `NUL` byte. == COPYRIGHT -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/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_sub.adoc b/docs/nng_sub.adoc index bae52b4f..cbb4fe51 100644 --- a/docs/nng_sub.adoc +++ b/docs/nng_sub.adoc @@ -1,23 +1,18 @@ -nng_sub(7) -========== += nng_sub(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_sub - subscriber protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_sub0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_sub_ protocol is one half of a publisher/subscriber pattern. In this pattern, a publisher sends data, which is broadcast to all @@ -46,21 +40,18 @@ The topics that subscribers subscribe to is just the first part of the message body. Applications should construct their messages accordingly. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_sub0_open()` call creates a subscriber socket. This socket may be used to receive messages, but is unable to send them. Attempts to send messages will result in `NNG_ENOTSUP`. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -81,21 +72,15 @@ TIP: To receive all messages, an empty topic (zero length) can be used. Note that if the topic was not previously subscribed to with `NNG_OPT_SUB_SUBSCRIBE` then an `NNG_ENOENT` error will result. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_sub_ protocol has no protocol-specific headers. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_pub#,nng_pub(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_surveyor.adoc b/docs/nng_surveyor.adoc index 9e7e5cc7..b67c49b6 100644 --- a/docs/nng_surveyor.adoc +++ b/docs/nng_surveyor.adoc @@ -1,23 +1,18 @@ -nng_surveyor(7) -=============== += nng_surveyor(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_surveyor - surveyor protocol -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_surveyor0_open(nng_socket *s); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_surveyor_ protocol is one half of a survey pattern. In this pattern, a surveyor sends a survey, which is broadcast to all @@ -42,8 +36,7 @@ discovery problems. The _nng_surveyor_ protocol is the surveyor side, and the <<nng_respondent#,nng_respondent(7)>> protocol is the respondent side. -Socket Operations -~~~~~~~~~~~~~~~~~ +=== Socket Operations The `nng_surveyor0_open()` call creates a respondent socket. This socket may be used to send messages (surveys), and then to receive replies. Generally @@ -61,8 +54,7 @@ survey that arrive after this will be discarded. Raw mode sockets (set with `NNG_OPT_RAW`) ignore all these restrictions. -Protocol Versions -~~~~~~~~~~~~~~~~~ +=== Protocol Versions Only version 0 of this protocol is supported. (At the time of writing, no other versions of this protocol have been defined. An earlier and @@ -70,8 +62,7 @@ incompatible version of the protocol was used in older pre-releases of http://nanomsg.org[nanomsg], but was not released in any production version.) -Protocol Options -~~~~~~~~~~~~~~~~ +=== Protocol Options The following protocol-specific options are available. @@ -94,8 +85,7 @@ The following protocol-specific options are available. of 0 may be used to disable the loop protection, allowing an infinite number of hops. -Protocol Headers -~~~~~~~~~~~~~~~~ +=== Protocol Headers The _nng_surveyor_ protocol uses a _backtrace_ in the header. This form uses an array of 32-bit big-endian identifiers, where the first @@ -110,17 +100,11 @@ having their high order bit set to one.) // TODO: Insert reference to RFC. - -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_respondent#,nng_respondent(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_tcp.adoc b/docs/nng_tcp.adoc index 57e57702..4c5a630e 100644 --- a/docs/nng_tcp.adoc +++ b/docs/nng_tcp.adoc @@ -1,23 +1,18 @@ -nng_tcp(7) -========== += nng_tcp(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tcp - TCP/IP transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_tcp_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_tcp_ transport provides communication support between _nng_ sockets across a TCP/IP network. Both IPv4 and IPv6 @@ -35,14 +29,12 @@ are supported when the underlying platform also supports it. // We need to insert a reference to the nanomsg RFC. -Registration -~~~~~~~~~~~~ +=== Registration The _tcp_ transport is generally built-in to the _nng_ core, so no extra steps to use it should be necessary. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `tcp://`, followed by an IP address or hostname, followed by a colon and finally a @@ -75,8 +67,7 @@ on the host: The entire URI must be less than `NNG_MAXADDRLEN` bytes long. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is either of type `nng_sockaddr_in` (for IPv4) or `nng_sockaddr_in6` (for IPv6). @@ -113,21 +104,15 @@ The `sa_family` member will have the value `NNG_AF_INET` or `NNG_AF_INET6`. The `sa_port` and `sa_addr` are the TCP port number and address, both in network byte order (most significant byte is first). -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The _tcp_ transport has no special options.footnote:[Options for TCP keepalive, linger, and nodelay are planned.] -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls.adoc b/docs/nng_tls.adoc index 6284fc8d..18078588 100644 --- a/docs/nng_tls.adoc +++ b/docs/nng_tls.adoc @@ -1,23 +1,18 @@ -nng_tls(7) -========== += nng_tls(7) :doctype: manpage :manmanual: nng :mansource: nng -: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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls - TLS transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_tls_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_tls_ transport provides communication support between _nng_ sockets across a TCP/IP network using @@ -38,16 +32,14 @@ are supported when the underlying platform also supports it. The protocol details are documented in http://nanomsg.org/rfcs/sp-tls-v1.html[TLS Mapping for Scalability Protocols]. -Registration -~~~~~~~~~~~~ +=== Registration Depending upon how the library was built, it may be necessary to register the transport by calling `nng_tls_register`. This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. -Availability -~~~~~~~~~~~~ +=== Availability The _tls_ transport depends on the use of an external library. As of this writing, https://tls.mbed.org/[mbed TLS] version 2.0 @@ -64,8 +56,7 @@ https://opensource.org/licenses/gpl-license[GNU GPL] terms. You are responsible for understanding and adhering to the license terms of any libraries you make use of. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `tls+tcp://`, followed by an IP address or hostname, followed by a colon and finally a @@ -103,8 +94,7 @@ on the host: The entire URI must be less than `NNG_MAXADDRLEN` bytes long. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is either of type `nng_sockaddr_in` (for IPv4) or `nng_sockaddr_in6` (for IPv6). @@ -141,8 +131,7 @@ The `sa_family` member will have the value `NNG_AF_INET` or `NNG_AF_INET6`. The `sa_port` and `sa_addr` are the TCP port number and address, both in network byte order (most significant byte is first). -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The following transport options are available. Note that setting these must be done before the transport is started. @@ -184,16 +173,11 @@ It will true (1) if the remote peer has been properly verified using TLS authentication, or false (0) otherwise. This option may return incorrect results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc index a5823e65..98884f70 100644 --- a/docs/nng_tls_config_alloc.adoc +++ b/docs/nng_tls_config_alloc.adoc @@ -1,24 +1,19 @@ -nng_tls_config_alloc(3) -======================= += nng_tls_config_alloc(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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_alloc - allocate TLS configuration object -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -32,8 +27,7 @@ typedef enum nng_tls_mode { int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_alloc()` function creates a newly initialized https://tools.ietf.org/html/rfc5246[Transport Layer Security]) @@ -56,21 +50,16 @@ is first used with a service. After this points, attempts to apply further changes to the configuration will result in `NNG_EBUSY`. -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. - -ERRORS ------- +== ERRORS `NNG_ENOMEM`:: Insufficient memory is available to allocate the object. `NNG_EINVAL`:: An invalid 'mode' was specified. - -SEE ALSO --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, @@ -80,12 +69,6 @@ SEE ALSO <<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>, <<nng#,nng(7)>> +== COPYRIGHT -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]. +{copyright} diff --git a/docs/nng_tls_config_auth_mode.adoc b/docs/nng_tls_config_auth_mode.adoc index e07a6a41..1895abba 100644 --- a/docs/nng_tls_config_auth_mode.adoc +++ b/docs/nng_tls_config_auth_mode.adoc @@ -1,24 +1,19 @@ -nng_tls_config_auth_mode(3) -=========================== += 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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_auth_mode - configure authentication mode -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -33,8 +28,7 @@ typedef enum nng_tls_auth_mode { int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_auth_mode()` function configures the authentication mode to be used for TLS sessions using this configuration object. @@ -55,21 +49,18 @@ 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 -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== 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 --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, @@ -79,11 +70,6 @@ SEE ALSO <<nng#,nng(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} diff --git a/docs/nng_tls_config_ca_chain.adoc b/docs/nng_tls_config_ca_chain.adoc index dcf29a65..19c97409 100644 --- a/docs/nng_tls_config_ca_chain.adoc +++ b/docs/nng_tls_config_ca_chain.adoc @@ -1,24 +1,19 @@ -nng_tls_config_ca_chain(3) -========================== += nng_tls_config_ca_chain(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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_ca_chain - configure certificate authority certificate chain -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -28,8 +23,7 @@ int nng_tls_config_ca_cert(nni_tls_config *cfg, const char *chain, const char *crl); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_ca_chain()` function configures a certificate or certificate chain to be used when validating peers using the configuration @@ -49,20 +43,17 @@ together. The 'crl' may be NULL, or may also be a C string containing a PEM format certificate revocation list for the associated authority. -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== 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 --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, @@ -70,12 +61,6 @@ SEE ALSO <<nng_tls_config_ca_file#,nng_tls_config_ca_file(3)>>, <<nng#,nng(7)>> +== COPYRIGHT -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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls_config_ca_file.adoc b/docs/nng_tls_config_ca_file.adoc index 32679fc1..0c8d9075 100644 --- a/docs/nng_tls_config_ca_file.adoc +++ b/docs/nng_tls_config_ca_file.adoc @@ -1,24 +1,19 @@ -nng_tls_config_ca_file(3) -========================= += nng_tls_config_ca_file(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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_ca_file - load certificate authority from file -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -27,8 +22,7 @@ SYNOPSIS int nng_tls_config_ca_file(nni_tls_config *cfg, const char *path); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_ca_file()` function configures the certificate authority certificate chain and optional revocation list by loading the certificates @@ -44,13 +38,11 @@ NOTE: Certificates *must* be configured when using the authentication mode TIP: This function may be called multiple times, to add additional chains to a configuration, without affecting those added previously. -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== ERRORS `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. @@ -58,8 +50,7 @@ ERRORS `NNG_ENOENT`:: The file 'path' does not exist. `NNG_EPERM`:: The file 'path' is not readable. -SEE ALSO --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, @@ -67,12 +58,6 @@ SEE ALSO <<nng_tls_config_ca_chain#,nng_tls_config_ca_chain(3)>>, <<nng#,nng(7)>> +== COPYRIGHT -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]. +{copyright} diff --git a/docs/nng_tls_config_cert_key_file.adoc b/docs/nng_tls_config_cert_key_file.adoc index 9745d442..119e3939 100644 --- a/docs/nng_tls_config_cert_key_file.adoc +++ b/docs/nng_tls_config_cert_key_file.adoc @@ -1,24 +1,19 @@ -nng_tls_config_cert_key_file(3) -=============================== += nng_tls_config_cert_key_file(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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_cert_key_file - load own certificate and key from file -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -28,8 +23,7 @@ int nng_tls_config_cert_key_file(nni_tls_config *cfg, const char *path, const char *pass); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_cert_key_file()` function loads a certificate (or certificate chain) and a private key from the file named by 'path'. @@ -49,14 +43,11 @@ On servers, it is possible to call this function multiple times for the same configuration. This can be useful for specifying different parameters to be used for different cryptographic algorithms. - -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== ERRORS `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. @@ -64,8 +55,7 @@ ERRORS `NNG_ENOENT`:: The file named by 'path' does not exist. `NNG_EPERM`:: The file named by 'path' cannot be opened. -SEE ALSO --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, @@ -73,11 +63,6 @@ SEE ALSO <<nng#,nng(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls_config_free.adoc b/docs/nng_tls_config_free.adoc index 67fcd540..823127fb 100644 --- a/docs/nng_tls_config_free.adoc +++ b/docs/nng_tls_config_free.adoc @@ -1,24 +1,19 @@ -nng_tls_config_alloc(3) -======================= += nng_tls_config_alloc(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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_free - deallocate a TLS configuration object -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -27,37 +22,25 @@ SYNOPSIS void nng_tls_config_free(nni_tls_config *cfg); ----------- -DESCRIPTION ------------ +== DESCRIPTION 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 -------------- +== RETURN VALUES None. - -ERRORS ------- +== ERRORS None. - -SEE ALSO --------- +== SEE ALSO <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, <<nng#,nng(7)>> +== COPYRIGHT -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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls_config_own_cert.adoc b/docs/nng_tls_config_own_cert.adoc index dd8f7362..c43828cf 100644 --- a/docs/nng_tls_config_own_cert.adoc +++ b/docs/nng_tls_config_own_cert.adoc @@ -1,24 +1,19 @@ -nng_tls_config_own_cert(3) -========================== += nng_tls_config_own_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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_own_cert - configure own certificate and key -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -28,8 +23,7 @@ int nng_tls_config_own_cert(nni_tls_config *cfg, const char *cert, const char *key, const char *pass); ----------- -DESCRIPTION ------------ +== DESCRIPTION The `nng_tls_config_own_cert()` function configures a certificate 'cert' identifying the local side of a TLS connection used with 'cfg', along with an @@ -50,20 +44,17 @@ The certificate located in 'cert' and 'key' must be NUL terminated C strings containing https://tools.ietf.org/html/rfc7468[PEM] formatted material. -RETURN VALUES -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== 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 --------- +== SEE ALSO <<nng_strerror#,nng_strerror(3)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, @@ -71,11 +62,6 @@ SEE ALSO <<nng#,nng(7)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_tls_config_server_name.adoc b/docs/nng_tls_config_server_name.adoc index e31d0660..bbe017bb 100644 --- a/docs/nng_tls_config_server_name.adoc +++ b/docs/nng_tls_config_server_name.adoc @@ -1,24 +1,19 @@ -nng_tls_config_server_name(3) -============================= += 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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_tls_config_server_name - configure remote server name -SYNOPSIS --------- +== SYNOPSIS [source, c] ----------- @@ -27,8 +22,7 @@ SYNOPSIS int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); ----------- -DESCRIPTION ------------ +== 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' @@ -38,32 +32,22 @@ 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 -------------- +== RETURN VALUES This function returns 0 on success, and non-zero otherwise. -ERRORS ------- +== ERRORS `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. - -SEE ALSO --------- +== 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 ---------- - -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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_url_clone.adoc b/docs/nng_url_clone.adoc index b1714962..d78e4c09 100644 --- a/docs/nng_url_clone.adoc +++ b/docs/nng_url_clone.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -46,8 +45,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_url_free.adoc b/docs/nng_url_free.adoc index 1aa522f0..a0038f9b 100644 --- a/docs/nng_url_free.adoc +++ b/docs/nng_url_free.adoc @@ -3,13 +3,12 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. - +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + == NAME nng_url_free - free a URL structure @@ -44,8 +43,4 @@ None. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_url_parse.adoc b/docs/nng_url_parse.adoc index 9d4be764..db3aad4b 100644 --- a/docs/nng_url_parse.adoc +++ b/docs/nng_url_parse.adoc @@ -3,12 +3,11 @@ :manmanual: nng :mansource: nng :manvolnum: 3 -: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. +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. == NAME @@ -98,8 +97,4 @@ This function returns 0 on success, and non-zero otherwise. == 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]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_ws.adoc b/docs/nng_ws.adoc index ebab433c..ba01c9fd 100644 --- a/docs/nng_ws.adoc +++ b/docs/nng_ws.adoc @@ -1,23 +1,18 @@ -nng_ws(7) -========= += nng_ws(7) :doctype: manpage :manmanual: nng :mansource: nng -: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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_ws - WebSocket transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -27,8 +22,7 @@ int nng_ws_register(void); int nng_wss_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_ws_ transport provides communication support between _nng_ sockets across a TCP/IP network using @@ -38,8 +32,7 @@ are supported when the underlying platform also supports it. The protocol details are documented in http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability Protocols]. -Registration -~~~~~~~~~~~~ +=== Registration Depending upon how the library was built, it may be necessary to register the transport by calling `nng_ws_register`. This function @@ -51,8 +44,7 @@ can be used as well, but the secure transport may have to be registered using the `nng_wss_register` function. (Note that this function will not be present if TLS support was not enabled in the library.) -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `ws://`, followed by an IP address or hostname, optionally followed by a colon and an @@ -88,8 +80,7 @@ the underlying system supports. (On most modern systems it will map to the special IPv6 address `::`, and both IPv4 and IPv6 connections will be permitted, with IPv4 addresses mapped to IPv6 addresses.) -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is either of type `nng_sockaddr_in` (for IPv4) or `nng_sockaddr_in6` (for IPv6). @@ -126,8 +117,7 @@ The `sa_family` member will have the value `NNG_AF_INET` or `NNG_AF_INET6`. The `sa_port` and `sa_addr` are the TCP port number and address, both in network byte order (most significant byte is first). -Server Instances -~~~~~~~~~~~~~~~~ +=== Server Instances This transport makes use of shared HTTP server instances, permitting multiple sockets or listeners to be configured with the same hostname and port. When @@ -147,8 +137,7 @@ process. The server may also be used by other things (for example to serve static content), in the same process. -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The following transport options are available. Note that setting these must be done before the transport is started. @@ -213,16 +202,11 @@ results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`. // and NNG_OPT_LISTEN_HOOK_ARG that passes the void * passed in as first arg. // Alternatively we can uplevel the HTTP API and pass the actual HTTP objects. -SEE ALSO --------- +== SEE ALSO + <<nng#,nng(7)>>, <<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> -COPYRIGHT ---------- - -Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright}
\ No newline at end of file diff --git a/docs/nng_zerotier.adoc b/docs/nng_zerotier.adoc index 16bb647c..cc452931 100644 --- a/docs/nng_zerotier.adoc +++ b/docs/nng_zerotier.adoc @@ -1,23 +1,18 @@ -nng_zerotier(7) -=============== += nng_zerotier(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -: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 \ - be found online at https://opensource.org/licenses/MIT. - -NAME ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_zerotier - ZeroTier transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_zt_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_zerotier_ transport provides communication support for _nng_ applications over a http://www.zerotier.com[ZeroTier] network, @@ -53,16 +47,14 @@ network. NOTE: This document assumes that the reader is familiar with ZeroTier concepts and administration. -Registration -~~~~~~~~~~~~ +=== Registration Depending upon how the library was built, it may be necessary to register the transport by calling `nng_zt_register`. This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `zt://`, followed by a node number (ten hexadecimal digits) followed by a `.` delimited, and then @@ -78,8 +70,7 @@ Listeners may use port 0 to indicate that a suitable port number be selected automatically. Applications using this must determine the selected port number using the `nng_listener_getopt` function. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is of type `struct nng_sockaddr_zt`. This type has the following definition: @@ -101,8 +92,7 @@ members are, unlike TCP socket address, in native byte order. Only the lower 24-bits of the `sa_port` may be used. Likewise only the lower 40-bits of the `sa_nodeid` may be used. -Node Presence -~~~~~~~~~~~~~ +=== Node Presence By default this transport creates an "ephemeral" node, and used the same ephemeral node for any additional endpoints created. As this node @@ -114,9 +104,7 @@ below. It is possible for a single application to join multiple networks using the same node, or using separate nodes. - -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The following transport options are available: @@ -215,15 +203,10 @@ in this fashion. ID to "deorbit". If the node is not already orbiting the moon, then this has no effect. -SEE ALSO --------- -<<nng#,nng(7)>> +== SEE ALSO -COPYRIGHT ---------- +<<nng#,nng(7)>> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} |