This documentation is for the TIP (development tree) of NNG and may represent unreleased changes or functionality that is experimental, and is subject to change before release. The latest released version is v1.8.0. See the documentation for v1.8.0 for the most up-to-date information.

nng_http_res_alloc_error(3http)

NAME

nng_http_res_alloc_error - allocate HTTP error response

SYNOPSIS

#include <nng/nng.h>
#include <nng/supplemental/http/http.h>

int nng_http_res_alloc_error(nng_http_res **resp, uint16_t status);

DESCRIPTION

The nng_http_res_alloc_error() function allocates a new HTTP response structure and stores a pointer to it in resp. The response will be initialized with the status code status, a corresponding reason phrase, and a simple HTML page containing the same information will be generated and attached to the response. (Relevant HTTP headers will be set as well, such as Content-Type and Content-Length.) The HTTP protocol version is also set to "HTTP/1.1".

This is the simplest way to generate an error response.

RETURN VALUES

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

ERRORS

NNG_ENOMEM

Insufficient free memory exists to allocate a message.

NNG_ENOTSUP

HTTP support not configured.

SEE ALSO