From 768e3f7343fdeab4e8531d8a772e619e6c1c4e2e Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 20 Aug 2018 07:35:51 -0700 Subject: man page updates for tip --- man/tip/index.html | 2 +- man/tip/libnng.3.html | 14 ++++++------ man/tip/nng_aio_result.3.html | 2 +- man/tip/nng_cv_until.3supp.html | 4 ++-- man/tip/nng_http_handler_get_data.3http.html | 3 +-- man/tip/nng_http_handler_set_data.3http.html | 4 ++-- man/tip/nng_http_req_del_header.3http.html | 4 ++-- man/tip/nng_http_req_get_uri.3http.html | 4 ++-- man/tip/nng_http_server_res_error.3http.html | 2 +- man/tip/nng_http_server_stop.3http.html | 32 +++++++++++++++++++++++++--- man/tip/nng_tcp.7.html | 16 -------------- man/tip/nng_tls.7.html | 16 -------------- man/tip/nng_tls_config_ca_chain.3tls.html | 3 +-- man/tip/nng_ws.7.html | 15 ------------- 14 files changed, 49 insertions(+), 72 deletions(-) diff --git a/man/tip/index.html b/man/tip/index.html index 0d29a10b..f870a6f0 100644 --- a/man/tip/index.html +++ b/man/tip/index.html @@ -1167,7 +1167,7 @@ Protocols sockets.

nng_http_req_del_header(3http)

-

set HTTP request header

+

delete HTTP request header

nng_http_req_free(3http)

diff --git a/man/tip/libnng.3.html b/man/tip/libnng.3.html index c8be729e..81032996 100644 --- a/man/tip/libnng.3.html +++ b/man/tip/libnng.3.html @@ -1201,7 +1201,7 @@ as a convenience to aid in creating portable applications.

wake all waiters

-

nng_cv_wake()

+

nng_cv_wake1()

wake one waiter

@@ -1280,7 +1280,7 @@ and connections.

read HTTP request

-

nng_http_conn_read_req()

+

nng_http_conn_read_res()

read HTTP response

@@ -1292,11 +1292,11 @@ and connections.

write all to HTTP connection

-

nng_http_conn_write()

+

nng_http_conn_write_req()

write HTTP request

-

nng_http_conn_write()

+

nng_http_conn_write_res()

write HTTP response

@@ -1508,11 +1508,11 @@ and connections.

get HTTP server TLS configuration

-

nng_http_server_get_tls()

+

nng_http_server_hold()

get and hold HTTP server instance

-

nng_http_server_get_tls()

+

nng_http_server_release()

release HTTP server instance

@@ -1585,7 +1585,7 @@ with TLS support.

load certificate authority from file

-

nng_tls_config_cert_key_file_cert()

+

nng_tls_config_cert_key_file()

load own certificate and key from file

diff --git a/man/tip/nng_aio_result.3.html b/man/tip/nng_aio_result.3.html index d758a35f..2218a182 100644 --- a/man/tip/nng_aio_result.3.html +++ b/man/tip/nng_aio_result.3.html @@ -527,7 +527,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#include <nng/nng.h>
 
-int nng_aio_wait(nng_aio *aio);
+int nng_aio_result(nng_aio *aio);
diff --git a/man/tip/nng_cv_until.3supp.html b/man/tip/nng_cv_until.3supp.html index 9331a092..28dd3b3a 100644 --- a/man/tip/nng_cv_until.3supp.html +++ b/man/tip/nng_cv_until.3supp.html @@ -529,7 +529,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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); @@ -593,7 +593,7 @@ tests for true. 
    nng_mtx_lock(m);
     condition_true = true;
-    cv_wake(cv);
+    nng_cv_wake(cv);
     nng_mtx_unlock(m);
diff --git a/man/tip/nng_http_handler_get_data.3http.html b/man/tip/nng_http_handler_get_data.3http.html index 8ef8efa1..c0f59ea3 100644 --- a/man/tip/nng_http_handler_get_data.3http.html +++ b/man/tip/nng_http_handler_get_data.3http.html @@ -528,8 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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); diff --git a/man/tip/nng_http_handler_set_data.3http.html b/man/tip/nng_http_handler_set_data.3http.html index b587d005..0674ba2b 100644 --- a/man/tip/nng_http_handler_set_data.3http.html +++ b/man/tip/nng_http_handler_set_data.3http.html @@ -516,7 +516,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

NAME

-

nng_http_handler_get_data - set extra data for HTTP handler

+

nng_http_handler_set_data - set extra data for HTTP handler

@@ -528,7 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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/man/tip/nng_http_req_del_header.3http.html b/man/tip/nng_http_req_del_header.3http.html index bfa8609c..ace2c646 100644 --- a/man/tip/nng_http_req_del_header.3http.html +++ b/man/tip/nng_http_req_del_header.3http.html @@ -516,7 +516,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

