nng_aio_set_output(3)

Date: Tue, 6 Feb 2018 16:08:21 -0800 Subject: man page updates for 0.2.0 --- man/v0.2.0/libnng.html | 124 ++++- man/v0.2.0/nng_aio_set_input.html | 4 +- man/v0.2.0/nng_aio_set_output.html | 623 +++++++++++++++++++++++ man/v0.2.0/nng_http_conn_write_res.html | 20 +- man/v0.2.0/nng_http_handler_alloc.html | 737 ++++++++++++++++++++++++++++ man/v0.2.0/nng_http_handler_free.html | 607 +++++++++++++++++++++++ man/v0.2.0/nng_http_handler_get_data.html | 597 ++++++++++++++++++++++ man/v0.2.0/nng_http_handler_set_data.html | 612 +++++++++++++++++++++++ man/v0.2.0/nng_http_handler_set_host.html | 636 ++++++++++++++++++++++++ man/v0.2.0/nng_http_handler_set_method.html | 638 ++++++++++++++++++++++++ man/v0.2.0/nng_http_handler_set_tree.html | 618 +++++++++++++++++++++++ man/v0.2.0/nng_http_hijack.html | 647 ++++++++++++++++++++++++ man/v0.2.0/nng_http_server_add_handler.html | 621 +++++++++++++++++++++++ man/v0.2.0/nng_http_server_del_handler.html | 608 +++++++++++++++++++++++ man/v0.2.0/nng_http_server_get_tls.html | 610 +++++++++++++++++++++++ man/v0.2.0/nng_http_server_hold.html | 633 ++++++++++++++++++++++++ man/v0.2.0/nng_http_server_release.html | 615 +++++++++++++++++++++++ man/v0.2.0/nng_http_server_set_tls.html | 644 ++++++++++++++++++++++++ man/v0.2.0/nng_http_server_start.html | 615 +++++++++++++++++++++++ man/v0.2.0/nng_http_server_stop.html | 595 ++++++++++++++++++++++ 20 files changed, 10798 insertions(+), 6 deletions(-) create mode 100644 man/v0.2.0/nng_aio_set_output.html create mode 100644 man/v0.2.0/nng_http_handler_alloc.html create mode 100644 man/v0.2.0/nng_http_handler_free.html create mode 100644 man/v0.2.0/nng_http_handler_get_data.html create mode 100644 man/v0.2.0/nng_http_handler_set_data.html create mode 100644 man/v0.2.0/nng_http_handler_set_host.html create mode 100644 man/v0.2.0/nng_http_handler_set_method.html create mode 100644 man/v0.2.0/nng_http_handler_set_tree.html create mode 100644 man/v0.2.0/nng_http_hijack.html create mode 100644 man/v0.2.0/nng_http_server_add_handler.html create mode 100644 man/v0.2.0/nng_http_server_del_handler.html create mode 100644 man/v0.2.0/nng_http_server_get_tls.html create mode 100644 man/v0.2.0/nng_http_server_hold.html create mode 100644 man/v0.2.0/nng_http_server_release.html create mode 100644 man/v0.2.0/nng_http_server_set_tls.html create mode 100644 man/v0.2.0/nng_http_server_start.html create mode 100644 man/v0.2.0/nng_http_server_stop.html diff --git a/man/v0.2.0/libnng.html b/man/v0.2.0/libnng.html index 984d7762..7922e644 100644 --- a/man/v0.2.0/libnng.html +++ b/man/v0.2.0/libnng.html @@ -539,7 +539,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

SYNOPSIS

cc ['flags'] 'files' -lnng ['libraries']

cc [flags] files -lnng [libraries]

@@ -815,6 +815,10 @@ be associated with an aio at any time.

return number of bytes transferred

nng_aio_finish(3)

finish an asynchronous I/O operation

+ +

nng_aio_free(3)

free asynchronous I/O handle

@@ -847,6 +851,10 @@ be associated with an aio at any time.

set message for an asynchronous send

nng_aio_set_output(3)

set output result

+ +

nng_aio_set_timeout(3)

set asynchronous I/O timeout

@@ -1160,6 +1168,118 @@ and connections.

HTTP Client Functions

These functions are intended for use with HTTP client applications.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + +

nng_http_client_alloc(3)

allocate HTTP client

nng_http_client_connect(3)

establish HTTP client connection

nng_http_client_free(3)

free HTTP client

