diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_res_alloc.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_http_res_alloc.adoc')
| -rw-r--r-- | docs/nng_http_res_alloc.adoc | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/nng_http_res_alloc.adoc b/docs/nng_http_res_alloc.adoc deleted file mode 100644 index 9de3d012..00000000 --- a/docs/nng_http_res_alloc.adoc +++ /dev/null @@ -1,64 +0,0 @@ -= nng_http_res_alloc(3) -// -// 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#,nng_http_res_alloc_error(3)>> 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#,nng_http_conn_read_res(3)>>, -<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>, -<<nng_http_req_alloc#,nng_http_req_alloc(3)>>, -<<nng_http_res_alloc_errror#,nng_http_res_alloc_error(3)>>, -<<nng_http_res_add_header#,nng_http_res_add_header(3)>>, -<<nng_http_res_copy_data#,nng_http_res_copy_data(3)>>, -<<nng_http_res_del_header#,nng_http_res_del_header(3)>>, -<<nng_http_res_free#,nng_http_res_free(3)>>, -<<nng_http_res_get_header#,nng_http_res_get_header(3)>>, -<<nng_http_res_get_reason#,nng_http_res_get_reason(3)>>, -<<nng_http_res_get_status#,nng_http_res_get_status(3)>>, -<<nng_http_res_get_version#,nng_http_res_get_version(3)>>, -<<nng_http_res_set_data#,nng_http_res_set_data(3)>>, -<<nng_http_res_set_reason#,nng_http_res_set_reason(3)>>, -<<nng_http_res_set_status#,nng_http_res_set_status(3)>>, -<<nng_http_res_set_version#,nng_http_res_set_version(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |
