diff options
Diffstat (limited to 'docs/man/nng_http_server_start.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_server_start.3http.adoc | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/man/nng_http_server_start.3http.adoc b/docs/man/nng_http_server_start.3http.adoc new file mode 100644 index 00000000..7a631f67 --- /dev/null +++ b/docs/man/nng_http_server_start.3http.adoc @@ -0,0 +1,50 @@ += nng_http_server_start(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_server_start - start HTTP server + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/http/http.h> + +int nng_http_server_start(nng_http_server *server); +---- + +== DESCRIPTION + +The `nng_http_server_start()` starts the HTTP server instance _server_. +This causes it to bind to the appropriate TCP port, and start accepting +connections and handling HTTP requests. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_EADDRINUSE`:: The TCP port is unavaialble. +`NNG_EADDRINVAL`:: The server is configured with an invalid address. +`NNG_ENOMEM`:: Insufficient free memory exists. +`NNG_ENOTSUP`:: HTTP not supported. + +== SEE ALSO + +<<nng_http_server_hold.3http#,nng_http_server_hold(3http)>>, +<<nng_http_server_release.3http#,nng_http_server_release(3http)>>, +<<nng_http_server_stop.3http#,nng_http_server_stop(3http)>>, +<<nng_url_parse.3#,nng_url_parse(3)>> +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng.7#,nng(7)>> |