aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorFred Eisele <fredrick.eisele@gmail.com>2018-08-09 13:51:26 -0500
committerGarrett D'Amore <garrett@damore.org>2018-08-11 17:21:47 +0300
commitc33c5fc5191bbfe794eac5c3548171c628458495 (patch)
tree11a996fd1e8f88947cc6db02f40b87c0a3e9eb38 /docs/man
parent1a752ba26a7c65c386ae5431b2615ace25db9521 (diff)
downloadnng-c33c5fc5191bbfe794eac5c3548171c628458495.tar.gz
nng-c33c5fc5191bbfe794eac5c3548171c628458495.tar.bz2
nng-c33c5fc5191bbfe794eac5c3548171c628458495.zip
updates to the documentation
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/libnng.3.adoc14
-rw-r--r--docs/man/nng_cv_until.3supp.adoc4
-rw-r--r--docs/man/nng_http_handler_get_data.3http.adoc3
-rw-r--r--docs/man/nng_http_handler_set_data.3http.adoc4
-rw-r--r--docs/man/nng_http_req_del_header.3http.adoc4
-rw-r--r--docs/man/nng_http_req_get_uri.3http.adoc2
-rw-r--r--docs/man/nng_http_server_res_error.3http.adoc2
-rw-r--r--docs/man/nng_tls_config_ca_chain.3tls.adoc3
8 files changed, 17 insertions, 19 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 70fd3be2..ec88cdd0 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -245,7 +245,7 @@ as a convenience to aid in creating portable applications.
|<<nng_cv_until.3supp#,nng_cv_until()>>|wait for condition or timeout
|<<nng_cv_wait.3supp#,nng_cv_wait()>>|wait for condition
|<<nng_cv_wake.3supp#,nng_cv_wake()>>|wake all waiters
-|<<nng_cv_wake1.3supp#,nng_cv_wake()>>|wake one waiter
+|<<nng_cv_wake1.3supp#,nng_cv_wake1()>>|wake one waiter
|<<nng_msleep.3supp#,nng_msleep()>>|sleep for milliseconds
|<<nng_mtx_alloc.3supp#,nng_mtx_alloc()>>|allocate mutex
|<<nng_mtx_free.3supp#,nng_mtx_free()>>|free mutex
@@ -275,11 +275,11 @@ and connections.
|<<nng_http_conn_read.3http#,nng_http_conn_read()>>|read from HTTP connection
|<<nng_http_conn_read_all.3http#,nng_http_conn_read_all()>>|read all from HTTP connection
|<<nng_http_conn_read_req.3http#,nng_http_conn_read_req()>>|read HTTP request
-|<<nng_http_conn_read_res.3http#,nng_http_conn_read_req()>>|read HTTP response
+|<<nng_http_conn_read_res.3http#,nng_http_conn_read_res()>>|read HTTP response
|<<nng_http_conn_write.3http#,nng_http_conn_write()>>|write to HTTP connection
|<<nng_http_conn_write_all.3http#,nng_http_conn_write_all()>>|write all to HTTP connection
-|<<nng_http_conn_write_req.3http#,nng_http_conn_write()>>|write HTTP request
-|<<nng_http_conn_write_res.3http#,nng_http_conn_write()>>|write HTTP response
+|<<nng_http_conn_write_req.3http#,nng_http_conn_write_req()>>|write HTTP request
+|<<nng_http_conn_write_res.3http#,nng_http_conn_write_res()>>|write HTTP response
|<<nng_http_req_add_header.3http#,nng_http_req_add_header()>>|add HTTP request header
|<<nng_http_req_alloc.3http#,nng_http_req_alloc()>>|allocate HTTP request structure
|<<nng_http_req_copy_data.3http#,nng_http_req_copy_data()>>|copy HTTP request body
@@ -339,8 +339,8 @@ These functions are intended for use with HTTP server applications.
|<<nng_http_server_add_handler.3http#,nng_http_server_add_handler()>>|add HTTP server handler
|<<nng_http_server_del_handler.3http#,nng_http_server_del_handler()>>|delete HTTP server handler
|<<nng_http_server_get_tls.3http#,nng_http_server_get_tls()>>|get HTTP server TLS configuration
-|<<nng_http_server_hold.3http#,nng_http_server_get_tls()>>|get and hold HTTP server instance
-|<<nng_http_server_release.3http#,nng_http_server_get_tls()>>|release HTTP server instance
+|<<nng_http_server_hold.3http#,nng_http_server_hold()>>|get and hold HTTP server instance
+|<<nng_http_server_release.3http#,nng_http_server_release()>>|release HTTP server instance
|<<nng_http_server_set_error_file.3http#,nng_http_server_set_error_file()>>|set custom HTTP error file
|<<nng_http_server_set_error_page.3http#,nng_http_server_set_error_page()>>|set custom HTTP error page
|<<nng_http_server_set_tls.3http#,nng_http_server_set_tls()>>|set HTTP server TLS configuration
@@ -362,7 +362,7 @@ with TLS support.
|<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>|set authentication mode
|<<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain()>>|set certificate authority chain
|<<nng_tls_config_ca_file.3tls#,nng_tls_config_ca_file()>>|load certificate authority from file
-|<<nng_tls_config_cert_key_file.3tls#,nng_tls_config_cert_key_file_cert()>>|load own certificate and key from file
+|<<nng_tls_config_cert_key_file.3tls#,nng_tls_config_cert_key_file()>>|load own certificate and key from file
|<<nng_tls_config_own_cert.3tls#,nng_tls_config_own_cert()>>|set own certificate and key
|<<nng_tls_config_free.3tls#,nng_tls_config_free()>>|free TLS configuration
|<<nng_tls_config_server_name.3tls#,nng_tls_config_server_name()>>|set remote server name
diff --git a/docs/man/nng_cv_until.3supp.adoc b/docs/man/nng_cv_until.3supp.adoc
index 707b42b3..085d3c16 100644
--- a/docs/man/nng_cv_until.3supp.adoc
+++ b/docs/man/nng_cv_until.3supp.adoc
@@ -20,7 +20,7 @@ nng_cv_until - wait for condition or timeout
#include <nng/nng.h>
#include <nng/supplemental/util/platform.h>
-int nng_cv_wait(nng_cv *cv, nng_time when);
+int nng_cv_until(nng_cv *cv, nng_time when);
----
== DESCRIPTION
@@ -65,7 +65,7 @@ The following example demonstrates use of this function:
----
nng_mtx_lock(m);
condition_true = true;
- cv_wake(cv);
+ nng_cv_wake(cv);
nng_mtx_unlock(m);
----
diff --git a/docs/man/nng_http_handler_get_data.3http.adoc b/docs/man/nng_http_handler_get_data.3http.adoc
index b926fb2a..f7fcd6f5 100644
--- a/docs/man/nng_http_handler_get_data.3http.adoc
+++ b/docs/man/nng_http_handler_get_data.3http.adoc
@@ -20,8 +20,7 @@ nng_http_handler_get_data - return extra data for HTTP handler
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-int nng_http_handler_get_data(nng_http_handler *handler, void *data,
- void (*dtor)(void *));
+void *nng_http_handler_get_data(nng_http_handler *handler);
----
== DESCRIPTION
diff --git a/docs/man/nng_http_handler_set_data.3http.adoc b/docs/man/nng_http_handler_set_data.3http.adoc
index 120c4618..9fd622b0 100644
--- a/docs/man/nng_http_handler_set_data.3http.adoc
+++ b/docs/man/nng_http_handler_set_data.3http.adoc
@@ -11,7 +11,7 @@
== NAME
-nng_http_handler_get_data - set extra data for HTTP handler
+nng_http_handler_set_data - set extra data for HTTP handler
== SYNOPSIS
@@ -20,7 +20,7 @@ nng_http_handler_get_data - set extra data for HTTP handler
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-void *nng_http_handler_get_data(nng_http_handler *handler, void *data,
+int nng_http_handler_set_data(nng_http_handler *handler, void *data,
void (*dtor)(void *));
----
diff --git a/docs/man/nng_http_req_del_header.3http.adoc b/docs/man/nng_http_req_del_header.3http.adoc
index 48a4326d..51f60fa8 100644
--- a/docs/man/nng_http_req_del_header.3http.adoc
+++ b/docs/man/nng_http_req_del_header.3http.adoc
@@ -11,7 +11,7 @@
== NAME
-nng_http_req_set_header - set HTTP request header
+nng_http_req_del_header - del HTTP request header
== SYNOPSIS
@@ -20,7 +20,7 @@ nng_http_req_set_header - set HTTP request header
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-int nng_http_req_set_header(nng_http_req *req, const char *key);
+int nng_http_req_del_header(nng_http_req *req, const char *key);
----
== DESCRIPTION
diff --git a/docs/man/nng_http_req_get_uri.3http.adoc b/docs/man/nng_http_req_get_uri.3http.adoc
index 22ac1acb..d8b85aa2 100644
--- a/docs/man/nng_http_req_get_uri.3http.adoc
+++ b/docs/man/nng_http_req_get_uri.3http.adoc
@@ -20,7 +20,7 @@ nng_http_req_get_uri - return HTTP request URI
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-const char *nng_http_req_get_method(nng_http_req *req);
+const char *nng_http_req_get_uri(nng_http_req *);
----
== DESCRIPTION
diff --git a/docs/man/nng_http_server_res_error.3http.adoc b/docs/man/nng_http_server_res_error.3http.adoc
index a62628f7..c1ab7f51 100644
--- a/docs/man/nng_http_server_res_error.3http.adoc
+++ b/docs/man/nng_http_server_res_error.3http.adoc
@@ -20,7 +20,7 @@ nng_http_server_res_error - use HTTP server error page
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
-int nng_http_server_set_error_file(nng_http_server *server,
+int nng_http_server_res_error(nng_http_server *server,
nng_http_res *response);
----
diff --git a/docs/man/nng_tls_config_ca_chain.3tls.adoc b/docs/man/nng_tls_config_ca_chain.3tls.adoc
index 65468d41..52e2c1c3 100644
--- a/docs/man/nng_tls_config_ca_chain.3tls.adoc
+++ b/docs/man/nng_tls_config_ca_chain.3tls.adoc
@@ -20,8 +20,7 @@ nng_tls_config_ca_chain - configure certificate authority certificate chain
#include <nng/nng.h>
#include <nng/supplemental/tls/tls.h>
-int nng_tls_config_ca_cert(nng_tls_config *cfg, const char *chain,
- const char *crl);
+int nng_tls_config_ca_chain(nng_tls_config *cfg, const char *chain, const char *crl);
----
== DESCRIPTION