nng_http_server_set_error_page.3http.adoc

nng_http_server_set_error_page(3http)

NAME

nng_http_server_set_error_page - set custom HTTP error page

SYNOPSIS

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

int nng_http_server_set_error_page(nng_http_server *server,
        uint16_t code, const char *html);

DESCRIPTION

The nng_http_server_set_error_page() sets an error page to be used for HTTP status code on the server instance server. The body content of the HTTP responses will contain html.

The custom HTML content will be used when the server is returning an internally generated error response, or is returning an error response that was allocated with the nng_http_res_alloc_error() function. This HTML content will also be used if the application calls the nng_http_server_res_error(). The last custom error page set for code by either this function or nng_http_server_error_file() will be used.

Note	Error responses that have their body content changed after allocation, or that are written directly by the application, will not use the body content supplied here.

The supplied HTML content is copied by this function, and may be reused after this function returns.

RETURN VALUES

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

ERRORS

NNG_ENOMEM	Insufficient free memory exists.
NNG_ENOTSUP	HTTP not supported.

SEE ALSO

nng_http_res_alloc_error(3http), nng_http_server_hold(3http), nng_http_server_res_error(3http), nng_http_server_set_error_file(3http), nng_strerror(3), nng(7)