aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_handler_set_method.adoc
blob: c3d8fbeb1af5cb93e06b833ab3ba114db24d5c8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
= nng_http_handler_set_method(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
            {blank} + \
            This document is supplied under the terms of the \
            https://opensource.org/licenses/MIT[MIT License].

== NAME

nng_http_handler_set_method - set HTTP handler method

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>

int 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: No validation of the _method_ is performed, but HTTP specifications
insist that the actual method sent over the wire be capitalized.

The handler may always examine the actual method used using the
<<nng_http_req_get_method#,nng_http_req_get_method(3)>> function.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_ENOMEM`:: Insufficient free memory exists.
`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_http_req_get_method#,nng_http_req_get_method(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

{copyright}