aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-12 10:42:54 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-12 10:52:03 -0800
commitc34abc224e572b19fb5aa1b5afc8841705485d14 (patch)
tree82f6a936ae84fbece104dfb07b0b7c9ac0581dc8 /docs
parente5721f6b4dd7e4084a14b6f2f38bfb3672796ac9 (diff)
downloadnng-c34abc224e572b19fb5aa1b5afc8841705485d14.tar.gz
nng-c34abc224e572b19fb5aa1b5afc8841705485d14.tar.bz2
nng-c34abc224e572b19fb5aa1b5afc8841705485d14.zip
http: remove unused nng_http_handler_get_data
The data is now passed directly to the handler function.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/libnng.3.adoc27
-rw-r--r--docs/man/nng_http_handler_get_data.3http.adoc46
-rw-r--r--docs/man/nng_http_handler_set_data.3http.adoc3
3 files changed, 0 insertions, 76 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 5bc947b1..eddc434f 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -93,32 +93,6 @@ be the case if WebSocket support is configured as well.
In this case, it is possible to access functionality to support the creation of
HTTP (and HTTP/S if TLS support is present) servers and clients.
-==== Common HTTP Functions
-
-The following functions are used to work with HTTP requests, responses,
-and connections.
-
-|===
-|xref:nng_http_conn_read_req.3http.adoc[nng_http_conn_read_req()]|read HTTP request
-|xref:nng_http_conn_read_res.3http.adoc[nng_http_conn_read_res()]|read HTTP response
-|xref:nng_http_conn_write_req.3http.adoc[nng_http_conn_write_req()]|write HTTP request
-|xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res()]|write HTTP response
-|xref:nng_http_req_get_data.3http.adoc[nng_http_req_get_data()]|get HTTP request body
-|xref:nng_http_req_set_data.3http.adoc[nng_http_req_set_data()]|set HTTP request body
-|xref:nng_http_res_copy_data.3http.adoc[nng_http_res_copy_data()]|copy HTTP response body
-|xref:nng_http_res_get_data.3http.adoc[nng_http_res_get_data()]|get HTTP response body
-|xref:nng_http_res_get_header.3http.adoc[nng_http_res_get_header()]|return HTTP response header
-|xref:nng_http_res_set_data.3http.adoc[nng_http_res_set_data()]|set HTTP response body
-|===
-
-==== HTTP Client Functions
-
-These functions are intended for use with HTTP client applications.
-
-|===
-|xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact()]|perform one HTTP transaction on connection
-|===
-
==== HTTP Server Functions
These functions are intended for use with HTTP server applications.
@@ -127,7 +101,6 @@ These functions are intended for use with HTTP server applications.
|xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc()]|allocate HTTP server handler
|xref:nng_http_handler_collect_body.3http.adoc[nng_http_handler_collect_body()]|set HTTP handler to collect request body
|xref:nng_http_handler_free.3http.adoc[nng_http_handler_free()]|free HTTP server handler
-|xref:nng_http_handler_get_data.3http.adoc[nng_http_handler_get_data()]|return extra data for HTTP handler
|xref:nng_http_handler_set_data.3http.adoc[nng_http_handler_set_data()]|set extra data for HTTP handler
|xref:nng_http_handler_set_host.3http.adoc[nng_http_handler_set_host()]|set host for HTTP handler
|xref:nng_http_handler_set_method.3http.adoc[nng_http_handler_set_method()]|set HTTP handler method
diff --git a/docs/man/nng_http_handler_get_data.3http.adoc b/docs/man/nng_http_handler_get_data.3http.adoc
deleted file mode 100644
index 0f2396f6..00000000
--- a/docs/man/nng_http_handler_get_data.3http.adoc
+++ /dev/null
@@ -1,46 +0,0 @@
-= nng_http_handler_get_data(3http)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document 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 be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_http_handler_get_data - return extra data for HTTP handler
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/http.h>
-
-void *nng_http_handler_get_data(nng_http_handler *handler);
-----
-
-== DESCRIPTION
-
-The `nng_http_handler_get_data()` function returns the data previously
-stored on _handler_ using the function
-xref:nng_http_handler_set_data.3http.adoc[`nng_http_handler_set_data()`].
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)],
-xref:nng_http_handler_set_data.3http.adoc[nng_http_server_set_data(3http)],
-xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_http_handler_set_data.3http.adoc b/docs/man/nng_http_handler_set_data.3http.adoc
index e83ecb6b..91d2b122 100644
--- a/docs/man/nng_http_handler_set_data.3http.adoc
+++ b/docs/man/nng_http_handler_set_data.3http.adoc
@@ -28,8 +28,6 @@ void nng_http_handler_set_data(nng_http_handler *handler, void *data,
The `nng_http_handler_set_data()` function is used to set an additional
_data_ for the _handler_.
-The stored _data_ can be retrieved later in the handler function using
-xref:nng_http_handler_get_data.3http.adoc[`nng_http_handler_get_data()`].
Additionally, when the handler is deallocated, if _dtor_ is not `NULL`,
then it will be called with _data_ as its argument.
@@ -40,6 +38,5 @@ this function is deallocate any resources associated with _data_.
[.text-left]
xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)],
-xref:nng_http_handler_get_data.3http.adoc[nng_http_server_get_data(3http)],
xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)],
xref:nng.7.adoc[nng(7)]