From 7e83c78ad2c98a7c32a1b9557deaa13723e75b02 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 1 Jan 2018 18:11:17 -0800 Subject: Add TLS configuration manipulation documentation. While here, also fixup the markup on many of the pages, to use commas in SEE ALSO, avoid adding the .adoc extension to cross-references, and correct the link to the MIT license text. --- docs/libnng.adoc | 114 +++++++++++++++++++++++++++---------------------------- 1 file changed, 57 insertions(+), 57 deletions(-) (limited to 'docs/libnng.adoc') diff --git a/docs/libnng.adoc b/docs/libnng.adoc index 3c320bb1..a0d42874 100644 --- a/docs/libnng.adoc +++ b/docs/libnng.adoc @@ -4,8 +4,8 @@ libnng(3) :manmanual: nng :mansource: nng :icons: font -:copyright: Copyright 2017 Garrett D'Amore \ - Copyright 2017 Capitar IT Group BV \ +:copyright: Copyright 2018 Garrett D'Amore \ + Copyright 2018 Capitar IT Group BV \ This software is supplied under the terms of the MIT License, a \ copy of which should be located in the distribution where this \ file was obtained (LICENSE.txt). A copy of the license may also \ @@ -23,7 +23,7 @@ SYNOPSIS DESCRIPTION ----------- -The <> library provides a common messaging framework +The <> library provides a common messaging framework intended to solve common communication problems in distributed applications. It provides a C language API. @@ -34,10 +34,10 @@ The following common functions exist in _libnng_. [cols="1,4"] |=== -|<>|allocate memory -|<>|create and start a dialer -|<>|free memory -|<>|return an error description +|<>|allocate memory +|<>|create and start a dialer +|<>|free memory +|<>|return an error description |=== Socket Functions @@ -47,14 +47,14 @@ The following functions operate on sockets. [cols="1,4"] |=== -|<>|close a socket -|<>|close all open sockets -|<>|create and start a dialer -|<>|get a socket option -|<>|create and start a listener -|<>|receive data -|<>|send data -|<>|set a socket option +|<>|close a socket +|<>|close all open sockets +|<>|create and start a dialer +|<>|get a socket option +|<>|create and start a listener +|<>|receive data +|<>|send data +|<>|set a socket option |=== Message Functions @@ -70,22 +70,22 @@ Most applications will only interact with the body. [cols="1,4"] |=== -|<>|allocate a message -|<>|return the message body -|<>|free a message -|<>|return the message header -|<>|return the message header length -|<>|return the message body length -|<>|reallocate a message -|<>|receive a message -|<>|send a message +|<>|allocate a message +|<>|return the message body +|<>|free a message +|<>|return the message header +|<>|return the message header length +|<>|return the message body length +|<>|reallocate a message +|<>|receive a message +|<>|send a message |=== Asynchronous Operations ~~~~~~~~~~~~~~~~~~~~~~~ Most applications will interact with _nng_ synchronously; that is that -functions such as <> will block the calling +functions such as <> will block the calling thread until the operation has completed. NOTE: Synchronous operations which send messages may return before the @@ -107,17 +107,17 @@ The following functions are used in the asynchronous model: [cols="1,4"] |=== -|<>|allocate asynchronous I/O context -|<>|cancel asynchronous I/O operation -|<>|free asynchronous I/O context -|<>|get message from an asynchronous receive -|<>|return result from asynchronous operation -|<>|stop asynchronous I/O operation -|<>|wait for an asynchronous I/O operation -|<>|set message for an asynchronous send -|<>|set timeout for an asynchronous send -|<>|receive a message asynchronously -|<>|send a message asynchronously +|<>|allocate asynchronous I/O context +|<>|cancel asynchronous I/O operation +|<>|free asynchronous I/O context +|<>|get message from an asynchronous receive +|<>|return result from asynchronous operation +|<>|stop asynchronous I/O operation +|<>|wait for an asynchronous I/O operation +|<>|set message for an asynchronous send +|<>|set timeout for an asynchronous send +|<>|receive a message asynchronously +|<>|send a message asynchronously |=== Protocols @@ -128,14 +128,14 @@ protocol: [cols="1,4"] |=== -| <>|open a bus socket -| <>|open a pair socket -| <>|open a pub socket -| <>|open a rep socket -| <>|open a req socket -| <>|open a respondent socket -| <>|open a sub socket -| <>|open a surveyor socket +| <>|open a bus socket +| <>|open a pair socket +| <>|open a pub socket +| <>|open a rep socket +| <>|open a req socket +| <>|open a respondent socket +| <>|open a sub socket +| <>|open a surveyor socket |=== Transports @@ -145,13 +145,13 @@ The following functions are used to register a transport for use. [cols="1,4"] |=== -| <>|register inproc transport -| <>|register IPC transport -| <>|register TCP transport -| <>|register TLS transport -| <>|register WebSocket transport -| <>|register WebSocket Secure transport -| <>|register ZeroTier transport +| <>|register inproc transport +| <>|register IPC transport +| <>|register TCP transport +| <>|register TLS transport +| <>|register WebSocket transport +| <>|register WebSocket Secure transport +| <>|register ZeroTier transport |=== TLS Configuration Objects @@ -175,15 +175,15 @@ The following functions are used to manipulate TLS configuration objects. SEE ALSO -------- -<> -<> +<>, +<> COPYRIGHT --------- -Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + -Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] +Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the -https://opensource.org/licenses/LICENSE.txt[MIT License]. +https://opensource.org/licenses/MIT[MIT License]. -- cgit v1.2.3-70-g09d2