= nng_http_res_set_status(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_res_set_status - set HTTP response status
|
|
== SYNOPSIS
|
|
[source, c]
|
----
|
#include <nng/nng.h>
|
#include <nng/supplemental/http/http.h>
|
|
int nng_http_res_set_status(nng_http_res *res, uint16_t status);
|
----
|
|
== DESCRIPTION
|
|
The `nng_http_res_set_status()` sets the numeric HTTP status code
|
associated with the response _res_ to _status_.
|
The default value for a newly allocated response is 200 (`NNG_HTTP_STATUS_OK`).
|
|
The _status_ is not verified, so the caller should take care to ensure
|
that only a valid code is supplied.
|
|
For convenience, a number of predefined symbols are available.
|
|
[source, c]
|
----
|
enum {
|
NNG_HTTP_STATUS_CONTINUE = 100,
|
NNG_HTTP_STATUS_SWITCHING = 101,
|
NNG_HTTP_STATUS_PROCESSING = 102,
|
NNG_HTTP_STATUS_OK = 200,
|
NNG_HTTP_STATUS_CREATED = 201,
|
NNG_HTTP_STATUS_ACCEPTED = 202,
|
NNG_HTTP_STATUS_NOT_AUTHORITATIVE = 203,
|
NNG_HTTP_STATUS_NO_CONTENT = 204,
|
NNG_HTTP_STATUS_RESET_CONTENT = 205,
|
NNG_HTTP_STATUS_PARTIAL_CONTENT = 206,
|
NNG_HTTP_STATUS_MULTI_STATUS = 207,
|
NNG_HTTP_STATUS_ALREADY_REPORTED = 208,
|
NNG_HTTP_STATUS_IM_USED = 226,
|
NNG_HTTP_STATUS_MULTIPLE_CHOICES = 300,
|
NNG_HTTP_STATUS_STATUS_MOVED_PERMANENTLY = 301,
|
NNG_HTTP_STATUS_FOUND = 302,
|
NNG_HTTP_STATUS_SEE_OTHER = 303,
|
NNG_HTTP_STATUS_NOT_MODIFIED = 304,
|
NNG_HTTP_STATUS_USE_PROXY = 305,
|
NNG_HTTP_STATUS_TEMPORARY_REDIRECT = 307,
|
NNG_HTTP_STATUS_PERMANENT_REDIRECT = 308,
|
NNG_HTTP_STATUS_BAD_REQUEST = 400,
|
NNG_HTTP_STATUS_UNAUTHORIZED = 401,
|
NNG_HTTP_STATUS_PAYMENT_REQUIRED = 402,
|
NNG_HTTP_STATUS_FORBIDDEN = 403,
|
NNG_HTTP_STATUS_NOT_FOUND = 404,
|
NNG_HTTP_STATUS_METHOD_NOT_ALLOWED = 405,
|
NNG_HTTP_STATUS_NOT_ACCEPTABLE = 406,
|
NNG_HTTP_STATUS_PROXY_AUTH_REQUIRED = 407,
|
NNG_HTTP_STATUS_REQUEST_TIMEOUT = 408,
|
NNG_HTTP_STATUS_CONFLICT = 409,
|
NNG_HTTP_STATUS_GONE = 410,
|
NNG_HTTP_STATUS_LENGTH_REQUIRED = 411,
|
NNG_HTTP_STATUS_PRECONDITION_FAILED = 412,
|
NNG_HTTP_STATUS_PAYLOAD_TOO_LARGE = 413,
|
NNG_HTTP_STATUS_ENTITY_TOO_LONG = 414,
|
NNG_HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415,
|
NNG_HTTP_STATUS_RANGE_NOT_SATISFIABLE = 416,
|
NNG_HTTP_STATUS_EXPECTATION_FAILED = 417,
|
NNG_HTTP_STATUS_TEAPOT = 418,
|
NNG_HTTP_STATUS_UNPROCESSABLE_ENTITY = 422,
|
NNG_HTTP_STATUS_LOCKED = 423,
|
NNG_HTTP_STATUS_FAILED_DEPENDENCY = 424,
|
NNG_HTTP_STATUS_UPGRADE_REQUIRED = 426,
|
NNG_HTTP_STATUS_PRECONDITION_REQUIRED = 428,
|
NNG_HTTP_STATUS_TOO_MANY_REQUESTS = 429,
|
NNG_HTTP_STATUS_HEADERS_TOO_LARGE = 431,
|
NNG_HTTP_STATUS_UNAVAIL_LEGAL_REASONS = 451,
|
NNG_HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
|
NNG_HTTP_STATUS_NOT_IMPLEMENTED = 501,
|
NNG_HTTP_STATUS_BAD_GATEWAY = 502,
|
NNG_HTTP_STATUS_SERVICE_UNAVAILABLE = 503,
|
NNG_HTTP_STATUS_GATEWAY_TIMEOUT = 504,
|
NNG_HTTP_STATUS_HTTP_VERSION_NOT_SUPP = 505,
|
NNG_HTTP_STATUS_VARIANT_ALSO_NEGOTIATES = 506,
|
NNG_HTTP_STATUS_INSUFFICIENT_STORAGE = 507,
|
NNG_HTTP_STATUS_LOOP_DETECTED = 508,
|
NNG_HTTP_STATUS_NOT_EXTENDED = 510,
|
NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED = 511,
|
};
|
----
|
|
Please see the relevant HTTP RFCs for the semantics and correct
|
use of these status codes.
|
|
TIP: It is a good idea to also set the reason message with
|
xref:nng_http_res_set_reason.3http.adoc[`nng_http_set_reason()`].
|
This will help any humans who may have to diagnose a failure.
|
|
== RETURN VALUES
|
|
This function returns 0 on success, and non-zero otherwise.
|
|
== ERRORS
|
|
[horizontal]
|
`NNG_ENOTSUP`:: No support for HTTP in the library.
|
|
== SEE ALSO
|
|
[.text-left]
|
xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)],
|
xref:nng_http_res_get_status.3http.adoc[nng_http_req_get_status(3http)],
|
xref:nng_http_res_set_reason.3http.adoc[nng_http_req_set_reason(3http)],
|
xref:nng.7.adoc[nng(7)]
|
