Mongoose 6.4

PUBLISHED_FROM=5585ece71e9032b1357ea47fa8de626c52405650

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+People who have agreed to the
+[Cesanta CLA](https://docs.cesanta.com/contributors_la.shtml)
+can make contributions. Note that the CLA isn't a copyright
+_assigment_ but rather a copyright _license_.
+You retain the copyright on your contributions.
+
+We follow the Google C/C++ style guide: https://google.github.io/styleguide/cppguide.html
+We'd appreciate if your contribution follows the same style guide.

LICENSE

@@ -1,16 +1,16 @@
 Copyright (c) 2004-2013 Sergey Lyubka <valenok@gmail.com>
-Copyright (c) 2013 Cesanta Software Limited
+Copyright (c) 2013-2016 Cesanta Software Limited
 All rights reserved
 
-This code is dual-licensed: you can redistribute it and/or modify
+This software is dual-licensed: you can redistribute it and/or modify
 it under the terms of the GNU General Public License version 2 as
 published by the Free Software Foundation. For the terms of this
-license, see http://www.gnu.org/licenses.
+license, see <http://www.gnu.org/licenses/>.
 
-You are free to use this code under the terms of the GNU General
+You are free to use this software under the terms of the GNU General
 Public License, but WITHOUT ANY WARRANTY; without even the implied
 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 See the GNU General Public License for more details.
 
-Alternatively, you can license this code under a commercial
+Alternatively, you can license this software under a commercial
-license, as set out in http://cesanta.com/products.html.
+license, as set out in <https://www.cesanta.com/license>.

README.md

@@ -1,60 +1,80 @@
-# Mongoose Web Server
+# <img src="http://www.cesanta.com/hubfs/www.cesanta.com/Images/mongoose_library.png" width="64" height="64"> Mongoose - Embedded Web Server / Embedded Networking Library
 
-Mongoose is easy to use, powerful, embeddable web server.
+![](https://img.shields.io/badge/license-GPL_2-green.svg "License")
-   * [Downloads](http://cesanta.com/downloads.html)
+
-   * [Documentation](http://cesanta.com/docs.html)
+Mongoose is ideal for embedded environments. It has been designed
-   * [Mailing list](http://groups.google.com/group/mongoose-users)
+for connecting devices and bringing them online. Mongoose
+is on the market since 2004, used by vast number of open source and
+commercial products - it even runs on space stations!
+
+Mongoose provides easy to use event-driven interface that allows to implement
+network protocols or scalable network applications  with little effort.
+Mongoose helps developers to manage the complexity of network programming
+and let them concentrate on the logic, saving time and money.
+
+If you're looking for a pre-compiled Windows or Mac binary,
+- [Download pre-compiled Mongoose web server binary](https://www.cesanta.com/products/binary)
+
+Alternatively,
+
+- [Download Mongoose Source Code here](http://hubs.ly/H01bWvx0)
+- [Check our latest releases] (https://github.com/cesanta/mongoose/releases)
+- [Read User Guide and API reference](https://docs.cesanta.com/mongoose/dev)
+- [Study mongoose example code](https://github.com/cesanta/mongoose/tree/master/examples)
+
+If you are looking for a complete IoT platform with firmware and cloud compotent,
+- [Check out Smart.js - a full stack IoT platform](https://github.com/cesanta/smart.js)
+
+# Support
+- [Support Forum - Ask your technical questions here] (http://forum.cesanta.com/index.php?p=/categories/smart-js)
+- [Chat - Visit www.cesanta.com for our live chat] (http://www.cesanta.com)
+- [Commercial one-to-one support - Available to all commercial license holders] (https://www.cesanta.com/services-support)
 
 # Features
 
-- Works on Windows, Mac, UNIX/Linux, iPhone, Android, and many other platforms
+* Cross-platform: works on Linux/UNIX, MacOS, QNX, eCos, Windows, Android,
-- CGI, SSL, Digest auth, Websocket, WEbDAV, Resumed download, URL rewrite, file blacklist, IP-based ACL, Windows service
+  iPhone, FreeRTOS (TI CC3200, ESP8266), etc
-- Scripting and database support ([Lua](http://lua.org) +
+* Single-threaded, asynchronous, non-blocking core with simple event-based API
-[Sqlite](http://sqlite.org), see
+* Native support for [PicoTCP embedded TCP/IP stack](http://www.picotcp.com),
-[dirscan.lp](https://github.com/cesanta/mongoose/blob/master/examples/lua/dirscan.lp) ),
+  [LWIP embedded TCP/IP stack](https://en.wikipedia.org/wiki/LwIP)
-  which provides ready to go, powerful web development platform in
+* Builtin protocols:
-  one single-click executable with no dependencies
+   - plain TCP, plain UDP, SSL/TLS (over TCP, one-way or two-way)
-- Simple and clean
+   - HTTP client, HTTP server
-  [embedding API](https://github.com/cesanta/mongoose/blob/master/mongoose.h).
+   - WebSocket client, WebSocket server
-  The source is in single
+   - JSON-RPC client, JSON-RPC server
-  [mongoose.c](https://github.com/cesanta/mongoose/blob/master/mongoose.c) file
+   - MQTT client, MQTT broker
-  to make embedding easy
+   - CoAP client, CoAP server
-- Extremely lightweight, has a core of under 40kB and tiny runtime footprint
+   - DNS client, DNS server, async DNS resolver
-- Asyncronouns, non-blocking core supporting single- or multi-threaded usage
+* Tiny static and run-time footprint
-- On the market since 2004, stable, mature and tested,
+* Source code is both ISO C and ISO C++ compliant
-  has several man-years invested in continuous improvement and refinement
+* Very easy to integrate: just copy
-- Professional support and consultancy available from
+  [mongoose.c](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.c) and
-[Cesanta Software](http://cesanta.com), developer of Mongoose
+  [mongoose.h](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.h)
-
+  files to your build tree
-# Acknowledgements
-
-Mongoose made better thanks to the contribution of following people:
-
-Arnout Vandecappelle, Benoît Amiaux, Boris Pek, Cody Hanson, Colin Leitner,
-Daniel Oaks, Eric Bakan, Erik Oomen, Filipp Kovalev, Ger Hobbelt,
-Hendrik Polczynski, Igor Okulist, Jay, Joe Mucchiello, John Safranek,
-José Miguel Gonçalves, Shueng Chuan, Katerina Blinova, Konstantin Sorokin,
-Marin Atanasov, Matt Healy, Mitch Hendrickson, Nigel Stewart, Pavel Khlebovich,
-Sebastian Reinhard, Stefan Doehla, abadc0de, nullable.type,
-T.Barmann, D.Hughes, J.C.Sloan, R.Romeo, L.E.Spencer, S.Kotay, R.M.Shorter,
-W.Mar, J.Wilander, Santa from Memphis, S.Davies, C.Beck,
-O.M.Vilhunen, C.Radik, G.Woodcock, M.Szczepkowski,
-Eternal Lands Dev Team, T.Tollet, C.Tangerino, G.Karsai, A.Bourgett,
-C.Blakemore, D.Fonaryov, T.Andrle, O.IJsselmuiden, R.Womack, M.Tomlinson,
-A.Slåttå, L.Farrell, J.D.P.Ballestero, V.Albaev, B.Harker, T.Scheffel, H.Klein,
-R.Merit, T.Bennett, H.Solis, A.Zincenko, M.S., S.Krul, K.Cooke, S.McCallum,
-F.Morenius, and 10 others.
 
 # Licensing
 
-Mongoose is released under
+Mongoose is released under commercial and [GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) open source licenses.
-[GNU GPL v.2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
-Businesses have an option to get non-restrictive, royalty-free commercial
-license and professional support from
-[Cesanta Software](http://cesanta.com).
 
-[Frozen JSON parser](https://github.com/cesanta/frozen),
+Commercial Projects:
-[Super Light Regular Expression library](https://github.com/cesanta/slre),
+Once your project becomes commercialised GPLv2 licensing dictates that you need to either open your source fully or purchase a commercial license. Cesanta offer full, royalty-free commercial licenses without any GPL restrictions. If your needs require a custom license, we’d be happy to work on a solution with you. [Contact us for pricing.] (https://www.cesanta.com/contact)
-[Super Light DNS Resolver](https://github.com/cesanta/sldr)
+
-are other projects by Cesanta Software, developed with the same philosophy
+Prototyping:
-of functionality and simplicity.
+While your project is still in prototyping stage and not for sale, you can use Mongoose’s open source code without license restrictions.
+
+# Dashboard Example
+
+Mongoose is often used to implement device dashboards and real-time
+data exchange over Websocket. Here is a dashboard example that illustrates
+the functionality:
+
+![](http://www.cesanta.com/hubfs/www.cesanta.com/diagrams/dash_mongoose_diagram.png)
+
+[Developing a new product? Contact us today to discuss how Mongoose can help
+](https://www.cesanta.com/contact)
+
+# Contributions
+
+People who have agreed to the [Cesanta CLA] (https://docs.cesanta.com/contributors_la.shtml) can make contributions. Note that the CLA isn't a copyright assigment but rather a copyright license. You retain the copyright on your contributions.
+
+[![Analytics](https://ga-beacon.appspot.com/UA-42732794-5/project-page)](https://github.com/cesanta/mongoose)

docs/API.md

@@ -1,208 +0,0 @@
-# Mongoose API Reference
-
-    struct mg_server *mg_create_server(void *server_param);
-
-Creates web server instance. Returns opaque instance pointer, or NULL if
-there is not enough memory. `server_param`: Could be any pointer, or NULL.
-This pointer will be passed
-to the callback functions as `struct mg_connection::server_param` field.
-A common use case is to pass `this` pointer of the C++ wrapper class
-as `user_param`, to let the callback get the pointer to the C++
-object.
-
-Note that this function doesn't make the
-server instance to serve. Serving is done by `mg_poll_server()` function.
-Mongoose has single-threaded, event-driven, asynchronous, non-blocking core.
-When server instance is created, it contains an information about
-the configuration and the state of each connection.
-Server instance is capable on listening on only one port. After creation,
-`struct mg_server` has a list
-of active connections, initially empty. It has a list of URI handlers,
-initially empty, and configuration parameters. Configuration can be
-altered by `mg_set_option()`, and new URI handlers could be added by
-`mg_add_uri_handler()`.
-
-Side-effect: on UNIX, `mg_create_server()` ignores SIGPIPE signals. If custom
-processing is required SIGPIPE, signal handler must be set up after
-calling `mg_create_server()`.
-
-Important: Mongoose does not install `SIGCHLD` handler. If CGI is used,
-`SIGCHLD` handler must be set up to reap CGI zombie processes.
-
-
-    void mg_destroy_server(struct mg_server **server);
-
-Deallocates web server instance, closes all pending connections, and makes
-server pointer a NULL pointer.
-
-    const char mg_set_option(struct mg_server *server, const char *name,
-                             const char *value);
-
-Sets a particular server option. Please refer to a separate documentation page
-that lists all available option names. Note that at least one option,
-`listening_port`, must be specified. To serve static files, `document_root`
-must be specified too. If `document_root` option is left unset, Mongoose
-will not access filesystem at all. This function returns NULL if option was
-set successfully, otherwise it returns human-readable error string. It is
-allowed to call `mg_set_option()` by the same thread that does
-`mg_poll_server()` (an IO thread) and change server configuration while it
-is serving, in between `mg_poll_server()` calls.
-
-    void mg_poll_server(struct mg_server *server, int milliseconds);
-
-This function performs one iteration of IO loop by iterating over all
-active connections, performing `select()` syscall on all sockets with a timeout
-of `milliseconds` number of milliseconds. When `select()` returns, Mongoose
-does an IO for each socket that has data to be sent or received. Application
-code must call `mg_poll_server()` in a loop. It is an error to have more then
-one thread calling `mg_poll_server()`, `mg_set_option()` or any other function
-that take `struct mg_server *` parameter. Mongoose does not
-mutex-protect `struct mg_server *`, therefore the best practice is
-to call server management functions from the same thread (an IO thread).
-
-    void mg_set_auth_handler(struct mg_server *, mg_handler_t handler);
-
-Sets authorization handler. Called by Mongoose on each request, before
-performing any other action. Handler can return either `MG_AUTH_OK` or
-`MG_AUTH_FAIL`. If `handler` returns `MG_AUTH_FAIL`, then Mongoose sends
-digest authorization request to the client. If `handler returns `MG_AUTH_OK`,
-then mongoose proceeds with handling the request. Handler function can use
-`mg_authorize_digest()` function to verify authorization, or implement any other
-custom authorization mechanism.
-
-    void mg_set_request_handler(struct mg_server *, mg_handler_t handler);
-
-Sets a request handler. When set, `handler` will be called for each request.
-Possible return values from a handler function are `MG_REQUEST_NOT_PROCESSED`,
-`MG_REQUEST_PROCESSED` and `MG_REQUEST_CALL_AGAIN`. If handler returns
-`MG_REQUEST_NOT_PROCESSED`, mongoose will proceed with handling the request.
-If handler returns `MG_REQUEST_PROCESSED`, that signals mongoose that handler
-has already processed the connection, and mongoose will skip to the next
-request. `MG_REQUEST_CALL_AGAIN` tells mongoose to call request handler
-again and again on each `mg_poll_server()` iteration.
-
-When mongoose buffers in HTTP request and successfully parses it, it calls
-appropriate URI handler immediately for GET requests. For POST requests,
-Mongoose delays the call until the whole POST request is buffered in memory.
-POST data is available to the callback as `struct mg_connection::content`,
-and POST data length is in `struct mg_connection::content_len`.
-
-Note that websocket connections are treated the same way. Mongoose buffers
-websocket frame in memory, and calls URI handler when frame is fully
-buffered. Frame data is available `struct mg_connection::content`, and
-data length is in `struct mg_connection::content_len`, i.e. very similar to
-the POST request. `struct mg_connection::is_websocket` flag indicates
-whether the request is websocket or not. Also, for websocket requests,
-there is `struct mg_connection::wsbits` field which contains first byte
-of the websocket frame which URI handler can examine. Note that to
-reply to the websocket client, `mg_websocket_write()` should be used.
-To reply to the plain HTTP client, `mg_write_data()` should be used. Note that
-websocket handler must return either `MG_CLIENT_CLOSE` or `MG_CLIENT_CONTINUE`
-value.
-
-    void mg_set_http_error_handler(struct mg_server *, mg_handler_t);
-
-Adds HTTP error handler. An actual HTTP error is passed as
-`struct mg_connection::status_code` parameter.
-Hanlder should return either `MG_ERROR_PROCESSED` or `MG_ERROR_NOT_PROCESSED`.
-If handler returns `MG_ERROR_NOT_PROCESSED`, it
-means a handler has not processed the connection, and mongoose proceeds
-with sending HTTP error to the client. Otherwise, mongoose does nothing.
-
-    const char **mg_get_valid_option_names(void);
-
-Returns a NULL-terminated array of option names and their default values.
-There are two entries per option in an array: an option name followed by a
-default value. A default value could be NULL. A NULL name indicates an end
-of the array.
-
-    const char *mg_get_option(const struct mg_server *server, const char *name);
-
-Returns the value of particular configuration parameter. If
-given parameter name is not valid, NULL is returned. For valid names, return
-value is guaranteed to be non-NULL. If parameter is not set, zero-length string
-is returned.
-
-
-    int mg_iterate_over_connections(struct mg_server *,
-                                void (*func)(struct mg_connection *, void *),
-                                void *param);
-
-This is an interface primarily designed to push arbitrary data to websocket
-connections at any time. This function could be called from any thread. When
-it returns, an IO thread called `func()` on each active connection,
-passing `param` as an extra parameter. It is allowed to call `mg_send_data()` or
-`mg_websocket_write()` within a callback, cause `func` is executed in the
-context of the IO thread.
-
-    void mg_send_status(struct mg_connection *, int status_code);
-    void mg_send_header(struct mg_connection *, const char *name,
-                        const char *value);
-    void mg_send_data(struct mg_connection *, const void *data, int data_len);
-    void mg_printf_data(struct mg_connection *, const char *format, ...);
-
-These functions are used to construct a response to the client. HTTP response
-consists of three parts: a status line, zero or more HTTP headers,
-a response body.  Mongoose provides functions for all three parts:
-   * `mg_send_status()` is used to create status line. This function can be
-      called zero or once. If `mg_send_status()` is not called, then Mongoose
-      will send status 200 (success) implicitly.
-   * `mg_send_header()` adds HTTP header to the response. This function could
-      be called zero or more times.
-   * `mg_send_data()` and `mg_printf_data()` are used to send data to the
-     client. Note that Mongoose adds `Transfer-Encoding: chunked` header
-     implicitly, and sends data in chunks. Therefore, it is not necessary to
-     set `Content-Length` header. Note that `mg_send_data()` and
-     `mg_printf_data()` do not send data immediately. Instead, they spool
-     data in memory, and Mongoose sends that data later after URI handler
-     returns. If data to be sent is huge, an URI handler might
-     send data in pieces by saving state in
-     `struct mg_connection::connection_param` variable and returning `0`. Then
-     Mongoose will call a handler repeatedly after each socket write.
-
-<!-- -->
-
-    int mg_websocket_write(struct mg_connection* conn, int opcode,
-                           const char *data, size_t data_len);
-
-Similar to `mg_write()`, but wraps the data into a websocket frame with a
-given websocket `opcode`.  
-
-    const char *mg_get_header(const struct mg_connection *, const char *name);
-
-Get the value of particular HTTP header. This is a helper function.
-It traverses http_headers array, and if the header is present in the array,
-returns its value. If it is not present, NULL is returned.
-
-
-    int mg_get_var(const struct mg_connection *conn, const char *var_name,
-                   char *buf, size_t buf_len);
-
-Gets HTTP form variable. Both POST buffer and query string are inspected.
-Form variable is url-decoded and written to the buffer. On success, this
-function returns the length of decoded variable. On error, -1 is returned if
-variable not found, and -2 is returned if destination buffer is too small
-to hold the variable. Destination buffer is guaranteed to be
-'\0' - terminated if it is not NULL or zero length.
-
-    int mg_parse_header(const char *hdr, const char *var_name, char *buf,
-                        size_t buf_size);
-
-This function parses HTTP header and fetches given variable's value in a buffer.
-A header should be like `x=123, y=345, z="other value"`. This function is
-designed to parse Cookie headers, Authorization headers, and similar. Returns
-the length of the fetched value, or 0 if variable not found.
-
-    int mg_modify_passwords_file(const char *passwords_file_name,
-                                 const char *domain,
-                                 const char *user,
-                                 const char *password);
-
-Add, edit or delete the entry in the passwords file.  
-This function allows an application to manipulate .htpasswd files on the
-fly by adding, deleting and changing user records. This is one of the
-several ways of implementing authentication on the server side. For another,
-cookie-based way please refer to the examples/chat.c in the source tree.  
-If password is not NULL, entry is added (or modified if already exists).
-If password is NULL, entry is deleted.  
-Return: 1 on success, 0 on error.

docs/AndroidBuild.md

@@ -1,27 +0,0 @@
-# Mongoose Build on Android
-
-This is a small guide to help you run mongoose on Android. Currently it is
-tested on the HTC Wildfire. If you have managed to run it on other devices
-as well, please comment or drop an email in the mailing list.
-Note : You dont need root access to run mongoose on Android.
-
-- Clone Mongoose Git repo
-- Download the Android NDK from [http://developer.android.com/tools/sdk/ndk/index.html](http://developer.android.com/tools/sdk/ndk/index.html)
-- Run `/path-to-ndk/ndk-build -C /path-to-mongoose/build`
-  That should generate mongoose/lib/armeabi/mongoose
-- Using the adb tool (you need to have Android SDK installed for that),
-  push the generated mongoose binary to `/data/local` folder on device.
-- From adb shell, navigate to `/data/local` and execute `./mongoose`.
-- To test if the server is running fine, visit your web-browser and
-  navigate to `http://127.0.0.1:8080` You should see the `Index of /` page.
-
-![screenshot](https://a248.e.akamai.net/camo.github.com/b88428bf009a2b6141000937ab684e04cc8586af/687474703a2f2f692e696d6775722e636f6d2f62676f6b702e706e67)
-
-
-Notes:
-
-- `jni` stands for Java Native Interface. Read up on Android NDK if you want
-  to know how to interact with the native C functions of mongoose in Android
-  Java applications.
-- TODO: A Java application that interacts with the native binary or a
-  shared library.

docs/Embed.md

@@ -1,108 +0,0 @@
-# Mongoose Embedding Guide
-
-Embedding Mongoose is done in two steps:
-
-   1. Copy
-    [mongoose.c](https://raw.github.com/cesanta/mongoose/master/mongoose.c) and
-    [mongoose.h](https://raw.github.com/cesanta/mongoose/master/mongoose.h)
-    to your application's source tree and include them in the build.
-   2. Somewhere in the application code, call `mg_create_server()` to create
-    a server, configure it with `mg_set_option()` and loop with
-    `mg_poll_server()` until done. Call `mg_destroy_server()` to cleanup.
-
-Here's a minimal application `app.c` that embeds mongoose:
-
-    #include "mongoose.h"
-    int main(void) {
-      struct mg_server *server = mg_create_server(NULL);
-      mg_set_option(server, "document_root", ".");
-      mg_set_option(server, "listening_port", "8080");
-      for (;;) mg_poll_server(server, 1000);  // Infinite loop, Ctrl-C to stop
-      mg_destroy_server(&server);
-      return 0;
-    }
-
-To compile it, put `mongoose.c`, `mongoose.h` and `minimal.c` into one
-folder, start terminal on UNIX or Visual Studio command line prompt on Windows,
-and run the following command:
-
-    cc app.c mongoose.c -o app    # on Unix
-    cl app.c mongoose.c /TC /MD   # on Windows
-
-When run, this simple application opens port 8080 and serves static files,
-CGI files and lists directory content in the current working directory.
-
-Mongoose can call user-defined functions when certain URIs are requested.
-These functions are _called uri handlers_.  `mg_add_uri_handler()` registers
-an URI handler, and there is no restriction exist on the number of URI handlers.
-Also, mongoose can call a user-defined function when it is about to send
-HTTP error back to client. That function is called _http error handler_ and
-can be registered by `mg_set_http_error_handler()`. Handlers are called
-by Mongoose with `struct mg_connection *` pointer as a parameter, which
-has all information about the request: HTTP headers, POST or websocket
-data buffer, etcetera.
-
-Let's extend our minimal application example and
-create an URI that will be served by user's C code. The app will handle
-`/hello` URI by showing a hello message. So, when app is run,
-http://127.0.0.1:8080/hello will say hello, and here's the code:
-
-    #include <string.h>
-    #include "mongoose.h"
-
-    static int handle_hello(struct mg_connection *conn) {
-      static const char *reply = "Hello world!\n";
-      mg_write_data(conn, reply, strlen(reply));
-      return 1;
-    }
-
-    int main(void) {
-      struct mg_server *server = mg_create_server(NULL);
-      mg_set_option(server, "document_root", ".");
-      mg_set_option(server, "listening_port", "8080");
-      mg_add_uri_handler(server, "/hello", &handle_hello);
-      for (;;) mg_poll_server(server, 1000);  // Infinite loop, Ctrl-C to stop
-      mg_destroy_server(&server);
-      return 0;
-    }
-
-Below is the list of compilation flags that enable or disable certain
-features. By default, some features are enabled, and could be disabled
-by setting appropriate `NO_*` flag. Features that are disabled by default
-could be enabled by setting appropriate `USE_*` flag. Bare bones Mongoose
-is quite small, about 30 kilobytes of compiled x86 code. Each feature adds
-a couple of kilobytes to the executable size, and also has some runtime penalty.
-
-    -DMONGOOSE_NO_AUTH          Disable MD5 authorization support
-    -DMONGOOSE_NO_CGI           Disable CGI support
-    -DMONGOOSE_NO_DAV           Disable WebDAV support
-                                (PUT, DELETE, MKCOL, PROPFIND methods)
-    -DMONGOOSE_NO_DIRECTORY_LISTING  Disable directory listing
-    -DMONGOOSE_NO_FILESYSTEM    Disables all file IO, serving from memory only
-    -DMONGOOSE_NO_LOGGING       Disable access/error logging
-    -DMONGOOSE_NO_THREADS
-    -DMONGOOSE_NO_WEBSOCKET     Disable WebSocket support
-
-    -DMONGOOSE_USE_IDLE_TIMEOUT_SECONDS=X Idle connection timeout, default is 30
-    -DMONGOOSE_USE_IPV6         Enable IPv6 support
-    -DMONGOOSE_USE_LUA          Enable Lua scripting
-    -DMONGOOSE_USE_LUA_SQLITE3  Enable sqlite3 binding for Lua
-    -DMONGOOSE_USE_SSL          Enable SSL
-    -DMONGOOSE_USE_POST_SIZE_LIMIT=X      POST requests larger than X will be
-                                          rejected, not set by default
-    -DMONGOOSE_USE_EXTRA_HTTP_HEADERS=X   Append X to the HTTP headers
-                                          for static files, empty by default
-    -DMONGOOSE_USE_STACK_SIZE=X           Let mg_start_thread() use stack
-                                          size X, default is OS default
-    -DMONGOOSE_ENABLE_DEBUG     Enables debug messages on stdout, very noisy
-
-Mongoose source code contains a well-commented example code, listed below:
-
-   * [hello.c](https://github.com/cesanta/mongoose/blob/master/examples/hello.c)
-   a minimalistic hello world example
-   * [post.c](https://github.com/cesanta/mongoose/blob/master/examples/post.c)
-   shows how to handle form input
-   * [upload.c](https://github.com/cesanta/mongoose/blob/master/examples/post.c)
-   shows how to upload files
-   * [websocket.c](https://github.com/cesanta/mongoose/blob/master/examples/websocket.c) demonstrates websocket usage
-   * [auth.c](https://github.com/cesanta/mongoose/blob/master/examples/websocket.c) demonstrates API-controlled Digest authorization

docs/FAQ.md

@@ -1,23 +0,0 @@
-# Mongoose FAQ
-
-### PHP doesn't work: getting empty page, or 'File not found' error
-
-The reason for that is wrong paths to the interpreter. Remember that with PHP,
-correct interpreter is `php-cgi.exe` (`php-cgi` on UNIX). Solution: specify
-full path to the PHP interpreter, e.g.:
-
-    mongoose -cgi_interpreter /full/path/to/php-cgi
-
-### Mongoose fails to start
-
-If Mongoose exits immediately when run, this
-usually indicates a syntax error in the configuration file
-(named `mongoose.conf` by default) or the command-line arguments.
-Syntax checking is omitted from Mongoose to keep its size low. However,
-the Manual should be of help. Note: the syntax changes from time to time,
-so updating the config file might be necessary after executable update.
-
-### Embedding with OpenSSL on Windows might fail because of calling convention
-
-To force Mongoose to use `__stdcall` convention, add `/Gz` compilation
-flag to the Visual Studio project settings.

docs/Internals.md

@@ -1,44 +0,0 @@
-# Mongoose Internals
-
-Mongoose has single-threaded, event-driven, asynchronous, non-blocking core.
-`mg_create_server()` creates a web server instance. An instance is a container
-for the config options and list of active connections. To do the actual
-serving, user must call `mg_poll_server()`, which iterates over all
-active connections, performing `select()` syscall on all sockets with a
-timeout of specified number of milliseconds. When `select()` returns, Mongoose
-does an IO for each socket that has data to be sent or received. Application
-code must call `mg_poll_server()` in a loop.
-
-Mongoose server instance is designed to be used by a single thread.
-It is an error to have more then
-one thread calling `mg_poll_server()`, `mg_set_option()` or any other function
-that take `struct mg_server *` parameter. Mongoose does not
-mutex-protect `struct mg_server *`, therefore the best practice is
-to call server management functions from the same thread (an IO thread).
-On a multi-core systems, many server instances can be created, sharing the
-same listening socket and managed by separate threads (see [multi_threaded.c](https://github.com/cesanta/mongoose/blob/master/examples/multi_threaded.c))
-example.
-
-It is an error to pass and store `struct mg_connection *` pointers for
-later use to send data. The reason is that they can be invalidated by the
-next `mg_poll_server()` call. For such a task,
-there is `mg_iterate_over_connections()` API
-exists, which sends a callback function to the IO thread, then IO thread
-calls specified function for all active connection.
-
-When mongoose buffers in HTTP request and successfully parses it, it calls
-appropriate URI handler immediately for GET requests. For POST requests,
-Mongoose delays the call until the whole POST request is buffered in memory.
-POST data is available to the callback as `struct mg_connection::content`,
-and POST data length is in `struct mg_connection::content_len`.
-
-Note that websocket connections are treated the same way. Mongoose buffers
-websocket frame in memory, and calls URI handler when frame is fully
-buffered. Frame data is available `struct mg_connection::content`, and
-data length is in `struct mg_connection::content_len`, i.e. very similar to
-the POST request. `struct mg_connection::is_websocket` flag indicates
-whether the request is websocket or not. Also, for websocket requests,
-there is `struct mg_connection::wsbits` field which contains first byte
-of the websocket frame which URI handler can examine. Note that to
-reply to the websocket client, `mg_websocket_write()` should be used.
-To reply to the plain HTTP client, `mg_write()` should be used.

docs/LuaSqlite.md

@@ -1,59 +0,0 @@
-# Mongoose Lua Server Pages
-
-Pre-built Windows and Mac mongoose binaries support Lua Server Pages
-functionality.
-That means it is possible to write PHP-like scripts with mongoose
-using Lua programming language instead of PHP. Lua is known
-for it's speed and small size. Mongoose uses Lua version 5.2.1, the
-documentation for it can be found at
-[Lua 5.2 reference manual](http://www.lua.org/manual/5.2/).
-
-To create a Lua Page, make a file that is called `<something>.lp`. For example,
-let's say it is going to be `my_page.lp`. It is important to have a file
-name that ends up with `.lp`, cause this is the way mongoose recognises
-Lua Page file. The contents of the file, just like
-with PHP, is HTML with embedded Lua code. Lua code must be enclosed within
-`<?  ?>` blocks, and can appear anywhere on the page.
-
-Mongoose does not send HTTP headers for Lua pages. Therefore,
-every Lua Page must begin with HTTP status line and headers, like this:
-
-    <? mg.write('HTTP/1.0 200 OK\r\nContent-Type: text/html\r\n\r\n') ?>
-    <html><body>
-      <span>Today is:</span> <? mg.write(os.date("%A")) ?>
-    </body></html>
-
-Note that this example uses function `mg.write()`, which prints data to the
-web page. Using function `mg.write()` is the way to generate web content from
-inside Lua code. In addition to `mg.write()`, all standard library functions
-are accessible from the Lua code (please check reference manual for details).
-Information about the request is available in `mg.request_info` object.
-I contains request method, all headers, etcetera. Please refer to
-`struct mg_request_info` definition in
-[mongoose.h](https://github.com/cesanta/mongoose/blob/master/mongoose.h)
-to see what is available in `mg.request_info`. Also,
-[page.lp](https://github.com/cesanta/mongoose/blob/master/test/page.lp) and
-[prime_numbers.lp](https://github.com/cesanta/mongoose/blob/master/examples/lua/prime_numbers.lp)
-contain some example code that uses `request_info` and other functions,
-like form submission.
-
-Mongoose exports the following to the Lua server page:
-
-    mg.write(str)     -- writes string to the client
-    mg.onerror(msg)   -- error handler, can be overridden
-    mg.request_info   -- a table with request information
-    sqlite3           -- Sqlite3 interface
-
-slite3 functions are documented at [lua.sqlite.org](http://lua.sqlite.org/),
-and usage example is at
-[page.lp](https://github.com/cesanta/mongoose/blob/master/test/page.lp).
-
-Using Lua scripting it is easy to emulate SSI functionality. For example,
-to include the content of another file, one can write:
-
-    <? mg.write(io.open('MY_FILE.TXT'):read('*all')) ?>
-
-To serve a Lua Page, mongoose creates Lua context. That context is used for
-all Lua blocks within the page. That means, all Lua blocks on the same page
-share the same context. If one block defines a variable, for example, that
-variable is visible in the block that follows.

docs/Options.md

@@ -1,140 +0,0 @@
-# Mongoose Configuration Options
-
-### access\_control\_list
-An Access Control List (ACL) allows restrictions to be put on the list of IP
-addresses which have access to the web server. In the case of the Mongoose
-web server, the ACL is a comma separated list of IP subnets, where each
-subnet is prepended by either a `-` or a `+` sign. A plus sign means allow,
-where a minus sign means deny. If a subnet mask is omitted, such as `-1.2.3.4`,
-this means to deny only that single IP address.
-
-Subnet masks may vary from 0 to 32, inclusive. The default setting is to allow
-all accesses. On each request the full list is traversed, and
-the last match wins. Example: `$ mongoose -access_control_list -0.0.0.0/0,+192.168/16` to deny all acccesses except from 192.168/16 subnet. To learn
-more about subnet masks, see the
-[Wikipedia page on Subnetwork](http://en.wikipedia.org/wiki/Subnetwork)
-
-Default: not set, all accesses are allowed.
-
-### access\_log\_file
-Path to a file for access logs. Either full path, or relative to the
-mongoose executable. Default: not set, no query logging is done.
-
-### auth_domain
-Authorization realm used in `.htpasswd` authorization. Default: `mydomain.com`
-
-### cgi_interpreter
-Path to an executable to use as CGI interpreter for __all__ CGI scripts
-regardless script extension.
-for an interpreter. Default: not set, Mongoose looks at
-[shebang line](http://en.wikipedia.org/wiki/Shebang_(Unix\).
-
-For example, if both PHP and perl CGIs are used, then
-`#!/path/to/php-cgi.exe` and `#!/path/to/perl.exe` must be first lines of the
-respective CGI scripts. Note that paths should be either full file paths,
-or file paths relative to the directory where mongoose server is located.
-
-If all CGIs use the same interpreter, for example they are all PHP, then
-`cgi_interpreter` option can be set to the path to `php-cgi.exe` executable and
-shebang line in the CGI scripts can be omitted.
-Note that PHP scripts must use `php-cgi.exe` executable, not `php.exe`.
-
-### cgi_pattern
-All files that match `cgi_pattern` are treated as CGI files. Default pattern
-allows CGI files be anywhere. To restrict CGIs to a certain directory,
-use `/path/to/cgi-bin/**.cgi` as pattern. Note that full file path is
-matched against the pattern, not the URI. Note: if `MONGOOSE_CGI` environment
-variable is set, then Mongoose passes it to the CGI script.
-
-Default: `**.cgi$|**.pl$|**.php$`
-
-### dav\_auth\_file
-Authentication file for WebDAV mutation requests: `PUT`, `DELETE`, `MKCOL`.
-The format of that file is the same as for the `.htpasswd` file
-used for digest authentication. It can be created and managed by
-`mongoose -A` command. Default: not set, WebDAV mutations are disallowed.
-
-### document_root
-A directory to serve. Default: current working directory.
-
-### enable\_directory\_listing
-Enable directory listing, either `yes` or `no`. Default: `yes`.
-
-### error\_log\_file
-Path to a file for error logs. Either full path, or relative to the
-mongoose executable. Default: not set, no errors are logged.
-
-### extra\_mime\_types
-Extra mime types to recognize, in form `extension1=type1,extension2=type2,...`.
-Extension must include dot.  Example:
-`mongoose -extra_mime_types .cpp=plain/text,.java=plain/text`. Default: not set.
-
-
-### global\_auth\_file
-Path to a global passwords file, either full path or relative to the mongoose
-executable. If set, per-directory `.htpasswd` files are ignored,
-and all requests are authorised against that file. Use `mongoose -A` to
-manage passwords, or third party utilities like
-[htpasswd-generator](http://www.askapache.com/online-tools/htpasswd-generator).
-Default: not set, per-directory `.htpasswd` files are respected.
-
-### hide\_files\_patterns
-A pattern for the files to hide. Files that match the pattern will not
-show up in directory listing and return `404 Not Found` if requested. Pattern
-must be for a file name only, not including directory name, e.g.
-`mongoose -hide_files_patterns secret.txt|even_more_secret.txt`. Default:
-not set.
-
-### idle\_timeout\_ms
-Timeout for idle connections. Default: 30000 (30 seconds)
-
-### index_files
-Comma-separated list of files to be treated as directory index
-files. Default: `index.html,index.htm,index.cgi,index.shtml,index.php`
-
-### ssl_certificate
-Path to SSL certificate file. The file must be in PEM format,
-and it must have both private key and certificate, see for example
-[ssl_cert.pem](https://github.com/cesanta/mongoose/blob/master/build/ssl_cert.pem). If this option is set, then Mongoose serves SSL connections on
-`listening_port`. Default: not set.
-
-### listening_port
-Port to listen on. Port could be prepended by the specific IP address to bind
-to, e.g. `mongoose -listening_port 127.0.0.1:8080`. Otherwise Mongoose
-will bind to all addresses.  Default: 8080.
-
-### run\_as\_user
-Switch to given user credentials after startup. UNIX-only. This option is
-required when mongoose needs to bind on privileged port on UNIX, e.g.
-
-    $ sudo mongoose -listening_ports 80 -run_as_user nobody
-
-Default: not set.
-
-### url\_rewrites
-Comma-separated list of URL rewrites in the form of
-`uri_pattern=file_or_directory_path`. When Mongoose receives the request,
-it constructs the file name to show by combining `document_root` and the URI.
-However, if the rewrite option is used and `uri_pattern` matches the
-requested URI, then `document_root` is ignored. Insted,
-`file_or_directory_path` is used, which should be a full path name or
-a path relative to the web server's current working directory. Note that
-`uri_pattern`, as all mongoose patterns, is a prefix pattern. If `uri_patters`
-is a number, then it is treated as HTTP error code, and `file_or_directory_path`
-should be an URI to redirect to. Mongoose will issue `302` temporary redirect
-to the specified URI, appending two parameters:
-`?code=<http_error_code&orig_uri=<original_uri>`.
-
-This makes it possible to serve many directories outside from `document_root`,
-redirect all requests to scripts, and do other tricky things. Examples:
-
-    # Redirect all accesses to `.doc` files to a special script
-    mongoose -url_rewrites **.doc$=/path/to/cgi-bin/handle_doc.cgi
-
-    # Implement user home directories support
-    mongoose -url_rewrites /~joe/=/home/joe/,/~bill=/home/bill/
-
-    # Redirect 404 errors to a specific error page
-    mongoose -url_rewrites 404=/cgi-bin/error.cgi
-
-Default: not set.

docs/SSL.md

@@ -1,75 +0,0 @@
-# Mongoose SSL guide
-
-SSL is a protocol that makes web communication secure. To enable SSL
-in mongoose, 3 steps are required:
-
-   1. Valid certificate file must be created
-   2. `ssl_certificate` options must be set to contain path to the
-       certificate file.
-   3. `listening_ports` option must contain a port number with letter `s`
-        appended to it, which instructs Mongoose to use SSL for all connections
-        made to that port.
-
-Below is the `mongoose.conf` file snippet for typical SSL setup:
-
-    document_root     www_root        # Serve files in www_root directory
-    listening_ports   80r,443s        # Redirect all HTTP requests to HTTPS
-    ssl_certificate   ssl_cert.pem    # Location of certificate file
-
-## How to create SSL certificate file
-
-SSL certificate file is a text file that must contain at least two
-sections:
-
-   1. A private key
-   2. A certificate
-
-Both sections should be chunks of text in PEM format. When PEM file is
-opened in a text editor, it looks like this:
-
-    -----BEGIN RSA PRIVATE KEY-----
-    MIIEogIBAAKCAQEAwONaLOP7EdegqjRuQKSDXzvHmFMZfBufjhELhNjo5KsL4ieH
-    hYN0Zii2yTb63jGxKY6gH1R/r9dL8kXaJmcZrfSa3AgywnteJWg=
-    -----END RSA PRIVATE KEY-----
-    -----BEGIN CERTIFICATE-----
-    MIIDBjCCAe4CCQCX05m0b053QzANBgkqhkiG9w0BAQQFADBFMQswCQYDVQQGEwJB
-    SEGI4JSxV56lYg==
-    -----END CERTIFICATE-----
-
-Two aforementioned sections are clearly seen. Typically, those section
-are bigger then in the example shown. The text between the `BEGIN` and
-`END` is the text representation of binary data, a private key and a
-certificate. Therefore, in order to create a certificate file,
-
-   * private key must be converted to PEM format
-   * certificate must be converted to PEM format
-   * those two should be concatenated into a single file
-
-If the certificate chain in used, a chain file also needs to be
-converted into PEM format and appended to the certificate file.
-
-## How SSL works
-
-SSL is a protocol that can encrypt communication between two parties. If third
-party observes all messages passed by, it would be very
-hard for the third party (though not impossible) to decrypt the communication.
-
-The idea is based on so-called public key encryption. Communicating parties
-have two keys: a public key and a private key. A public key is advertised
-to everybody, and it is contained in a certificate. A private key is kept
-secret. Security algorithm works in a way that anybody can encrypt
-a message using public key, and only private key can decrypt it.
-
-This is why web server needs both private key and certificate: private key
-is used to decrypt incoming messages, and certificate is used to tell the
-public key to the other party. When communication starts, parties exchange
-their public keys, and keep private keys to themselves. Man-in-the-middle
-who observes the communication is unable to decrypt the messages cause
-private keys are required for decryption.
-
-Encryption algorithms are built on top of hard mathematical problem, which
-makes it very expensive for man-in-the-middle to compute private keys.
-For example, RSA algorithm is based on a mathematical problem of factorization.
-It is easy to generate two very large prime numbers `P` and `Q` and make
-a product `P * Q`. But given a product, it is very hard to recover these
-two prime numbers - this is called factorization.

docs/Usage.md

@@ -1,85 +0,0 @@
-# Mongoose User Guide
-
-Mongoose is small and easy to use web server built on top of
-mongoose library. It is designed with maximum simplicity in mind. For example,
-to share any directory, just drop mongoose executable file in that directory,
-double-click it (on UNIX, run it from shell) and launch a browser at
-[http://localhost:8080](http://localhost:8080) Note that 'localhost' should
-be changed to a machine's name if a folder is accessed from other computer.
-
-On Windows and Mac, Mongoose iconifies itself to the system tray when started.
-Right-click on the icon pops up a menu, where it is possible to stop
-mongoose, or configure it.
-
-On UNIX, `mongoose` is a command line utility. Running `mongoose` in
-terminal, optionally followed by configuration parameters
-(`mongoose [OPTIONS]`) or configuration file name
-(`mongoose [config_file_name]`) starts the
-web server:
-
-    $ mongoose -document_root /var/www  # Running mongoose with cmdline options
-    $ mongoose /etc/my_config.txt       # Running mongoose with config file
-    $ mongoose                          # Running with no parameters. This will
-                                        # serve current directory on port 8080
-
-Mongoose does not detach from terminal. Pressing `Ctrl-C` keys
-stops the server.
-
-When started, mongoose first searches for the configuration file.
-If configuration file is specified explicitly in the command line, then
-specified configuration file is used.
-Otherwise, mongoose would search for file `mongoose.conf` in the same directory
-where binary is located, and use it. Configuration file can be absent.
-
-Configuration file is a sequence of lines, each line containing
-command line argument name and it's value. Empty lines and lines beginning
-with `#` are ignored. Here is the example of `mongoose.conf` file:
-
-    # This is a comment
-    document_root C:\www
-    listening_port 80
-    ssl_certificate C:\mongoose\ssl_cert.pem
-
-Command line arguments are highest priority and can override
-configuration file settings. For example, if `mongoose.conf` has line
-`document_root /var/www`, and mongoose has been started as
-`mongoose -document_root /etc`, then `/etc` directory will be used as
-document root.
-
-Note that configuration options on the command line must start with `-`,
-and their names are the same as in the config file. Exampli gratia,
-the following two setups are equivalent:
-
-    $ mongoose -listening_port 1234 -document_root /var/www
-
-    $ cat > mongoose.conf
-    listening_ports 1234
-    document_root /var/www
-    ^D
-    $ mongoose
-
-Mongoose can also be used to modify `.htpasswd` passwords file:
-
-    $ mongoose -A .htpasswd mydomain.com user_name user_password
-
-Unlike other web servers, mongoose does not require CGI scripts be located in
-a special directory. CGI scripts can be anywhere. CGI (and SSI) files are
-recognized by the file name pattern. Mongoose uses shell-like glob
-patterns. Pattern match starts at the beginning of the string, so essentially
-patterns are prefix patterns. Syntax is as follows:
-
-     **      Matches everything
-     *       Matches everything but slash character, '/'
-     ?       Matches any character
-     $       Matches the end of the string
-     |       Matches if pattern on the left side or the right side matches.
-
-All other characters in the pattern match themselves. Examples:
-
-    **.cgi$      Any string that ends with .cgi
-    /foo         Any string that begins with /foo
-    **a$|**b$    Any string that ends with a or b
-
-To restrict CGI files only to `/cgi-bin/` directory, use this setting:
-
-    $ mongoose -cgi_pattern /cgi-bin/*.cgi # Emulate /cgi-bin/ restriction

docs/build-options/disabling-flags.md

@@ -0,0 +1,12 @@
+---
+title: Disabling flags
+---
+
+- `MG_DISABLE_HTTP_WEBSOCKET` disable HTTP + Websocket protocol support
+- `MG_DISABLE_HTTP_DIGEST_AUTH` disable HTTP Digest (MD5) authorization support
+- `MG_DISABLE_MQTT` disable MQTT support
+- `MG_DISABLE_SHA1` disable SHA1 support (used by Websocket)
+- `MG_DISABLE_MD5` disable MD5 support (used by HTTP auth)
+- `MG_DISABLE_JSON_RPC` disable JSON-RPC support
+- `MG_DISABLE_SOCKETPAIR` disable `mg_broadcast()` API
+- `MG_DISABLE_HTTP_KEEP_ALIVE` useful for embedded systems to save resources

docs/build-options/enabling-flags.md

@@ -0,0 +1,11 @@
+---
+title: Enabling flags
+---
+
+- `MG_ENABLE_SSL` Enable OpenSSL support
+- `MG_ENABLE_IPV6` Enable IPV6 support
+- `MG_ENABLE_THREADS` enable `mg_start_thread()` API
+- `MG_ENABLE_MQTT_BROKER` enable MQTT broker
+- `MG_ENABLE_DNS_SERVER` enable DNS server
+- `MG_ENABLE_COAP` enable CoAP protocol
+- `MG_ENABLE_GETADDRINFO` enable `getaddrinfo()` in `mg_resolve2()`

docs/build-options/intro.md

@@ -0,0 +1,17 @@
+---
+title: Build Options
+---
+
+Mongoose source code ships in a single .c file that contains functionality
+for all supported protocols (modules). Modules can be disabled at compile
+time which reduces executable size. That can be done by setting preprocessor
+flags. Also, some preprocessor flags can be used to tune internal Mongoose
+parameters.
+
+To set a preprocessor flag during compile time, use `-D <PREPROCESSOR_FLAG>`
+compiler option. For example, to disable both MQTT and JSON-RPC,
+compile the application `my_app.c` like this (assumed UNIX system):
+
+```
+  $ cc my_app.c mongoose.c -D MG_DISABLE_MQTT -D MG_DISABLE_JSON_RPC
+```

docs/build-options/items.json

@@ -0,0 +1,9 @@
+{
+  "items": [
+    { "type": "markdown", "name": "intro.md" },
+    { "type": "markdown", "name": "enabling-flags.md" },
+    { "type": "markdown", "name": "disabling-flags.md" },
+    { "type": "markdown", "name": "platform-spec.md" },
+    { "type": "markdown", "name": "tunables.md" }
+  ]
+}

docs/build-options/platform-spec.md

@@ -0,0 +1,10 @@
+---
+title: Platform specific
+---
+
+Mongoose tries to detect the target platform whenever possible, but in some cases you have
+to explicitly declare some peculiarities of your target, such as:
+
+- `MG_LWIP`: use LWIP networking stack
+- `MG_CC3200`: enable workarounds for the TI CC3200 target.
+- `MG_ESP8266`: enable workarounds for the ESP8266 target, add `RTOS_SDK` to specify the RTOS SDK flavour.

docs/build-options/tunables.md

@@ -0,0 +1,11 @@
+---
+title: Tunables
+---
+
+- `MG_MALLOC`, `MG_CALLOC`, `MG_REALLOC`, `MG_FREE` allow to use custom
+  memory allocator, e.g. `-DMG_MALLOC=my_malloc`
+- `MG_USE_READ_WRITE` when set replaces calls to `recv` with `read` and `send` with `write`,
+  thus enabling to add any kind of file descriptor (files, serial devices) to an event manager.
+- `MG_SSL_CRYPTO_MODERN`, `MG_SSL_CRYPTO_OLD` - choose either "Modern" or "Old" ciphers
+  instead of the default "Intermediate" setting.
+  See [this article](https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations) for details.

docs/c-api/coap.h/intro.md

@@ -0,0 +1,16 @@
+---
+title: "CoAP"
+symbol_kind: "intro"
+decl_name: "coap.h"
+---
+
+CoAP message format:
+
+```
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
+|Ver| T | TKL | Code | Message ID | Token (if any, TKL bytes) ...
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
+| Options (if any) ...            |1 1 1 1 1 1 1 1| Payload (if any) ...
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
+```
+

docs/c-api/coap.h/items.json

@@ -0,0 +1,44 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_set_protocol_coap.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_add_option.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_free_options.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_send_message.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_send_ack.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_parse.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_coap_compose.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_coap_option.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_coap_message.md"
+        }
+    ]
+}

docs/c-api/coap.h/mg_coap_add_option.md

@@ -0,0 +1,13 @@
+---
+title: "mg_coap_add_option()"
+decl_name: "mg_coap_add_option"
+symbol_kind: "func"
+signature: |
+  struct mg_coap_option *mg_coap_add_option(struct mg_coap_message *cm,
+                                            uint32_t number, char *value,
+                                            size_t len);
+---
+
+Add new option to mg_coap_message structure.
+Returns pointer to the newly created option. 
+

docs/c-api/coap.h/mg_coap_compose.md

@@ -0,0 +1,12 @@
+---
+title: "mg_coap_compose()"
+decl_name: "mg_coap_compose"
+symbol_kind: "func"
+signature: |
+  uint32_t mg_coap_compose(struct mg_coap_message *cm, struct mbuf *io);
+---
+
+Composes CoAP message from mg_coap_message structure.
+This is a helper function.
+Return value: see `mg_coap_send_message()` 
+

docs/c-api/coap.h/mg_coap_free_options.md

@@ -0,0 +1,11 @@
+---
+title: "mg_coap_free_options()"
+decl_name: "mg_coap_free_options"
+symbol_kind: "func"
+signature: |
+  void mg_coap_free_options(struct mg_coap_message *cm);
+---
+
+Free the memory allocated for options,
+if cm paramater doesn't contain any option does nothing. 
+

docs/c-api/coap.h/mg_coap_parse.md

@@ -0,0 +1,22 @@
+---
+title: "mg_coap_parse()"
+decl_name: "mg_coap_parse"
+symbol_kind: "func"
+signature: |
+  uint32_t mg_coap_parse(struct mbuf *io, struct mg_coap_message *cm);
+---
+
+Parse COAP message and fills mg_coap_message and returns cm->flags.
+This is a helper function.
+
+NOTE: usually CoAP work over UDP, so lack of data means format error,
+but in theory it is possible to use CoAP over TCP (according to RFC)
+
+The caller have to check results and treat COAP_NOT_ENOUGH_DATA according to
+underlying protocol:
+
+- in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR,
+- in case of TCP client can try to receive more data
+
+Return value: see `mg_coap_send_message()` 
+

docs/c-api/coap.h/mg_coap_send_ack.md

@@ -0,0 +1,12 @@
+---
+title: "mg_coap_send_ack()"
+decl_name: "mg_coap_send_ack"
+symbol_kind: "func"
+signature: |
+  uint32_t mg_coap_send_ack(struct mg_connection *nc, uint16_t msg_id);
+---
+
+Compose CoAP acknowledgement from `mg_coap_message`
+and send it into `nc` connection.
+Return value: see `mg_coap_send_message()` 
+

docs/c-api/coap.h/mg_coap_send_message.md

@@ -0,0 +1,19 @@
+---
+title: "mg_coap_send_message()"
+decl_name: "mg_coap_send_message"
+symbol_kind: "func"
+signature: |
+  uint32_t mg_coap_send_message(struct mg_connection *nc,
+                                struct mg_coap_message *cm);
+---
+
+Compose CoAP message from `mg_coap_message`
+and send it into `nc` connection.
+Return 0 on success. On error, it is a bitmask:
+
+- `#define MG_COAP_ERROR 0x10000`
+- `#define MG_COAP_FORMAT_ERROR (MG_COAP_ERROR | 0x20000)`
+- `#define MG_COAP_IGNORE (MG_COAP_ERROR | 0x40000)`
+- `#define MG_COAP_NOT_ENOUGH_DATA (MG_COAP_ERROR | 0x80000)`
+- `#define MG_COAP_NETWORK_ERROR (MG_COAP_ERROR | 0x100000)` 
+

docs/c-api/coap.h/mg_set_protocol_coap.md

@@ -0,0 +1,10 @@
+---
+title: "mg_set_protocol_coap()"
+decl_name: "mg_set_protocol_coap"
+symbol_kind: "func"
+signature: |
+  int mg_set_protocol_coap(struct mg_connection *nc);
+---
+
+Set CoAP protocol handler - trigger CoAP specific events 
+

docs/c-api/coap.h/struct_mg_coap_message.md

@@ -0,0 +1,20 @@
+---
+title: "struct mg_coap_message"
+decl_name: "struct mg_coap_message"
+symbol_kind: "struct"
+signature: |
+  struct mg_coap_message {
+    uint32_t flags;
+    uint8_t msg_type;
+    uint8_t code_class;
+    uint8_t code_detail;
+    uint16_t msg_id;
+    struct mg_str token;
+    struct mg_coap_option *options;
+    struct mg_str payload;
+    struct mg_coap_option *optiomg_tail;
+  };
+---
+
+CoAP message. See RFC 7252 for details. 
+

docs/c-api/coap.h/struct_mg_coap_option.md

@@ -0,0 +1,16 @@
+---
+title: "struct mg_coap_option"
+decl_name: "struct mg_coap_option"
+symbol_kind: "struct"
+signature: |
+  struct mg_coap_option {
+    struct mg_coap_option *next;
+    uint32_t number;
+    struct mg_str value;
+  };
+---
+
+CoAP options.
+Use mg_coap_add_option and mg_coap_free_options
+for creation and destruction. 
+

docs/c-api/dns-server.h/intro.md

@@ -0,0 +1,8 @@
+---
+title: "DNS server"
+symbol_kind: "intro"
+decl_name: "dns-server.h"
+---
+
+Disabled by default; enable with `-DMG_ENABLE_DNS_SERVER`.
+

docs/c-api/dns-server.h/items.json

@@ -0,0 +1,20 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_create_reply.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_reply_record.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_send_reply.md"
+        }
+    ]
+}

docs/c-api/dns-server.h/mg_dns_create_reply.md

@@ -0,0 +1,36 @@
+---
+title: "mg_dns_create_reply()"
+decl_name: "mg_dns_create_reply"
+symbol_kind: "func"
+signature: |
+  struct mg_dns_reply mg_dns_create_reply(struct mbuf *io,
+                                          struct mg_dns_message *msg);
+---
+
+Create a DNS reply.
+
+The reply will be based on an existing query message `msg`.
+The query body will be appended to the output buffer.
+"reply + recursion allowed" will be added to the message flags and
+message's num_answers will be set to 0.
+
+Answer records can be appended with `mg_dns_send_reply` or by lower
+level function defined in the DNS API.
+
+In order to send the reply use `mg_dns_send_reply`.
+It's possible to use a connection's send buffer as reply buffers,
+and it will work for both UDP and TCP connections.
+
+Example:
+
+```c
+reply = mg_dns_create_reply(&nc->send_mbuf, msg);
+for (i = 0; i < msg->num_questions; i++) {
+  rr = &msg->questions[i];
+  if (rr->rtype == MG_DNS_A_RECORD) {
+    mg_dns_reply_record(&reply, rr, 3600, &dummy_ip_addr, 4);
+  }
+}
+mg_dns_send_reply(nc, &reply);
+``` 
+

docs/c-api/dns-server.h/mg_dns_reply_record.md

@@ -0,0 +1,18 @@
+---
+title: "mg_dns_reply_record()"
+decl_name: "mg_dns_reply_record"
+symbol_kind: "func"
+signature: |
+  int mg_dns_reply_record(struct mg_dns_reply *reply,
+                          struct mg_dns_resource_record *question,
+                          const char *name, int rtype, int ttl, const void *rdata,
+                          size_t rdata_len);
+---
+
+Append a DNS reply record to the IO buffer and to the DNS message.
+
+The message num_answers field will be incremented. It's caller's duty
+to ensure num_answers is propertly initialized.
+
+Returns -1 on error. 
+

docs/c-api/dns-server.h/mg_dns_send_reply.md

@@ -0,0 +1,19 @@
+---
+title: "mg_dns_send_reply()"
+decl_name: "mg_dns_send_reply"
+symbol_kind: "func"
+signature: |
+  void mg_dns_send_reply(struct mg_connection *nc, struct mg_dns_reply *r);
+---
+
+Send a DNS reply through a connection.
+
+The DNS data is stored in an IO buffer pointed by reply structure in `r`.
+This function mutates the content of that buffer in order to ensure that
+the DNS header reflects size and flags of the mssage, that might have been
+updated either with `mg_dns_reply_record` or by direct manipulation of
+`r->message`.
+
+Once sent, the IO buffer will be trimmed unless the reply IO buffer
+is the connection's send buffer and the connection is not in UDP mode. 
+

docs/c-api/dns.h/intro.md

@@ -0,0 +1,8 @@
+---
+title: "DNS"
+symbol_kind: "intro"
+decl_name: "dns.h"
+---
+
+
+

docs/c-api/dns.h/items.json

@@ -0,0 +1,48 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_parse_record_data.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_dns_query.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_insert_header.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_copy_body.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_encode_record.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_parse_dns.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_dns_uncompress_name.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_set_protocol_dns.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_dns_resource_record.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_dns_message.md"
+        }
+    ]
+}

docs/c-api/dns.h/mg_dns_copy_body.md

@@ -0,0 +1,15 @@
+---
+title: "mg_dns_copy_body()"
+decl_name: "mg_dns_copy_body"
+symbol_kind: "func"
+signature: |
+  int mg_dns_copy_body(struct mbuf *io, struct mg_dns_message *msg);
+---
+
+Append already encoded body from an existing message.
+
+This is useful when generating a DNS reply message which includes
+all question records.
+
+Return number of appened bytes. 
+

docs/c-api/dns.h/mg_dns_encode_record.md

@@ -0,0 +1,25 @@
+---
+title: "mg_dns_encode_record()"
+decl_name: "mg_dns_encode_record"
+symbol_kind: "func"
+signature: |
+  int mg_dns_encode_record(struct mbuf *io, struct mg_dns_resource_record *rr,
+                           const char *name, size_t nlen, const void *rdata,
+                           size_t rlen);
+---
+
+Encode and append a DNS resource record to an IO buffer.
+
+The record metadata is taken from the `rr` parameter, while the name and data
+are taken from the parameters, encoded in the appropriate format depending on
+record type, and stored in the IO buffer. The encoded values might contain
+offsets within the IO buffer. It's thus important that the IO buffer doesn't
+get trimmed while a sequence of records are encoded while preparing a DNS
+*reply.
+
+This function doesn't update the `name` and `rdata` pointers in the `rr`
+*struct
+because they might be invalidated as soon as the IO buffer grows again.
+
+Return the number of bytes appened or -1 in case of error. 
+

docs/c-api/dns.h/mg_dns_insert_header.md

@@ -0,0 +1,13 @@
+---
+title: "mg_dns_insert_header()"
+decl_name: "mg_dns_insert_header"
+symbol_kind: "func"
+signature: |
+  int mg_dns_insert_header(struct mbuf *io, size_t pos,
+                           struct mg_dns_message *msg);
+---
+
+Insert a DNS header to an IO buffer.
+
+Return number of bytes inserted. 
+

docs/c-api/dns.h/mg_dns_parse_record_data.md

@@ -0,0 +1,20 @@
+---
+title: "mg_dns_parse_record_data()"
+decl_name: "mg_dns_parse_record_data"
+symbol_kind: "func"
+signature: |
+  int mg_dns_parse_record_data(struct mg_dns_message *msg,
+                               struct mg_dns_resource_record *rr, void *data,
+                               size_t data_len);
+---
+
+Parse the record data from a DNS resource record.
+
+ - A:     struct in_addr *ina
+ - AAAA:  struct in6_addr *ina
+ - CNAME: char buffer
+
+Returns -1 on error.
+
+TODO(mkm): MX 
+

docs/c-api/dns.h/mg_dns_uncompress_name.md

@@ -0,0 +1,21 @@
+---
+title: "mg_dns_uncompress_name()"
+decl_name: "mg_dns_uncompress_name"
+symbol_kind: "func"
+signature: |
+  size_t mg_dns_uncompress_name(struct mg_dns_message *msg, struct mg_str *name,
+                                char *dst, int dst_len);
+---
+
+Uncompress a DNS compressed name.
+
+The containing dns message is required because the compressed encoding
+and reference suffixes present elsewhere in the packet.
+
+If name is less than `dst_len` characters long, the remainder
+of `dst` is terminated with `\0' characters. Otherwise, `dst` is not
+*terminated.
+
+If `dst_len` is 0 `dst` can be NULL.
+Return the uncompressed name length. 
+

docs/c-api/dns.h/mg_parse_dns.md

@@ -0,0 +1,10 @@
+---
+title: "mg_parse_dns()"
+decl_name: "mg_parse_dns"
+symbol_kind: "func"
+signature: |
+  int mg_parse_dns(const char *buf, int len, struct mg_dns_message *msg);
+---
+
+Low-level: parses a DNS response. 
+

docs/c-api/dns.h/mg_send_dns_query.md

@@ -0,0 +1,11 @@
+---
+title: "mg_send_dns_query()"
+decl_name: "mg_send_dns_query"
+symbol_kind: "func"
+signature: |
+  void mg_send_dns_query(struct mg_connection *nc, const char *name,
+                         int query_type);
+---
+
+Send a DNS query to the remote end. 
+

docs/c-api/dns.h/mg_set_protocol_dns.md

@@ -0,0 +1,19 @@
+---
+title: "mg_set_protocol_dns()"
+decl_name: "mg_set_protocol_dns"
+symbol_kind: "func"
+signature: |
+  void mg_set_protocol_dns(struct mg_connection *nc);
+---
+
+Attach built-in DNS event handler to the given listening connection.
+
+DNS event handler parses incoming UDP packets, treating them as DNS
+requests. If incoming packet gets successfully parsed by the DNS event
+handler, a user event handler will receive `MG_DNS_REQUEST` event, with
+`ev_data` pointing to the parsed `struct mg_dns_message`.
+
+See
+[captive_dns_server](https://github.com/cesanta/mongoose/tree/master/examples/captive_dns_server)
+example on how to handle DNS request and send DNS reply. 
+

docs/c-api/dns.h/struct_mg_dns_message.md

@@ -0,0 +1,18 @@
+---
+title: "struct mg_dns_message"
+decl_name: "struct mg_dns_message"
+symbol_kind: "struct"
+signature: |
+  struct mg_dns_message {
+    struct mg_str pkt; /* packet body */
+    uint16_t flags;
+    uint16_t transaction_id;
+    int num_questions;
+    int num_answers;
+    struct mg_dns_resource_record questions[MG_MAX_DNS_QUESTIONS];
+    struct mg_dns_resource_record answers[MG_MAX_DNS_ANSWERS];
+  };
+---
+
+DNS message (request and response). 
+

docs/c-api/dns.h/struct_mg_dns_resource_record.md

@@ -0,0 +1,17 @@
+---
+title: "struct mg_dns_resource_record"
+decl_name: "struct mg_dns_resource_record"
+symbol_kind: "struct"
+signature: |
+  struct mg_dns_resource_record {
+    struct mg_str name; /* buffer with compressed name */
+    int rtype;
+    int rclass;
+    int ttl;
+    enum mg_dns_resource_record_kind kind;
+    struct mg_str rdata; /* protocol data (can be a compressed name) */
+  };
+---
+
+DNS resource record. 
+

docs/c-api/http.h/intro.md

@@ -0,0 +1,8 @@
+---
+title: "HTTP + Websocket"
+symbol_kind: "intro"
+decl_name: "http.h"
+---
+
+
+

docs/c-api/http.h/items.json

@@ -0,0 +1,128 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_set_protocol_http_websocket.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_websocket_handshake.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_websocket_handshake2.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_connect_ws.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_connect_ws_opt.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_websocket_frame.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_websocket_framev.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_printf_websocket_frame.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_http_chunk.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_printf_http_chunk.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_response_line.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_send_head.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_printf_html_escape.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_parse_http.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_get_http_header.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_http_parse_header.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_parse_multipart.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_get_http_var.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_url_decode.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_http_create_digest_auth_header.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_connect_http.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_connect_http_opt.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_serve_http.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_register_http_endpoint.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_file_upload_handler.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_fu_fname_fn.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_http_message.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_websocket_message.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_http_multipart_part.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_serve_http_opts.md"
+        }
+    ]
+}

docs/c-api/http.h/mg_connect_http.md

@@ -0,0 +1,35 @@
+---
+title: "mg_connect_http()"
+decl_name: "mg_connect_http"
+symbol_kind: "func"
+signature: |
+  struct mg_connection *mg_connect_http(struct mg_mgr *mgr,
+                                        mg_event_handler_t event_handler,
+                                        const char *url,
+                                        const char *extra_headers,
+                                        const char *post_data);
+---
+
+Helper function that creates outbound HTTP connection.
+
+`url` is a URL to fetch. It must be properly URL-encoded, e.g. have
+no spaces, etc. By default, `mg_connect_http()` sends Connection and
+Host headers. `extra_headers` is an extra HTTP headers to send, e.g.
+`"User-Agent: my-app\r\n"`.
+If `post_data` is NULL, then GET request is created. Otherwise, POST request
+is created with the specified POST data. Note that if the data being posted
+is a form submission, the `Content-Type` header should be set accordingly
+(see example below).
+
+Examples:
+
+```c
+  nc1 = mg_connect_http(mgr, ev_handler_1, "http://www.google.com", NULL,
+                        NULL);
+  nc2 = mg_connect_http(mgr, ev_handler_1, "https://github.com", NULL, NULL);
+  nc3 = mg_connect_http(
+      mgr, ev_handler_1, "my_server:8000/form_submit/",
+      "Content-Type: application/x-www-form-urlencoded\r\n",
+      "var_1=value_1&var_2=value_2");
+``` 
+

docs/c-api/http.h/mg_connect_http_opt.md

@@ -0,0 +1,18 @@
+---
+title: "mg_connect_http_opt()"
+decl_name: "mg_connect_http_opt"
+symbol_kind: "func"
+signature: |
+  struct mg_connection *mg_connect_http_opt(struct mg_mgr *mgr,
+                                            mg_event_handler_t ev_handler,
+                                            struct mg_connect_opts opts,
+                                            const char *url,
+                                            const char *extra_headers,
+                                            const char *post_data);
+---
+
+Helper function that creates outbound HTTP connection.
+
+Mostly identical to mg_connect_http, but allows to provide extra parameters
+(for example, SSL parameters 
+

docs/c-api/http.h/mg_connect_ws.md

@@ -0,0 +1,30 @@
+---
+title: "mg_connect_ws()"
+decl_name: "mg_connect_ws"
+symbol_kind: "func"
+signature: |
+  struct mg_connection *mg_connect_ws(struct mg_mgr *mgr,
+                                      mg_event_handler_t event_handler,
+                                      const char *url, const char *protocol,
+                                      const char *extra_headers);
+---
+
+Helper function that creates an outbound WebSocket connection.
+
+`url` is a URL to connect to. It must be properly URL-encoded, e.g. have
+no spaces, etc. By default, `mg_connect_ws()` sends Connection and
+Host headers. `extra_headers` is an extra HTTP headers to send, e.g.
+`"User-Agent: my-app\r\n"`.
+If `protocol` is not NULL, then a `Sec-WebSocket-Protocol` header is sent.
+
+Examples:
+
+```c
+  nc1 = mg_connect_ws(mgr, ev_handler_1, "ws://echo.websocket.org", NULL,
+                      NULL);
+  nc2 = mg_connect_ws(mgr, ev_handler_1, "wss://echo.websocket.org", NULL,
+                      NULL);
+  nc3 = mg_connect_ws(mgr, ev_handler_1, "ws://api.cesanta.com",
+                      "clubby.cesanta.com", NULL);
+``` 
+

docs/c-api/http.h/mg_connect_ws_opt.md

@@ -0,0 +1,17 @@
+---
+title: "mg_connect_ws_opt()"
+decl_name: "mg_connect_ws_opt"
+symbol_kind: "func"
+signature: |
+  struct mg_connection *mg_connect_ws_opt(struct mg_mgr *mgr,
+                                          mg_event_handler_t ev_handler,
+                                          struct mg_connect_opts opts,
+                                          const char *url, const char *protocol,
+                                          const char *extra_headers);
+---
+
+Helper function that creates an outbound WebSocket connection
+
+Mostly identical to mg_connect_ws, but allows to provide extra parameters
+(for example, SSL parameters 
+

docs/c-api/http.h/mg_file_upload_handler.md

@@ -0,0 +1,39 @@
+---
+title: "mg_file_upload_handler()"
+decl_name: "mg_file_upload_handler"
+symbol_kind: "func"
+signature: |
+  void mg_file_upload_handler(struct mg_connection *nc, int ev, void *ev_data,
+                              mg_fu_fname_fn local_name_fn);
+---
+
+File upload handler.
+This handler can be used to implement file uploads with minimum code.
+This handler will process MG_EV_HTTP_PART_* events and store file data into
+a local file.
+`local_name_fn` will be invoked with whatever name was provided by the client
+and will expect the name of the local file to open. Return value of NULL will
+abort file upload (client will get a "403 Forbidden" response). If non-null,
+the returned string must be heap-allocated and will be freed by the caller.
+Exception: it is ok to return the same string verbatim.
+
+Example:
+
+```c
+struct mg_str upload_fname(struct mg_connection *nc, struct mg_str fname) {
+  // Just return the same filename. Do not actually do this except in test!
+  // fname is user-controlled and needs to be sanitized.
+  return fname;
+}
+void ev_handler(struct mg_connection *nc, int ev, void *ev_data) {
+  switch (ev) {
+    ...
+    case MG_EV_HTTP_PART_BEGIN:
+    case MG_EV_HTTP_PART_DATA:
+    case MG_EV_HTTP_PART_END:
+      mg_file_upload_handler(nc, ev, ev_data, upload_fname);
+      break;
+  }
+}
+``` 
+

docs/c-api/http.h/mg_fu_fname_fn.md

@@ -0,0 +1,11 @@
+---
+title: "mg_fu_fname_fn"
+decl_name: "mg_fu_fname_fn"
+symbol_kind: "typedef"
+signature: |
+  typedef struct mg_str (*mg_fu_fname_fn)(struct mg_connection *nc,
+                                          struct mg_str fname);
+---
+
+Callback prototype for `mg_file_upload_handler()`. 
+

docs/c-api/http.h/mg_get_http_header.md

@@ -0,0 +1,13 @@
+---
+title: "mg_get_http_header()"
+decl_name: "mg_get_http_header"
+symbol_kind: "func"
+signature: |
+  struct mg_str *mg_get_http_header(struct http_message *hm, const char *name);
+---
+
+Search and return header `name` in parsed HTTP message `hm`.
+If header is not found, NULL is returned. Example:
+
+    struct mg_str *host_hdr = mg_get_http_header(hm, "Host"); 
+

docs/c-api/http.h/mg_get_http_var.md

@@ -0,0 +1,16 @@
+---
+title: "mg_get_http_var()"
+decl_name: "mg_get_http_var"
+symbol_kind: "func"
+signature: |
+  int mg_get_http_var(const struct mg_str *buf, const char *name, char *dst,
+                      size_t dst_len);
+---
+
+Fetch an HTTP form variable.
+
+Fetch a variable `name` from a `buf` into a buffer specified by
+`dst`, `dst_len`. Destination is always zero-terminated. Return length
+of a fetched variable. If not found, 0 is returned. `buf` must be
+valid url-encoded buffer. If destination is too small, `-1` is returned. 
+

docs/c-api/http.h/mg_http_create_digest_auth_header.md

@@ -0,0 +1,13 @@
+---
+title: "mg_http_create_digest_auth_header()"
+decl_name: "mg_http_create_digest_auth_header"
+symbol_kind: "func"
+signature: |
+  int mg_http_create_digest_auth_header(char *buf, size_t buf_len,
+                                        const char *method, const char *uri,
+                                        const char *auth_domain, const char *user,
+                                        const char *passwd);
+---
+
+Create Digest authentication header for client request. 
+

docs/c-api/http.h/mg_http_parse_header.md

@@ -0,0 +1,23 @@
+---
+title: "mg_http_parse_header()"
+decl_name: "mg_http_parse_header"
+symbol_kind: "func"
+signature: |
+  int mg_http_parse_header(struct mg_str *hdr, const char *var_name, char *buf,
+                           size_t buf_size);
+---
+
+Parse HTTP header `hdr`. Find variable `var_name` and store it's value
+in the buffer `buf`, `buf_size`. Return 0 if variable not found, non-zero
+otherwise.
+
+This function is supposed to parse
+cookies, authentication headers, etcetera. Example (error handling omitted):
+
+    char user[20];
+    struct mg_str *hdr = mg_get_http_header(hm, "Authorization");
+    mg_http_parse_header(hdr, "username", user, sizeof(user));
+
+Return length of the variable's value. If buffer is not large enough,
+or variable not found, 0 is returned. 
+

docs/c-api/http.h/mg_parse_http.md

@@ -0,0 +1,15 @@
+---
+title: "mg_parse_http()"
+decl_name: "mg_parse_http"
+symbol_kind: "func"
+signature: |
+  int mg_parse_http(const char *s, int n, struct http_message *hm, int is_req);
+---
+
+Parse a HTTP message.
+
+`is_req` should be set to 1 if parsing request, 0 if reply.
+
+Return number of bytes parsed. If HTTP message is
+incomplete, `0` is returned. On parse error, negative number is returned. 
+

docs/c-api/http.h/mg_parse_multipart.md

@@ -0,0 +1,46 @@
+---
+title: "mg_parse_multipart()"
+decl_name: "mg_parse_multipart"
+symbol_kind: "func"
+signature: |
+  size_t mg_parse_multipart(const char *buf, size_t buf_len, char *var_name,
+                            size_t var_name_len, char *file_name,
+                            size_t file_name_len, const char **chunk,
+                            size_t *chunk_len);
+---
+
+Parse buffer `buf`, `buf_len` that contains multipart form data chunks.
+Store chunk name in a `var_name`, `var_name_len` buffer.
+If a chunk is an uploaded file, then `file_name`, `file_name_len` is
+filled with an uploaded file name. `chunk`, `chunk_len`
+points to the chunk data.
+
+Return: number of bytes to skip to the next chunk, or 0 if there are
+        no more chunks.
+
+Usage example:
+
+```c
+   static void ev_handler(struct mg_connection *nc, int ev, void *ev_data) {
+     switch(ev) {
+       case MG_EV_HTTP_REQUEST: {
+         struct http_message *hm = (struct http_message *) ev_data;
+         char var_name[100], file_name[100];
+         const char *chunk;
+         size_t chunk_len, n1, n2;
+
+         n1 = n2 = 0;
+         while ((n2 = mg_parse_multipart(hm->body.p + n1,
+                                         hm->body.len - n1,
+                                         var_name, sizeof(var_name),
+                                         file_name, sizeof(file_name),
+                                         &chunk, &chunk_len)) > 0) {
+           printf("var: %s, file_name: %s, size: %d, chunk: [%.*s]\n",
+                  var_name, file_name, (int) chunk_len,
+                  (int) chunk_len, chunk);
+           n1 += n2;
+         }
+       }
+       break;
+``` 
+

docs/c-api/http.h/mg_printf_html_escape.md

@@ -0,0 +1,10 @@
+---
+title: "mg_printf_html_escape()"
+decl_name: "mg_printf_html_escape"
+symbol_kind: "func"
+signature: |
+  void mg_printf_html_escape(struct mg_connection *nc, const char *fmt, ...);
+---
+
+Send printf-formatted HTTP chunk, escaping HTML tags. 
+

docs/c-api/http.h/mg_printf_http_chunk.md

@@ -0,0 +1,11 @@
+---
+title: "mg_printf_http_chunk()"
+decl_name: "mg_printf_http_chunk"
+symbol_kind: "func"
+signature: |
+  void mg_printf_http_chunk(struct mg_connection *nc, const char *fmt, ...);
+---
+
+Send printf-formatted HTTP chunk.
+Functionality is similar to `mg_send_http_chunk()`. 
+

docs/c-api/http.h/mg_printf_websocket_frame.md

@@ -0,0 +1,14 @@
+---
+title: "mg_printf_websocket_frame()"
+decl_name: "mg_printf_websocket_frame"
+symbol_kind: "func"
+signature: |
+  void mg_printf_websocket_frame(struct mg_connection *nc, int op_and_flags,
+                                 const char *fmt, ...);
+---
+
+Send websocket frame to the remote end.
+
+Like `mg_send_websocket_frame()`, but allows to create formatted message
+with `printf()`-like semantics. 
+

docs/c-api/http.h/mg_register_http_endpoint.md

@@ -0,0 +1,35 @@
+---
+title: "mg_register_http_endpoint()"
+decl_name: "mg_register_http_endpoint"
+symbol_kind: "func"
+signature: |
+  void mg_register_http_endpoint(struct mg_connection *nc, const char *uri_path,
+                                 mg_event_handler_t handler);
+---
+
+Register callback for specified http endpoint
+Note: if callback is registered it is called instead of
+callback provided in mg_bind
+
+Example code snippet:
+
+```c
+static void handle_hello1(struct mg_connection *nc, int ev, void *ev_data) {
+  (void) ev; (void) ev_data;
+  mg_printf(nc, "HTTP/1.0 200 OK\r\n\r\n[I am Hello1]");
+ nc->flags |= MG_F_SEND_AND_CLOSE;
+}
+
+static void handle_hello1(struct mg_connection *nc, int ev, void *ev_data) {
+ (void) ev; (void) ev_data;
+  mg_printf(nc, "HTTP/1.0 200 OK\r\n\r\n[I am Hello2]");
+ nc->flags |= MG_F_SEND_AND_CLOSE;
+}
+
+void init() {
+  nc = mg_bind(&mgr, local_addr, cb1);
+  mg_register_http_endpoint(nc, "/hello1", handle_hello1);
+  mg_register_http_endpoint(nc, "/hello1/hello2", handle_hello2);
+}
+``` 
+

docs/c-api/http.h/mg_send_head.md

@@ -0,0 +1,21 @@
+---
+title: "mg_send_head()"
+decl_name: "mg_send_head"
+symbol_kind: "func"
+signature: |
+  void mg_send_head(struct mg_connection *n, int status_code,
+                    int64_t content_length, const char *extra_headers);
+---
+
+Send response line and headers.
+This function sends response line with the `status_code`, and automatically
+sends one header: either "Content-Length", or "Transfer-Encoding".
+If `content_length` is negative, then "Transfer-Encoding: chunked" header
+is sent, otherwise, "Content-Length" header is sent.
+
+NOTE: If `Transfer-Encoding` is `chunked`, then message body must be sent
+using `mg_send_http_chunk()` or `mg_printf_http_chunk()` functions.
+Otherwise, `mg_send()` or `mg_printf()` must be used.
+Extra headers could be set through `extra_headers` - and note `extra_headers`
+must NOT be terminated by a new line. 
+

docs/c-api/http.h/mg_send_http_chunk.md

@@ -0,0 +1,25 @@
+---
+title: "mg_send_http_chunk()"
+decl_name: "mg_send_http_chunk"
+symbol_kind: "func"
+signature: |
+  void mg_send_http_chunk(struct mg_connection *nc, const char *buf, size_t len);
+---
+
+Send buffer `buf` of size `len` to the client using chunked HTTP encoding.
+This function first sends buffer size as hex number + newline, then
+buffer itself, then newline. For example,
+  `mg_send_http_chunk(nc, "foo", 3)` whill append `3\r\nfoo\r\n` string to
+the `nc->send_mbuf` output IO buffer.
+
+NOTE: HTTP header "Transfer-Encoding: chunked" should be sent prior to
+using this function.
+
+NOTE: do not forget to send empty chunk at the end of the response,
+to tell the client that everything was sent. Example:
+
+```
+  mg_printf_http_chunk(nc, "%s", "my response!");
+  mg_send_http_chunk(nc, "", 0); // Tell the client we're finished
+``` 
+

docs/c-api/http.h/mg_send_response_line.md

@@ -0,0 +1,21 @@
+---
+title: "mg_send_response_line()"
+decl_name: "mg_send_response_line"
+symbol_kind: "func"
+signature: |
+  void mg_send_response_line(struct mg_connection *c, int status_code,
+                             const char *extra_headers);
+---
+
+Send response status line.
+If `extra_headers` is not NULL, then `extra_headers` are also sent
+after the reponse line. `extra_headers` must NOT end end with new line.
+Example:
+
+     mg_send_response_line(nc, 200, "Access-Control-Allow-Origin: *");
+
+Will result in:
+
+     HTTP/1.1 200 OK\r\n
+     Access-Control-Allow-Origin: *\r\n 
+

docs/c-api/http.h/mg_send_websocket_frame.md

@@ -0,0 +1,26 @@
+---
+title: "mg_send_websocket_frame()"
+decl_name: "mg_send_websocket_frame"
+symbol_kind: "func"
+signature: |
+  void mg_send_websocket_frame(struct mg_connection *nc, int op_and_flags,
+                               const void *data, size_t data_len);
+---
+
+Send websocket frame to the remote end.
+
+`op_and_flags` specifies frame's type, one of:
+
+- WEBSOCKET_OP_CONTINUE
+- WEBSOCKET_OP_TEXT
+- WEBSOCKET_OP_BINARY
+- WEBSOCKET_OP_CLOSE
+- WEBSOCKET_OP_PING
+- WEBSOCKET_OP_PONG
+
+Orred with one of the flags:
+
+- WEBSOCKET_DONT_FIN: Don't set the FIN flag on the frame to be sent.
+
+`data` and `data_len` contain frame data. 
+

docs/c-api/http.h/mg_send_websocket_framev.md

@@ -0,0 +1,13 @@
+---
+title: "mg_send_websocket_framev()"
+decl_name: "mg_send_websocket_framev"
+symbol_kind: "func"
+signature: |
+  void mg_send_websocket_framev(struct mg_connection *nc, int op_and_flags,
+                                const struct mg_str *strings, int num_strings);
+---
+
+Send multiple websocket frames.
+
+Like `mg_send_websocket_frame()`, but composes a frame from multiple buffers. 
+

docs/c-api/http.h/mg_send_websocket_handshake.md

@@ -0,0 +1,22 @@
+---
+title: "mg_send_websocket_handshake()"
+decl_name: "mg_send_websocket_handshake"
+symbol_kind: "func"
+signature: |
+  void mg_send_websocket_handshake(struct mg_connection *nc, const char *uri,
+                                   const char *extra_headers);
+---
+
+Send websocket handshake to the server.
+
+`nc` must be a valid connection, connected to a server. `uri` is an URI
+to fetch, extra_headers` is extra HTTP headers to send or `NULL`.
+
+This function is intended to be used by websocket client.
+
+Note that the Host header is mandatory in HTTP/1.1 and must be
+included in `extra_headers`. `mg_send_websocket_handshake2` offers
+a better API for that.
+
+Deprecated in favour of `mg_send_websocket_handshake2` 
+

docs/c-api/http.h/mg_send_websocket_handshake2.md

@@ -0,0 +1,19 @@
+---
+title: "mg_send_websocket_handshake2()"
+decl_name: "mg_send_websocket_handshake2"
+symbol_kind: "func"
+signature: |
+  void mg_send_websocket_handshake2(struct mg_connection *nc, const char *path,
+                                    const char *host, const char *protocol,
+                                    const char *extra_headers);
+---
+
+Send websocket handshake to the server.
+
+`nc` must be a valid connection, connected to a server. `uri` is an URI
+to fetch, `host` goes into the `Host` header, `protocol` goes into the
+`Sec-WebSocket-Proto` header (NULL to omit), extra_headers` is extra HTTP
+headers to send or `NULL`.
+
+This function is intended to be used by websocket client. 
+

docs/c-api/http.h/mg_serve_http.md

@@ -0,0 +1,28 @@
+---
+title: "mg_serve_http()"
+decl_name: "mg_serve_http"
+symbol_kind: "func"
+signature: |
+  void mg_serve_http(struct mg_connection *nc, struct http_message *hm,
+                     struct mg_serve_http_opts opts);
+---
+
+Serve given HTTP request according to the `options`.
+
+Example code snippet:
+
+```c
+static void ev_handler(struct mg_connection *nc, int ev, void *ev_data) {
+  struct http_message *hm = (struct http_message *) ev_data;
+  struct mg_serve_http_opts opts = { .document_root = "/var/www" };  // C99
+
+  switch (ev) {
+    case MG_EV_HTTP_REQUEST:
+      mg_serve_http(nc, hm, opts);
+      break;
+    default:
+      break;
+  }
+}
+``` 
+

docs/c-api/http.h/mg_set_protocol_http_websocket.md

@@ -0,0 +1,50 @@
+---
+title: "mg_set_protocol_http_websocket()"
+decl_name: "mg_set_protocol_http_websocket"
+symbol_kind: "func"
+signature: |
+  void mg_set_protocol_http_websocket(struct mg_connection *nc);
+---
+
+Attach built-in HTTP event handler to the given connection.
+User-defined event handler will receive following extra events:
+
+- MG_EV_HTTP_REQUEST: HTTP request has arrived. Parsed HTTP request
+ is passed as
+  `struct http_message` through the handler's `void *ev_data` pointer.
+- MG_EV_HTTP_MULTIPART_REQUEST: A multipart POST request has received.
+  This event is sent before body is parsed. After this user
+  should expect a sequence of MG_EV_HTTP_PART_BEGIN/DATA/END requests.
+  This is also the last time when headers and other request fields are
+  accessible.
+- MG_EV_HTTP_REPLY: HTTP reply has arrived. Parsed HTTP reply is passed as
+  `struct http_message` through the handler's `void *ev_data` pointer.
+- MG_EV_HTTP_CHUNK: HTTP chunked-encoding chunk has arrived.
+  Parsed HTTP reply is passed as `struct http_message` through the
+  handler's `void *ev_data` pointer. `http_message::body` would contain
+  incomplete, reassembled HTTP body.
+  It will grow with every new chunk arrived, and
+  potentially can consume a lot of memory. An event handler may process
+  the body as chunks are coming, and signal Mongoose to delete processed
+  body by setting `MG_F_DELETE_CHUNK` in `mg_connection::flags`. When
+  the last zero chunk is received,
+  Mongoose sends `MG_EV_HTTP_REPLY` event with
+  full reassembled body (if handler did not signal to delete chunks) or
+  with empty body (if handler did signal to delete chunks).
+- MG_EV_WEBSOCKET_HANDSHAKE_REQUEST: server has received websocket handshake
+  request. `ev_data` contains parsed HTTP request.
+- MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed Websocket handshake.
+  `ev_data` is `NULL`.
+- MG_EV_WEBSOCKET_FRAME: new websocket frame has arrived. `ev_data` is
+  `struct websocket_message *`
+- MG_EV_HTTP_PART_BEGIN: new part of multipart message is started,
+  extra parameters are passed in mg_http_multipart_part
+- MG_EV_HTTP_PART_DATA: new portion of data from multiparted message
+  no additional headers are available, only data and data size
+- MG_EV_HTTP_PART_END: final boundary received, analogue to maybe used to
+  find the end of packet
+  Note: Mongoose should be compiled with MG_ENABLE_HTTP_STREAMING_MULTIPART
+  to enable MG_EV_HTTP_MULTIPART_REQUEST, MG_EV_HTTP_REQUEST_END,
+  MG_EV_HTTP_REQUEST_CANCEL, MG_EV_HTTP_PART_BEGIN, MG_EV_HTTP_PART_DATA,
+  MG_EV_HTTP_PART_END constants 
+

docs/c-api/http.h/mg_url_decode.md

@@ -0,0 +1,18 @@
+---
+title: "mg_url_decode()"
+decl_name: "mg_url_decode"
+symbol_kind: "func"
+signature: |
+  int mg_url_decode(const char *src, int src_len, char *dst, int dst_len,
+                    int is_form_url_encoded);
+---
+
+Decode URL-encoded string.
+
+Source string is specified by (`src`, `src_len`), and destination is
+(`dst`, `dst_len`). If `is_form_url_encoded` is non-zero, then
+`+` character is decoded as a blank space character. This function
+guarantees to `\0`-terminate the destination. If destination is too small,
+then source string is partially decoded and `-1` is returned. Otherwise,
+a length of decoded string is returned, not counting final `\0`. 
+

docs/c-api/http.h/struct_http_message.md

@@ -0,0 +1,38 @@
+---
+title: "struct http_message"
+decl_name: "struct http_message"
+symbol_kind: "struct"
+signature: |
+  struct http_message {
+    struct mg_str message; /* Whole message: request line + headers + body */
+  
+    /* HTTP Request line (or HTTP response line) */
+    struct mg_str method; /* "GET" */
+    struct mg_str uri;    /* "/my_file.html" */
+    struct mg_str proto;  /* "HTTP/1.1" -- for both request and response */
+  
+    /* For responses, code and response status message are set */
+    int resp_code;
+    struct mg_str resp_status_msg;
+  
+    /*
+     * Query-string part of the URI. For example, for HTTP request
+     *    GET /foo/bar?param1=val1&param2=val2
+     *    |    uri    |     query_string     |
+     *
+     * Note that question mark character doesn't belong neither to the uri,
+     * nor to the query_string
+     */
+    struct mg_str query_string;
+  
+    /* Headers */
+    struct mg_str header_names[MG_MAX_HTTP_HEADERS];
+    struct mg_str header_values[MG_MAX_HTTP_HEADERS];
+  
+    /* Message body */
+    struct mg_str body; /* Zero-length for requests with no body */
+  };
+---
+
+HTTP message 
+

docs/c-api/http.h/struct_mg_http_multipart_part.md

@@ -0,0 +1,16 @@
+---
+title: "struct mg_http_multipart_part"
+decl_name: "struct mg_http_multipart_part"
+symbol_kind: "struct"
+signature: |
+  struct mg_http_multipart_part {
+    const char *file_name;
+    const char *var_name;
+    struct mg_str data;
+    int status; /* <0 on error */
+    void *user_data;
+  };
+---
+
+HTTP multipart part 
+

docs/c-api/http.h/struct_mg_serve_http_opts.md

@@ -0,0 +1,104 @@
+---
+title: "struct mg_serve_http_opts"
+decl_name: "struct mg_serve_http_opts"
+symbol_kind: "struct"
+signature: |
+  struct mg_serve_http_opts {
+    /* Path to web root directory */
+    const char *document_root;
+  
+    /* List of index files. Default is "" */
+    const char *index_files;
+  
+    /*
+     * Leave as NULL to disable authentication.
+     * To enable directory protection with authentication, set this to ".htpasswd"
+     * Then, creating ".htpasswd" file in any directory automatically protects
+     * it with digest authentication.
+     * Use `mongoose` web server binary, or `htdigest` Apache utility to
+     * create/manipulate passwords file.
+     * Make sure `auth_domain` is set to a valid domain name.
+     */
+    const char *per_directory_auth_file;
+  
+    /* Authorization domain (domain name of this web server) */
+    const char *auth_domain;
+  
+    /*
+     * Leave as NULL to disable authentication.
+     * Normally, only selected directories in the document root are protected.
+     * If absolutely every access to the web server needs to be authenticated,
+     * regardless of the URI, set this option to the path to the passwords file.
+     * Format of that file is the same as ".htpasswd" file. Make sure that file
+     * is located outside document root to prevent people fetching it.
+     */
+    const char *global_auth_file;
+  
+    /* Set to "no" to disable directory listing. Enabled by default. */
+    const char *enable_directory_listing;
+  
+    /* SSI files pattern. If not set, "**.shtml$|**.shtm$" is used. */
+    const char *ssi_pattern;
+  
+    /* IP ACL. By default, NULL, meaning all IPs are allowed to connect */
+    const char *ip_acl;
+  
+    /* URL rewrites.
+     *
+     * Comma-separated list of `uri_pattern=file_or_directory_path` rewrites.
+     * When HTTP request is received, Mongoose constructs a file name from the
+     * requested URI by combining `document_root` and the URI. However, if the
+     * rewrite option is used and `uri_pattern` matches requested URI, then
+     * `document_root` is ignored. Instead, `file_or_directory_path` is used,
+     * which should be a full path name or a path relative to the web server's
+     * current working directory. Note that `uri_pattern`, as all Mongoose
+     * patterns, is a prefix pattern.
+     *
+     * If uri_pattern starts with `@` symbol, then Mongoose compares it with the
+     * HOST header of the request. If they are equal, Mongoose sets document root
+     * to `file_or_directory_path`, implementing virtual hosts support.
+     * Example: `@foo.com=/document/root/for/foo.com`
+     *
+     * If `uri_pattern` starts with `%` symbol, then Mongoose compares it with
+     * the listening port. If they match, then Mongoose issues a 301 redirect.
+     * For example, to redirect all HTTP requests to the
+     * HTTPS port, do `%80=https://my.site.com`. Note that the request URI is
+     * automatically appended to the redirect location.
+     */
+    const char *url_rewrites;
+  
+    /* DAV document root. If NULL, DAV requests are going to fail. */
+    const char *dav_document_root;
+  
+    /*
+     * DAV passwords file. If NULL, DAV requests are going to fail.
+     * If passwords file is set to "-", then DAV auth is disabled.
+     */
+    const char *dav_auth_file;
+  
+    /* Glob pattern for the files to hide. */
+    const char *hidden_file_pattern;
+  
+    /* Set to non-NULL to enable CGI, e.g. **.cgi$|**.php$" */
+    const char *cgi_file_pattern;
+  
+    /* If not NULL, ignore CGI script hashbang and use this interpreter */
+    const char *cgi_interpreter;
+  
+    /*
+     * Comma-separated list of Content-Type overrides for path suffixes, e.g.
+     * ".txt=text/plain; charset=utf-8,.c=text/plain"
+     */
+    const char *custom_mime_types;
+  
+    /*
+     * Extra HTTP headers to add to each server response.
+     * Example: to enable CORS, set this to "Access-Control-Allow-Origin: *".
+     */
+    const char *extra_headers;
+  };
+---
+
+This structure defines how `mg_serve_http()` works.
+Best practice is to set only required settings, and leave the rest as NULL. 
+

docs/c-api/http.h/struct_websocket_message.md

@@ -0,0 +1,14 @@
+---
+title: "struct websocket_message"
+decl_name: "struct websocket_message"
+symbol_kind: "struct"
+signature: |
+  struct websocket_message {
+    unsigned char *data;
+    size_t size;
+    unsigned char flags;
+  };
+---
+
+WebSocket message 
+

docs/c-api/items.json

@@ -0,0 +1,44 @@
+{
+    "items": [
+        {
+            "type": "section",
+            "name": "mbuf.h"
+        },
+        {
+            "type": "section",
+            "name": "net.h"
+        },
+        {
+            "type": "section",
+            "name": "http.h"
+        },
+        {
+            "type": "section",
+            "name": "json-rpc.h"
+        },
+        {
+            "type": "section",
+            "name": "dns.h"
+        },
+        {
+            "type": "section",
+            "name": "dns-server.h"
+        },
+        {
+            "type": "section",
+            "name": "mqtt.h"
+        },
+        {
+            "type": "section",
+            "name": "mqtt-broker.h"
+        },
+        {
+            "type": "section",
+            "name": "coap.h"
+        },
+        {
+            "type": "section",
+            "name": "util.h"
+        }
+    ]
+}

docs/c-api/json-rpc.h/intro.md

@@ -0,0 +1,8 @@
+---
+title: "JSON-RPC"
+symbol_kind: "intro"
+decl_name: "json-rpc.h"
+---
+
+
+

docs/c-api/json-rpc.h/items.json

@@ -0,0 +1,44 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_parse_reply.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_create_request.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_create_reply.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_create_error.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_create_std_error.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mg_rpc_dispatch.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_rpc_request.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_rpc_reply.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mg_rpc_error.md"
+        }
+    ]
+}

docs/c-api/json-rpc.h/mg_rpc_create_error.md

@@ -0,0 +1,16 @@
+---
+title: "mg_rpc_create_error()"
+decl_name: "mg_rpc_create_error"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_create_error(char *buf, int len, struct mg_rpc_request *req,
+                          int code, const char *message, const char *fmt, ...);
+---
+
+Create JSON-RPC error reply in a given buffer.
+
+Return length of the error, which
+can be larger then `len` that indicates an overflow.
+`fmt` format string should conform to `json_emit()` API,
+see https://github.com/cesanta/frozen 
+

docs/c-api/json-rpc.h/mg_rpc_create_reply.md

@@ -0,0 +1,16 @@
+---
+title: "mg_rpc_create_reply()"
+decl_name: "mg_rpc_create_reply"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_create_reply(char *buf, int len, const struct mg_rpc_request *req,
+                          const char *result_fmt, ...);
+---
+
+Create JSON-RPC reply in a given buffer.
+
+Return length of the reply, which
+can be larger then `len` that indicates an overflow.
+`result_fmt` format string should conform to `json_emit()` API,
+see https://github.com/cesanta/frozen 
+

docs/c-api/json-rpc.h/mg_rpc_create_request.md

@@ -0,0 +1,16 @@
+---
+title: "mg_rpc_create_request()"
+decl_name: "mg_rpc_create_request"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_create_request(char *buf, int len, const char *method,
+                            const char *id, const char *params_fmt, ...);
+---
+
+Create JSON-RPC request in a given buffer.
+
+Return length of the request, which
+can be larger then `len` that indicates an overflow.
+`params_fmt` format string should conform to `json_emit()` API,
+see https://github.com/cesanta/frozen 
+

docs/c-api/json-rpc.h/mg_rpc_create_std_error.md

@@ -0,0 +1,22 @@
+---
+title: "mg_rpc_create_std_error()"
+decl_name: "mg_rpc_create_std_error"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_create_std_error(char *buf, int len, struct mg_rpc_request *req,
+                              int code);
+---
+
+Create JSON-RPC error in a given buffer.
+
+Return length of the error, which
+can be larger then `len` that indicates an overflow. See
+JSON_RPC_*_ERROR definitions for standard error values:
+
+- `#define JSON_RPC_PARSE_ERROR (-32700)`
+- `#define JSON_RPC_INVALID_REQUEST_ERROR (-32600)`
+- `#define JSON_RPC_METHOD_NOT_FOUND_ERROR (-32601)`
+- `#define JSON_RPC_INVALID_PARAMS_ERROR (-32602)`
+- `#define JSON_RPC_INTERNAL_ERROR (-32603)`
+- `#define JSON_RPC_SERVER_ERROR (-32000)` 
+

docs/c-api/json-rpc.h/mg_rpc_dispatch.md

@@ -0,0 +1,20 @@
+---
+title: "mg_rpc_dispatch()"
+decl_name: "mg_rpc_dispatch"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_dispatch(const char *buf, int, char *dst, int dst_len,
+                      const char **methods, mg_rpc_handler_t *handlers);
+---
+
+Dispatches a JSON-RPC request.
+
+Parses JSON-RPC request contained in `buf`, `len`.
+Then, dispatches the request to the correct handler method.
+Valid method names should be specified in NULL
+terminated array `methods`, and corresponding handlers in `handlers`.
+Result is put in `dst`, `dst_len`. Return: length of the result, which
+can be larger then `dst_len` that indicates an overflow.
+Overflown bytes are not written to the buffer.
+If method is not found, an error is automatically generated. 
+

docs/c-api/json-rpc.h/mg_rpc_parse_reply.md

@@ -0,0 +1,24 @@
+---
+title: "mg_rpc_parse_reply()"
+decl_name: "mg_rpc_parse_reply"
+symbol_kind: "func"
+signature: |
+  int mg_rpc_parse_reply(const char *buf, int len, struct json_token *toks,
+                         int max_toks, struct mg_rpc_reply *,
+                         struct mg_rpc_error *);
+---
+
+Parse JSON-RPC reply contained in `buf`, `len` into JSON tokens array
+`toks`, `max_toks`. If buffer contains valid reply, `reply` structure is
+populated. The result of RPC call is located in `reply.result`. On error,
+`error` structure is populated. Returns: the result of calling
+`parse_json(buf, len, toks, max_toks)`:
+
+On success, an offset inside `json_string` is returned
+where parsing has finished. On failure, a negative number is
+returned, one of:
+
+- `#define JSON_STRING_INVALID           -1`
+- `#define JSON_STRING_INCOMPLETE        -2`
+- `#define JSON_TOKEN_ARRAY_TOO_SMALL    -3` 
+

docs/c-api/json-rpc.h/struct_mg_rpc_error.md

@@ -0,0 +1,16 @@
+---
+title: "struct mg_rpc_error"
+decl_name: "struct mg_rpc_error"
+symbol_kind: "struct"
+signature: |
+  struct mg_rpc_error {
+    struct json_token *message;       /* Whole RPC message */
+    struct json_token *id;            /* Message ID */
+    struct json_token *error_code;    /* error.code */
+    struct json_token *error_message; /* error.message */
+    struct json_token *error_data;    /* error.data, can be NULL */
+  };
+---
+
+JSON-RPC error 
+

docs/c-api/json-rpc.h/struct_mg_rpc_reply.md

@@ -0,0 +1,14 @@
+---
+title: "struct mg_rpc_reply"
+decl_name: "struct mg_rpc_reply"
+symbol_kind: "struct"
+signature: |
+  struct mg_rpc_reply {
+    struct json_token *message; /* Whole RPC message */
+    struct json_token *id;      /* Message ID */
+    struct json_token *result;  /* Remote call result */
+  };
+---
+
+JSON-RPC response 
+

docs/c-api/json-rpc.h/struct_mg_rpc_request.md

@@ -0,0 +1,15 @@
+---
+title: "struct mg_rpc_request"
+decl_name: "struct mg_rpc_request"
+symbol_kind: "struct"
+signature: |
+  struct mg_rpc_request {
+    struct json_token *message; /* Whole RPC message */
+    struct json_token *id;      /* Message ID */
+    struct json_token *method;  /* Method name */
+    struct json_token *params;  /* Method params */
+  };
+---
+
+JSON-RPC request 
+

docs/c-api/mbuf.h/intro.md

@@ -0,0 +1,11 @@
+---
+title: "Memory Buffers"
+symbol_kind: "intro"
+decl_name: "mbuf.h"
+---
+
+Mbufs are mutable/growing memory buffers, like C++ strings.
+Mbuf can append data to the end of a buffer, or insert data into arbitrary
+position in the middle of a buffer. The buffer grows automatically when
+needed.
+

docs/c-api/mbuf.h/items.json

@@ -0,0 +1,40 @@
+{
+    "items": [
+        {
+            "type": "markdown",
+            "name": "intro.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_init.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_free.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_append.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_insert.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_remove.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_resize.md"
+        },
+        {
+            "type": "markdown",
+            "name": "mbuf_trim.md"
+        },
+        {
+            "type": "markdown",
+            "name": "struct_mbuf.md"
+        }
+    ]
+}

docs/c-api/mbuf.h/mbuf_append.md

@@ -0,0 +1,12 @@
+---
+title: "mbuf_append()"
+decl_name: "mbuf_append"
+symbol_kind: "func"
+signature: |
+  size_t mbuf_append(struct mbuf *, const void *data, size_t data_size);
+---
+
+Appends data to the Mbuf.
+
+Return the number of bytes appended, or 0 if out of memory. 
+

docs/c-api/mbuf.h/mbuf_free.md

@@ -0,0 +1,10 @@
+---
+title: "mbuf_free()"
+decl_name: "mbuf_free"
+symbol_kind: "func"
+signature: |
+  void mbuf_free(struct mbuf *);
+---
+
+Free the space allocated for the mbuffer and resets the mbuf structure. 
+

docs/c-api/mbuf.h/mbuf_init.md

@@ -0,0 +1,11 @@
+---
+title: "mbuf_init()"
+decl_name: "mbuf_init"
+symbol_kind: "func"
+signature: |
+  void mbuf_init(struct mbuf *, size_t initial_capacity);
+---
+
+Initialize an Mbuf.
+`initial_capacity` specifies the initial capacity of the mbuf. 
+

docs/c-api/mbuf.h/mbuf_insert.md

@@ -0,0 +1,14 @@
+---
+title: "mbuf_insert()"
+decl_name: "mbuf_insert"
+symbol_kind: "func"
+signature: |
+  size_t mbuf_insert(struct mbuf *, size_t, const void *, size_t);
+---
+
+Insert data at a specified offset in the Mbuf.
+
+Existing data will be shifted forwards and the buffer will
+be grown if necessary.
+Return the number of bytes inserted. 
+

docs/c-api/mbuf.h/mbuf_remove.md

@@ -0,0 +1,10 @@
+---
+title: "mbuf_remove()"
+decl_name: "mbuf_remove"
+symbol_kind: "func"
+signature: |
+  void mbuf_remove(struct mbuf *, size_t data_size);
+---
+
+Remove `data_size` bytes from the beginning of the buffer. 
+

docs/c-api/mbuf.h/mbuf_resize.md

@@ -0,0 +1,13 @@
+---
+title: "mbuf_resize()"
+decl_name: "mbuf_resize"
+symbol_kind: "func"
+signature: |
+  void mbuf_resize(struct mbuf *, size_t new_size);
+---
+
+Resize an Mbuf.
+
+If `new_size` is smaller than buffer's `len`, the
+resize is not performed. 
+

docs/c-api/mbuf.h/mbuf_trim.md

@@ -0,0 +1,10 @@
+---
+title: "mbuf_trim()"
+decl_name: "mbuf_trim"
+symbol_kind: "func"
+signature: |
+  void mbuf_trim(struct mbuf *);
+---
+
+Shrink an Mbuf by resizing its `size` to `len`. 
+

docs/c-api/mbuf.h/struct_mbuf.md

@@ -0,0 +1,14 @@
+---
+title: "struct mbuf"
+decl_name: "struct mbuf"
+symbol_kind: "struct"
+signature: |
+  struct mbuf {
+    char *buf;   /* Buffer pointer */
+    size_t len;  /* Data length. Data is located between offset 0 and len. */
+    size_t size; /* Buffer size allocated by realloc(1). Must be >= len */
+  };
+---
+
+Memory buffer descriptor 
+