aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_req_set_method.3http.adoc
blob: 9cd4f638ac1b1b88067a7113c4f04350127fa262 (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
= nng_http_req_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_req_set_method - set HTTP request method

== SYNOPSIS

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

void nng_http_req_set_method(nng_http_req *req, const char *method);
----

== DESCRIPTION

The `nng_http_req_set_method()` sets the HTTP method associated with
the request _req_ to _method_.  The _method_ must be a string,
such as "GET" or "POST", and the HTTP specifications indicate that it must
be upper case.

The default value method for newly allocated requests is "GET".

If the method is longer than 32 bytes, it may be silently truncated.
(There are no methods defined that are this long.)

A local copy of the _method_ is made in the request _req_.

== SEE ALSO

[.text-left]
xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)],
xref:nng_http_req_get_method.3http.adoc[nng_http_req_get_method(3http)],
xref:nng.7.adoc[nng(7)]