doompanning/external/nng/docs/man/nng_http_req_reset.3http.adoc

49 lines
1.2 KiB
Text
Raw Normal View History

= nng_http_req_reset(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_reset - reset HTTP request structure
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_req_reset(nng_http_req *req);
----
== DESCRIPTION
The `nng_http_req_reset()` function resets the request __req__ so that it
is just as if it had been freshly allocated with
xref:nng_http_req_alloc.3http.adoc[`nng_http_req_alloc()`] with a `NULL` URL.
NOTE: Before using this with an HTTP operation, the URI must be set using
xref:nng_http_req_set_uri.3http.adoc[`nng_http_req_set_uri()`].
== RETURN VALUES
None.
== ERRORS
None.
== SEE ALSO
[.text-left]
xref:nng_http_req_alloc.3http.adoc[nng_http_req_alloc(3http)],
xref:nng_http_req_set_uri.3http.adoc[nng_http_req_set_uri(3http)],
xref:nng.7.adoc[nng(7)]