diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-06 16:07:10 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-06 16:07:10 -0800 |
| commit | 51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 (patch) | |
| tree | f320ab2eec336cb781aa3774260e99a35d97e991 /docs/nng_http_server_start.adoc | |
| parent | 3b33f6878ee628da22fd4451f248c036aae231ed (diff) | |
| download | nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.gz nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.tar.bz2 nng-51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9.zip | |
Document HTTP server API completely.
Diffstat (limited to 'docs/nng_http_server_start.adoc')
| -rw-r--r-- | docs/nng_http_server_start.adoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/nng_http_server_start.adoc b/docs/nng_http_server_start.adoc new file mode 100644 index 00000000..7de4cb40 --- /dev/null +++ b/docs/nng_http_server_start.adoc @@ -0,0 +1,54 @@ += nng_http_server_start(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + +nng_http_server_start - start HTTP server + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.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)>> + +== COPYRIGHT + +{copyright} |
