From 0ce510f5871c70609b2d9af2b174e35c09653889 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 22 Feb 2018 10:22:34 -0800 Subject: Added pipeline references, adjusted markup for consistency. --- docs/libnng.adoc | 149 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 75 insertions(+), 74 deletions(-) diff --git a/docs/libnng.adoc b/docs/libnng.adoc index 3262bf38..f727e17f 100644 --- a/docs/libnng.adoc +++ b/docs/libnng.adoc @@ -30,7 +30,6 @@ The following common functions exist in _libnng_. |=== |<>|allocate memory -|<>|create and start a dialer |<>|free memory |<>|return an error description |=== @@ -162,14 +161,16 @@ The following functions are used to construct a socket with a specific protocol: |=== -| <>|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 pull socket +|<>|open a push socket +|<>|open a rep socket +|<>|open a req socket +|<>|open a respondent socket +|<>|open a sub socket +|<>|open a surveyor socket |=== === Transports @@ -192,9 +193,9 @@ Common functionality is supplied for parsing and handling universal resource locators (URLS). |=== -| <>|clone URL structure -| <>|free URL structure -| <>|create URL structure from string +|<>|clone URL structure +|<>|free URL structure +|<>|create URL structure from string |=== @@ -211,44 +212,44 @@ The following functions are used to work with HTTP requests, responses, and connections. |=== -| <>|close HTTP connection -| <>|read from HTTP connection -| <>|read all from HTTP connection -| <>|read HTTP request -| <>|read HTTP response -| <>|write to HTTP connection -| <>|write all to HTTP connection -| <>|write HTTP request -| <>|write HTTP response -| <>|add HTTP request header -| <>|allocate HTTP request structure -| <>|copy HTTP request body -| <>|delete HTTP request header -| <>|free HTTP request structure -| <>|return HTTP request header -| <>|return HTTP request method -| <>|return HTTP request URI -| <>|return HTTP request protocol version -| <>|set HTTP request body -| <>|set HTTP request header -| <>|set HTTP request method -| <>|set HTTP request URI -| <>|set HTTP request protocol version -| <>|add HTTP response header -| <>|allocate HTTP response structure -| <>|allocate HTTP error response -| <>|copy HTTP response body -| <>|delete HTTP response header -| <>|free HTTP response structure -| <>|set HTTP response body -| <>|return HTTP response header -| <>|return HTTP response reason -| <>|return HTTP response status -| <>|return HTTP response protocol version -| <>|set HTTP response header -| <>|set HTTP response reason -| <>|set HTTP response status -| <>|set HTTP response protocol version +|<>|close HTTP connection +|<>|read from HTTP connection +|<>|read all from HTTP connection +|<>|read HTTP request +|<>|read HTTP response +|<>|write to HTTP connection +|<>|write all to HTTP connection +|<>|write HTTP request +|<>|write HTTP response +|<>|add HTTP request header +|<>|allocate HTTP request structure +|<>|copy HTTP request body +|<>|delete HTTP request header +|<>|free HTTP request structure +|<>|return HTTP request header +|<>|return HTTP request method +|<>|return HTTP request URI +|<>|return HTTP request protocol version +|<>|set HTTP request body +|<>|set HTTP request header +|<>|set HTTP request method +|<>|set HTTP request URI +|<>|set HTTP request protocol version +|<>|add HTTP response header +|<>|allocate HTTP response structure +|<>|allocate HTTP error response +|<>|copy HTTP response body +|<>|delete HTTP response header +|<>|free HTTP response structure +|<>|set HTTP response body +|<>|return HTTP response header +|<>|return HTTP response reason +|<>|return HTTP response status +|<>|return HTTP response protocol version +|<>|set HTTP response header +|<>|set HTTP response reason +|<>|set HTTP response status +|<>|set HTTP response protocol version |=== ==== HTTP Client Functions @@ -268,22 +269,22 @@ These functions are intended for use with HTTP client applications. These functions are intended for use with HTTP server applications. |=== -| <>|allocate HTTP server handler -| <>|free HTTP server handler -| <>|return extra data for HTTP handler -| <>|set extra data for HTTP handler -| <>|set host for HTTP handler -| <>|set HTTP handler method -| <>|set HTTP handler to match trees -| <>|hijack HTTP server connection -| <>|add HTTP server handler -| <>|delete HTTP server handler -| <>|get HTTP server TLS configuration -| <>|get and hold HTTP server instance -| <>|release HTTP server instance -| <>|set HTTP server TLS configuration -| <>|start HTTP server -| <>|stop HTTP server +|<>|allocate HTTP server handler +|<>|free HTTP server handler +|<>|return extra data for HTTP handler +|<>|set extra data for HTTP handler +|<>|set host for HTTP handler +|<>|set HTTP handler method +|<>|set HTTP handler to match trees +|<>|hijack HTTP server connection +|<>|add HTTP server handler +|<>|delete HTTP server handler +|<>|get HTTP server TLS configuration +|<>|get and hold HTTP server instance +|<>|release HTTP server instance +|<>|set HTTP server TLS configuration +|<>|start HTTP server +|<>|stop HTTP server |=== === TLS Configuration Objects @@ -295,14 +296,14 @@ NOTE: These functions will only be present if the library has been built with TLS support. |=== -| <>|allocate TLS configuration -| <>|set authentication mode -| <>|set certificate authority chain -| <>|load certificate authority from file -| <>|load own certificate and key from file -| <>|set own certificate and key -| <>|free TLS configuration -| <>|set remote server name +|<>|allocate TLS configuration +|<>|set authentication mode +|<>|set certificate authority chain +|<>|load certificate authority from file +|<>|load own certificate and key from file +|<>|set own certificate and key +|<>|free TLS configuration +|<>|set remote server name |=== -- cgit v1.2.3-70-g09d2