diff options
Diffstat (limited to 'docs/man/nng_http_res_alloc.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_res_alloc.3http.adoc | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/man/nng_http_res_alloc.3http.adoc b/docs/man/nng_http_res_alloc.3http.adoc new file mode 100644 index 00000000..10638ee7 --- /dev/null +++ b/docs/man/nng_http_res_alloc.3http.adoc @@ -0,0 +1,65 @@ += nng_http_res_alloc(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_alloc - allocate HTTP response structure + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> +#include <nng/supplemental/http/http.h> + +int nng_http_res_alloc(nng_http_res **resp); +----------- + +== DESCRIPTION + +The `nng_http_res_alloc()` function allocates a new HTTP response structure +and stores a pointer to it in __resp__. +The response will be initialized +with status code 200 (`NNG_HTTP_STATUS_OK`), and a reason phrase of "OK", +and HTTP protocol version "HTTP/1.1". + +TIP: When an error response is needed, consider using +<<nng_http_res_alloc_error.3http#,`nng_http_res_alloc_error()`>> instead. + +== 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 + +<<nng_http_conn_read_res.3http#,nng_http_conn_read_res(3http)>>, +<<nng_http_conn_write_res.3http#,nng_http_conn_write_res(3http)>>, +<<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>, +<<nng_http_res_alloc_error.3http#,nng_http_res_alloc_error(3http)>>, +<<nng_http_res_add_header.3http#,nng_http_res_add_header(3http)>>, +<<nng_http_res_copy_data.3http#,nng_http_res_copy_data(3http)>>, +<<nng_http_res_del_header.3http#,nng_http_res_del_header(3http)>>, +<<nng_http_res_free.3http#,nng_http_res_free(3http)>>, +<<nng_http_res_get_header.3http#,nng_http_res_get_header(3http)>>, +<<nng_http_res_get_reason.3http#,nng_http_res_get_reason(3http)>>, +<<nng_http_res_get_status.3http#,nng_http_res_get_status(3http)>>, +<<nng_http_res_get_version.3http#,nng_http_res_get_version(3http)>>, +<<nng_http_res_set_data.3http#,nng_http_res_set_data(3http)>>, +<<nng_http_res_set_reason.3http#,nng_http_res_set_reason(3http)>>, +<<nng_http_res_set_status.3http#,nng_http_res_set_status(3http)>>, +<<nng_http_res_set_version.3http#,nng_http_res_set_version(3http)>>, +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng.7#,nng(7)>> |