nng_http_client_get_tls(3)

get HTTP client TLS configuration

nng_http_client_set_tls(3)

set HTTP client TLS configuration

HTTP Server Functions

These functions are intended for use with HTTP server applications.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nng_http_handler_alloc(3)

allocate HTTP server handler

nng_http_handler_free(3)

free HTTP server handler

nng_http_handler_get_data(3)

return extra data for HTTP handler

nng_http_handler_set_data(3)

set extra data for HTTP handler

nng_http_handler_set_host(3)

set host for HTTP handler

nng_http_handler_set_method(3)

set HTTP handler method

nng_http_handler_set_tree(3)

set HTTP handler to match trees

nng_http_hijack(3)

hijack HTTP server connection

nng_http_server_add_handler(3)

add HTTP server handler

nng_http_server_del_handler(3)

delete HTTP server handler

nng_http_server_get_tls(3)

get HTTP server TLS configuration

nng_http_server_get_tls(3)

get and hold HTTP server instance

nng_http_server_get_tls(3)

release HTTP server instance

nng_http_server_set_tls(3)

set HTTP server TLS configuration

nng_http_server_start(3)

start HTTP server

nng_http_server_stop(3)

stop HTTP server

TLS Configuration Objects

@@ -1247,7 +1367,7 @@ This document is supplied under the terms of the

nng 0.2.0
-Last updated 2018-02-05 19:17:15 UTC +Last updated 2018-02-07 00:07:10 UTC

diff --git a/man/v0.2.0/nng_aio_set_input.html b/man/v0.2.0/nng_aio_set_input.html index 87770ee8..56198cdf 100644 --- a/man/v0.2.0/nng_aio_set_input.html +++ b/man/v0.2.0/nng_aio_set_input.html @@ -563,7 +563,7 @@ increase in the future.)

If the index does not correspond to a defined input for the operation, then this function will have no effect. Note that attempts to set -parameters with an index greater than three (3) will simply be ignored. +parameters with an index greater than three (3) will simply be ignored. @@ -630,7 +630,7 @@ This document is supplied under the terms of the

nng 0.2.0
-Last updated 2018-02-05 19:17:15 UTC +Last updated 2018-02-07 00:07:10 UTC

diff --git a/man/v0.2.0/nng_aio_set_output.html b/man/v0.2.0/nng_aio_set_output.html new file mode 100644 index 00000000..8fe8f92b --- /dev/null +++ b/man/v0.2.0/nng_aio_set_output.html @@ -0,0 +1,623 @@ +--- +version: 0.2.0 +layout: default +--- + + + + + + + + +nng_aio_set_output(3) + + + + + + + +

SYNOPSIS

#include <nng/nng.h>
+
+void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result);

DESCRIPTION

The nng_aio_set_output() function sets the output result at index +to result for the asynchronous operation associated with aio.

The type and semantics of output results are determined by specific +operations; the operation must supply appropriate output results when +the operation completes successfully.

The valid values of index range from zero (0) to three (3), as no operation +currently defined can return more than four results. (This limit could +increase in the future.)

+ + + + + +

+ +	+Note that attempts to set results with an index greater than +three (3) will be ignored. +

An output result set with this function may be retrieved later with +the nng_aio_get_output(3) function.

RETURN VALUES

None.

ERRORS

None.

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

+ + + diff --git a/man/v0.2.0/nng_http_conn_write_res.html b/man/v0.2.0/nng_http_conn_write_res.html index 093736c2..906e803e 100644 --- a/man/v0.2.0/nng_http_conn_write_res.html +++ b/man/v0.2.0/nng_http_conn_write_res.html @@ -512,7 +512,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

Table of Contents

SYNOPSIS
DESCRIPTION
DESCRIPTION +
- Persistent Connections
+
RETURN VALUES
ERRORS
SEE ALSO

aio

nng_aio_result

Persistent Connections

By default, for HTTP/1.1 connections, the connection is kept open, and +will be reused to receive new requests.

If however the res contains a header of Connection: with a value +of Close (case-insensitive) or the response corresponds to HTTP/1.0, +then the connection is immediately after sending the response.

@@ -627,7 +643,7 @@ This document is supplied under the terms of the

nng 0.2.0
-Last updated 2018-02-03 00:59:26 UTC +Last updated 2018-02-05 23:27:31 UTC