NAME

-

nng_http_req_set_header - set HTTP request header

+

nng_http_req_del_header - delete HTTP request header

@@ -528,7 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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);
diff --git a/man/tip/nng_http_req_get_uri.3http.html b/man/tip/nng_http_req_get_uri.3http.html index 82e47865..2e42a31c 100644 --- a/man/tip/nng_http_req_get_uri.3http.html +++ b/man/tip/nng_http_req_get_uri.3http.html @@ -528,7 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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 *req); @@ -538,7 +538,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

The nng_http_req_get_uri() returns the URI (path) associated with the HTTP -the request req. +request req. The value returned includes the path, as well as any query information or fragment. The value will look like a file system path with those optional components appended, such as /api/get_info.cgi?name=garrett.

diff --git a/man/tip/nng_http_server_res_error.3http.html b/man/tip/nng_http_server_res_error.3http.html index 1541ee1f..749bdfa5 100644 --- a/man/tip/nng_http_server_res_error.3http.html +++ b/man/tip/nng_http_server_res_error.3http.html @@ -528,7 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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/man/tip/nng_http_server_stop.3http.html b/man/tip/nng_http_server_stop.3http.html index ab07b63a..8443d588 100644 --- a/man/tip/nng_http_server_stop.3http.html +++ b/man/tip/nng_http_server_stop.3http.html @@ -537,9 +537,34 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

DESCRIPTION

-

The nng_http_server_stop() stops the HTTP server instance server. -This will cause it to close any underlying TCP sockets, and to terminate -any HTTP connections associated with it.

+

The nng_http_server_stop() undoes the effect of +nng_http_server_start().

+
+
+

Each call by +nng_http_server_start() acts as reference +count, and should be matched by a call to nng_http_server_stop(). +When the reference count drops to zero, then the server is actually stopped, +and existing open connections to it are closed.

+
+
+

This function does not wait for the connections to close.

+
+
+ + + + + +
+ + +Once the server instance is actually stopped, it cannot be started again, +and any future calls to nng_http_server_hold() +will return a new instance of the server. +It is expected that the caller will follow this function call with a call to +nng_http_server_release(). +
@@ -564,6 +589,7 @@ any HTTP connections associated with it.

nng_http_server_hold(3http), +nng_http_server_release(3http), nng_http_server_start(3http), nng(7)

diff --git a/man/tip/nng_tcp.7.html b/man/tip/nng_tcp.7.html index 5ac7fe68..2f8c3436 100644 --- a/man/tip/nng_tcp.7.html +++ b/man/tip/nng_tcp.7.html @@ -617,22 +617,6 @@ separating the port.

For example, the same port 80 on the IPv6 loopback address (::1) would be specified as tcp://[::1]:80.

-
- - - - - -
- - -When using symbolic names, the name is resolved when the -name is first used. nng won’t become aware of changes in the -name resolution until restart, -usually. -(This is a bug and will likely be fixed in the future.) -
-

The special value of 0 (INADDR_ANY) can be used for a listener to indicate that it should listen on all diff --git a/man/tip/nng_tls.7.html b/man/tip/nng_tls.7.html index 9ba38340..25e4e389 100644 --- a/man/tip/nng_tls.7.html +++ b/man/tip/nng_tls.7.html @@ -665,22 +665,6 @@ separating the port.

For example, the same port 4433 on the IPv6 loopback address ('::1') would be specified as tls+tcp://[::1]:4433.

-
- - - - - -
- - -When using symbolic names, the name is resolved when the -name is first used. nng won’t become aware of changes in the -name resolution until restart, -usually. -(This is a bug and will likely be fixed in the future.) -
-
diff --git a/man/tip/nng_tls_config_ca_chain.3tls.html b/man/tip/nng_tls_config_ca_chain.3tls.html index 37e00d40..68815cd9 100644 --- a/man/tip/nng_tls_config_ca_chain.3tls.html +++ b/man/tip/nng_tls_config_ca_chain.3tls.html @@ -528,8 +528,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
#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);
+intnng_tls_config_ca_chain(nng_tls_config*cfg,constchar*chain,constchar*crl); diff --git a/man/tip/nng_ws.7.html b/man/tip/nng_ws.7.html index e1891869..2ee5551d 100644 --- a/man/tip/nng_ws.7.html +++ b/man/tip/nng_ws.7.html @@ -598,21 +598,6 @@ would be specified as ws://[::1]/app/pubsub.

- -
-When using symbolic names, the name is resolved when the -name is first used. nng won’t become aware of changes in the -name resolution until restart, -usually. (This is a bug and will likely be fixed in the future.) -
-
-
- - - - -- cgit v1.2.3-70-g09d2
- - The value specified as the host, if any, will also be used in the Host: HTTP header during HTTP negotiation.