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_method.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_method.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_handler_set_method.3http.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/man/nng_http_handler_set_method.3http.adoc b/docs/man/nng_http_handler_set_method.3http.adoc deleted file mode 100644 index e216ab54..00000000 --- a/docs/man/nng_http_handler_set_method.3http.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_http_handler_set_method(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_set_method - set HTTP handler method - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/http.h> - -void nng_http_handler_set_method(nng_http_handler *handler, const char *method); ----- - -== DESCRIPTION - -The `nng_http_handler_set_method()` function sets the _method_ that the -_handler_ will be called for, such as "GET" or "POST". -(By default the "GET" method is handled.) -If _method_ is `NULL`, then the request method -is not examined, and the handler will be executed regardless of the -method. - -NOTE: The server will automatically call "GET" handlers if the client -sends a "HEAD" request, and will suppress HTTP body data in the responses -sent for such requests. - -NOTE: If _method_ is longer than 32-bytes, it may be truncated silently. - -The handler may always examine the actual method used using the -xref:nng_http_req_get_method.3http.adoc[`nng_http_req_get_method()`] function. - -== 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_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)], -xref:nng.7.adoc[nng(7)] |