diff --git a/man/v0.2.0/nng_http_handler_alloc.html b/man/v0.2.0/nng_http_handler_alloc.html new file mode 100644 index 00000000..5d87fbfd --- /dev/null +++ b/man/v0.2.0/nng_http_handler_alloc.html @@ -0,0 +1,737 @@ +--- +version: 0.2.0 +layout: default +--- + + + + + + + + +nng_http_handler_alloc(3) + + + + + + +

SYNOPSIS

#include <nng/nng.h>
+
+typedef struct nng_http_handler nng_http_handler;
+
+int nng_http_handler_alloc(nng_http_handler **hp, const char *path,
+    void (*func)(nng_aio *);
+int nng_http_handler_alloc_directory(nng_http_handler **hp, const char *path,
+    const char *dirname);
+int nng_http_handler_alloc_file(nng_http_handler **hp, const char *path,
+    const char *filename);
+int nng_http_handler_alloc_static(nng_http_handler **hp, const char *path,
+    const void *data, size_t size, const char *content_type);

DESCRIPTION

The nng_http_handler_alloc() family of functions allocate a handler +which will be used to process requests coming into an HTTP server. +On success, a pointer to the handler is stored at the located pointed to +by hp.

Every handler has a Request-URI to which it refers, which is determined +by the path argument. Only the path component of the Request URI is +considered when determining whether the handler should be called.

Additionally each handler has a method it is registered to handle +(the default is "GET", see +<<nng_http_handler_set_method#,nng_http_handler_set_method(3)), and +optionally a 'Host' header it can be matched against (see +<<nng_http_handler_set_host#,nng_http_handler_set_host(3)).

In some cases, a handler may reference a logical tree rather (directory) +rather than just a single element. +(See nng_http_handler_set_tree(3)).

Custom Handler

The generic (first) form of this creates a handler that uses a user-supplied +function to process HTTP requests. This function uses the asynchronous I/O +framework. The function takes a pointer to an nng_aio structure. That +structure will be passed with the following input values (retrieved with +nng_aio_get_input(3)):

0: nng_http_req * request: +
The client’s HTTP request.
+
1: nng_http_handler *handler: +
Pointer to the handler object.
+
2: nng_http_conn *conn: +
The underlying HTTP connection.
+

The handler should create an nng_http_res * response (such as via +nng_http_res_alloc(3) or +nng_http_res_alloc_error(3)) and store that +in as the first output (index 0) with +nng_aio_set_output(3).

Alternatively, the handler may send the HTTP response (and any associated +body data) itself using the connection. In that case the output at index +0 of the aio should be NULL.

Finally, using the nng_aio_finish(3) function, the +aio should be completed successfully. If any non-zero status is returned +back to the caller instead, then a generic 500 response will be created and +sent, if possible, and the connection will be closed.

Directory Handler

The second member of this family, nng_http_handler_alloc_directory(), creates +a handler configured to serve a directory tree. The uri is taken as +the root, and files are served from the directory tree rooted at path.

When the client Request-URI resolves to a directory in the filesystem, +the handler looks first for a file named index.html or index.htm. If +one is found, then that file is returned back to the client. If no such +index file exists, then an NNG_HTTP_STATUS_NOT_FOUND (404) error is +sent back to the client.

The Content-Type will be set automatically based upon the extension +of the requsted file name. If a content type cannot be determined from +the extension, then application/octet-stream is used.

File Handler

The third member of this family, nng_http_handler_alloc_file(), creates +a handler to serve up a single file; it does not traverse directories +or search for index.html or index.htm files.

The Content-Type will be set automatically based upon the extension +of the requsted file name. If a content type cannot be determined from +the extension, then application/octet-stream is used.

Static Handler

The fourth member of this family, nng_http_handler_alloc_static(), creates +a handler to serve up fixed content located in program data. The client is +sent the data, with Content-Length of size bytes, and Content-Type of +content_type.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_EINVAL: +
An invalid path was specified.
+
NNG_ENOMEM: +
Insufficient free memory exists to allocate a message.
+
NNG_ENOTSUP: +
No support for HTTP in the library.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_free(3)

SYNOPSIS

#include <nng/nng.h>
+
+void nng_http_handler_free(nng_http_handler *h);

DESCRIPTION

The nng_http_handler_free() function frees an allocated HTTP server handler.

+ + + + + +

+ +	+It is an error to free a handler that is registered with a server. +Any handlers that are registered with servers are automatically freed +when the server itself is deallocated. +

RETURN VALUES

None.

ERRORS

None.

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_get_data(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_handler_get_data(nng_http_handler *handler, void *data,
+    void (*dtor)(void *));

DESCRIPTION

The nng_http_handler_get_data() function returns the data previously +stored on handler using the function +nng_http_handler_set_data(3).

RETURN VALUES

None.

ERRORS

None.

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_set_data(3)

SYNOPSIS

#include <nng/nng.h>
+
+void *nng_http_handler_get_data(nng_http_handler *handler, void *data,
+    void (*dtor)(void *));

DESCRIPTION

The nng_http_handler_set_data() function is used to set an additional +data for the handler. The stored data can be retrieved later +in the handler function using +nng_http_handler_get_data(3).

Additionally, when the handler is deallocated, if dtor is not NULL, +then it will be called with data as its argument. The intended use of +this function is deallocate any resources associated with data.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory to perform the operation.
+
NNG_ENOTSUP: +
No support for HTTP in the library.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_set_host(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_handler_set_host(nng_http_handler *handler, const char *host);

DESCRIPTION

The nng_http_handler_set_host() function is used to limit the scope of the +handler so that it will only be called when the specified host matches +the value of the Host: HTTP header.

+ + + + + +

+ +	+This can be used to create servers with multiple handlers for virtual +hosting. +

The value of the host can include a colon and port, and should match +exactly the value of the Host header sent by the client. (Canonicaliztion +of the host name is performed though.)

+ + + + + +

+ +	+As the server framework does not support listening on multiple +ports, the port number can be elided. The matching test only considers +the hostname or IP address, and ignores any trailing port number. +

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory to perform the operation.
+
NNG_ENOTSUP: +
No support for HTTP in the library.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_set_method(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_handler_set_method(nng_http_handler *handler, const char *method);

DESCRIPTION

The nng_http_handler_set_method() function sets the method that the +handler will be called for, such as "GET" or "POST". (By default the +"GET" method is handled.) If method is NULL, then the request method +is not examined, and the handler will be executed regardless of the +method.

+ + + + + +

+ +	+The server will automatically call "GET" handlers if the client +sends a "HEAD" request, and will suppress HTTP body data in the responses +sent for such requests. +

+ + + + + +

+ +	+No validation of the method is performed, but HTTP specifications +insist that the actual method sent over the wire be capitalized. +

The handler may always examine the actual method used using the +nng_http_req_get_method(3) function.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
No support for HTTP in the library.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_handler_set_tree(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_handler_set_tree(nng_http_handler *handler);

DESCRIPTION

The nng_http_handler_set_tree() function causes the handler to be +matched if the Request URI sent by the client is a logical child of +the path for handler.

+ + + + + +

+ +	+This method is useful when constructing API handlers where a single +service address (path) supports dynamically generated children. +

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
No support for HTTP in the library.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_hijack(3)

SYNOPSIS

#include <nng/nng.h>
+
+void nng_http_hijack(nng_http_conn *conn);

DESCRIPTION

The nng_http_hijack() function hijacks the connection conn, causing it +to be disassociated from the HTTP server where it was created.

The purpose of this function is the creation of HTTP upgraders (such as +WebSocket), where the underlying HTTP connection will be taken over for +some other purpose, and should not be used any further by the server.

This function is most useful when called from a handler function. +(See <<nng_http_alloc_handler#,nng_http_alloc_handler(3).)

+ + + + + +

+ +	+It is the responsibility of the caller to dispose of the underlying +connection when it is no longer needed. Furthermore, the HTTP server will +no longer send any responses to the hijacked connection, so the caller should +do that as well if appropriate. (See +nng_http_conn_write_res(3).) +

+ + + + + +

+ +	+This function is intended to facilitate uses cases that involve changing +the protocol from HTTP — such as WebSocket. Most applications will never need +to use this function. +

RETURN VALUES

None.

ERRORS

NNG_ECLOSED: +
The connection was closed.
+
NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
HTTP not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_add_handler(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_server_add_handler(nng_http_server *s, nng_http_handler *h);

DESCRIPTION

The nng_http_server_add_handler() adds the handler h to the server +instance s.

If another handler is already added to the server that would conflict +with handler h, then the operation will fail with NNG_EADDRINUSE.

If a handler is added to a server, and the server is subsequently +deallocated, the handler and any of its resources will also be deallocated.

Handlers that are added to a server may be subsequently removed using the +nng_http_server_del_handler(3) function.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_EADDRINUSE: +
Handler conflicts with another handler.
+
NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
HTTP not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_del_handler(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_server_del_hanlder(nng_http_server *s, nng_http_handler *h);

DESCRIPTION

The nng_http_server_del_handler() removes the handler h from the server +instance s.

Once a handler has been deleted from a server, it is the responsibility +of the caller to dispose of the handler, or add it to another server instance.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOENT: +
Handler is not registered with server.
+
NNG_ENOTSUP: +
HTTP not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_get_tls(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_server_get_tls(nng_http_server *s, nng_tls_config **cfgp);

DESCRIPTION

The nng_http_server_get_tls() obtains the TLS configuration of server s and +saves a pointer to it in the address referenced by cfgp.

The configuration will be NULL if the HTTP server instance is not enabled +to use HTTPS.

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
Either HTTP or TLS not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_hold(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_server_hold(nng_http_server **serverp, const nng_url *url);

DESCRIPTION

The nng_http_server_hold() acquires an instance of an HTTP server suitable +for use in serving the URL identified by url, and stores a pointer to it +at the location pointed to by serverp.

This function first looks to see if an existing HTTP server instance exists, +that is suitable for this. If so, it increments the reference count on it +and uses that. Otherwise, it will attempt to create a new server instance +with an initial reference count of one (1).

The server instance is not started, and can have additional configuration +applied to it before it is later started with +nng_http_server_start(3).

+ + + + + +

+ +	+The URL matching logic in determining servers is unable to distinguish +between different aliases for the same local IP address. This may create +problems when using URLs for virtual hosting. It is recommended to use +canonical IP addresses or names in the url to avoid confusion. +

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
HTTP not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_release(3)

SYNOPSIS

#include <nng/nng.h>
+
+void nng_http_server_release(nng_http_server *server);

DESCRIPTION

The nng_http_server_release() releases an instance of an HTTP server +that was previously held with +nng_http_server_hold(3).

This effectively drops the reference count on the server instance. When +the reference count drops to zero, then the server and all resources +associated with it (e.g. HTTP handlers, connections, etc.) are deallocated. +(If the server is "running" when this occurs, then the server is stopped.)

+ + + + + +

+ +	+It is an error to release an instance of a server that has +not previously been held, or to attempt to release an instance more +times than it has been held. +

RETURN VALUES

None.

ERRORS

None.

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_set_tls(3)

SYNOPSIS

#include <nng/nng.h>
+
+int nng_http_server_set_tls(nng_http_server *s, nng_tls_config *cfg);

DESCRIPTION

The nng_http_server_set_tls() sets the TLS configuration of server s to +instance s.

This change overwrites any previous TLS configuration.

+ + + + + +

+ +	+This also invalidates any previously obtained values from +nng_http_server_get_tls(3). +

If the server is already running (i.e. it has been started with +nng_http_server_start(3)) then this will +fail with NNG_EBUSY.

+ + + + + +

+ +	+Generally, the cfg must have a configured private key, set with +nng_tls_config_own_cert(3) or similar. +

RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

ERRORS

NNG_EBUSY: +
Server instance is running.
+
NNG_ENOMEM: +
Insufficient free memory exists.
+
NNG_ENOTSUP: +
Either HTTP or TLS not supported.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_start(3)

SYNOPSIS

#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.
+

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

nng_http_server_stop(3)

SYNOPSIS

#include <nng/nng.h>
+
+void nng_http_server_stop(nng_http_server *server);

DESCRIPTION

The nng_http_server_stop() stops the HTTP server instance server. +This will cause it to close any underlying TCP sockets, and to terminate +any HTTP connections associated with it.

RETURN VALUES

None.

ERRORS

None.

COPYRIGHT

Copyright 2018 Staysail Systems, Inc.
+Copyright 2018 Capitar IT Group BV
+
+This document is supplied under the terms of the MIT License.

SYNOPSIS

HTTP Client Functions

HTTP Server Functions

TLS Configuration Objects

nng_aio_set_output(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

Persistent Connections

nng_http_handler_alloc(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

Custom Handler

Directory Handler

File Handler

Static Handler

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_free(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_get_data(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_set_data(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_set_host(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_set_method(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_handler_set_tree(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

COPYRIGHT

nng_http_hijack(3) Manual Page

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO