summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_server_start.adoc
blob: 4b7b1a4fb056d2b3d0e6932ca704149a9a8aa39d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
= nng_http_server_start(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_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#,nng_http_server_hold(3)>>,
<<nng_http_server_release#,nng_http_server_release(3)>>,
<<nng_http_server_stop#,nng_http_server_stop(3)>>,
<<nng_url_parse#,nng_url_parse(3)>>
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>