aboutsummaryrefslogtreecommitdiff
path: root/docs/libnng.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-05 15:27:31 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-05 15:27:31 -0800
commit3b33f6878ee628da22fd4451f248c036aae231ed (patch)
tree5864cdbddb3315ef7c034f1ea7ad5f87b8f8b5c7 /docs/libnng.adoc
parent68f3fd06531455aec4b2332bed1592795e69c3fa (diff)
downloadnng-3b33f6878ee628da22fd4451f248c036aae231ed.tar.gz
nng-3b33f6878ee628da22fd4451f248c036aae231ed.tar.bz2
nng-3b33f6878ee628da22fd4451f248c036aae231ed.zip
Inital swag at HTTP handler docs.
We will need to document nng_aio_set_output, and both document and create an nng_aio_finish() function.
Diffstat (limited to 'docs/libnng.adoc')
-rw-r--r--docs/libnng.adoc37
1 files changed, 36 insertions, 1 deletions
diff --git a/docs/libnng.adoc b/docs/libnng.adoc
index 37bc01c8..6ecf406b 100644
--- a/docs/libnng.adoc
+++ b/docs/libnng.adoc
@@ -14,7 +14,7 @@ libnng - nanomsg next generation library
== SYNOPSIS
-*cc* ['flags'] 'files' *-lnng* ['libraries']
+*cc* [_flags_] _files_ *-lnng* [_libraries_]
== DESCRIPTION
@@ -230,6 +230,41 @@ and connections.
| <<nng_http_res_set_version#,nng_http_res_set_version(3)>>|set HTTP response protocol version
|===
+==== HTTP Client Functions
+
+These functions are intended for use with HTTP client applications.
+
+|===
+| <<nng_http_client_alloc#,nng_http_client_alloc(3)>>|allocate HTTP client
+| <<nng_http_client_connect#,nng_http_client_connect(3)>>|establish HTTP client connection
+| <<nng_http_client_free#,nng_http_client_free(3)>>|free HTTP client
+| <<nng_http_client_get_tls#,nng_http_client_get_tls(3)>>|get HTTP client TLS configuration
+| <<nng_http_client_set_tls#,nng_http_client_set_tls(3)>>|set HTTP client TLS configuration
+|===
+
+==== HTTP Server Functions
+
+These functions are intended for use with HTTP server applications.
+
+|===
+| <<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>|allocate HTTP server handler
+| <<nng_http_handler_free#,nng_http_handler_free(3)>>|free HTTP server handler
+| <<nng_http_handler_get_data#,nng_http_handler_get_data(3)>>|return extra data for HTTP handler
+| <<nng_http_handler_set_data#,nng_http_handler_set_data(3)>>|set extra data for HTTP handler
+| <<nng_http_handler_set_host#,nng_http_handler_set_host(3)>>|set host for HTTP handler
+| <<nng_http_handler_set_method#,nng_http_handler_set_method(3)>>|set method for HTTP handler
+| <<nng_http_handler_set_tree#,nng_http_handler_set_tree(3)>>|set HTTP handler to match trees
+| <<nng_http_hijack#,nng_http_hijack(3)>>|hijack HTTP server connection
+| <<nng_http_server_add_handler#,nng_http_server_add_handler(3)>>|add HTTP server handler
+| <<nng_http_server_del_handler#,nng_http_server_del_handler(3)>>|delete HTTP server handler
+| <<nng_http_server_get_tls#,nng_http_server_get_tls(3)>>|get HTTP server TLS configuration
+| <<nng_http_server_hold#,nng_http_server_get_tls(3)>>|get and hold HTTP server instance
+| <<nng_http_server_release#,nng_http_server_get_tls(3)>>|release HTTP server instance
+| <<nng_http_server_set_tls#,nng_http_server_set_tls(3)>>|set HTTP server TLS configuration
+| <<nng_http_server_start#,nng_http_server_start(3)>>|start HTTP server
+| <<nng_http_server_stop#,nng_http_server_stop(3)>>|stop HTTP server
+|===
+
=== TLS Configuration Objects
The following functions are used to manipulate transport layer security