diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_handler_set_host.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_http_handler_set_host.adoc')
| -rw-r--r-- | docs/nng_http_handler_set_host.adoc | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/nng_http_handler_set_host.adoc b/docs/nng_http_handler_set_host.adoc deleted file mode 100644 index d3e464e3..00000000 --- a/docs/nng_http_handler_set_host.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_http_handler_set_host(3) -// -// 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_set_host - set host for HTTP handler - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> -#include <nng/supplemental/http/http.h> - -int 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. (Canonicaliztion -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. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient free memory to perform the operation. -`NNG_ENOTSUP`:: No support for HTTP in the library. - -== SEE ALSO - -<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>, -<<nng_http_server_add_handler#,nng_http_server_add_handler(3)>>, -<<nng#,nng(7)>> |