diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-15 08:14:00 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-15 08:14:00 -0800 |
| commit | c4ca4834e39e48676ea50df1fc6239c7dc2a56ff (patch) | |
| tree | 00c98a535ac96b34a5e2e221674a3bf385e45ca0 /docs/man/nng_http_handler_set_host.3http.adoc | |
| parent | cd9901549239bbe424bc70a48b09f33064d906b6 (diff) | |
| download | nng-c4ca4834e39e48676ea50df1fc6239c7dc2a56ff.tar.gz nng-c4ca4834e39e48676ea50df1fc6239c7dc2a56ff.tar.bz2 nng-c4ca4834e39e48676ea50df1fc6239c7dc2a56ff.zip | |
http docs: documentation conversion for http handlers
This is not yet fully complete, but it's most of the content.
Diffstat (limited to 'docs/man/nng_http_handler_set_host.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_handler_set_host.3http.adoc | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/man/nng_http_handler_set_host.3http.adoc b/docs/man/nng_http_handler_set_host.3http.adoc deleted file mode 100644 index e3d5e80a..00000000 --- a/docs/man/nng_http_handler_set_host.3http.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= nng_http_handler_set_host(3http) -// -// Copyright 2024 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_set_host - set host for HTTP handler - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/http.h> - -void nng_http_handler_set_host(nng_http_handler *handler, const char *host); ----- - -== DESCRIPTION - -The `nng_http_handler_set_host()` function is used to limit the scope of the -_handler_ so that it will only be called when the specified _host_ matches -the value of the `Host:` HTTP header. - -TIP: This can be used to create servers with multiple handlers for virtual -hosting. - -The value of the _host_ can include a colon and port, and should match -exactly the value of the `Host` header sent by the client. -(Canonicalization of the host name is performed though.) - -TIP: As the server framework does not support listening on multiple -ports, the port number can be elided. -The matching test only considers -the hostname or IP address, and ignores any trailing port number. - -NOTE: This should not be used with an IP address normally, as `Host:` header -is used with virtual hosts in HTTP/1.1, and not supported for HTTP/1.0. - -== SEE ALSO - -[.text-left] -xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], -xref:nng_http_server_add_handler.3http.adoc[nng_http_server_add_handler(3http)], -xref:nng.7.adoc[nng(7)] |