Mongoose 6.6

PUBLISHED_FROM=23d031720d8d6e170eab6bd615797f33e36a6701

README.md

@@ -1,16 +1,12 @@
-# <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 - Embedded Web Server / Embedded Networking Library
 
 ![](https://img.shields.io/badge/license-GPL_2-green.svg "License")
 
 Mongoose is ideal for embedded environments. It has been designed
-for connecting devices and bringing them online. Mongoose
-is on the market since 2004, used by vast number of open source and
+for connecting devices and bringing them online. 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.
+Mongoose makes embedded network programming fast, robust, and easy.
 
 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)
@@ -22,11 +18,10 @@ Alternatively,
 - [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)
+If you are looking for a complete solution with firmware and cloud components, check out [Mongoose IoT Platform](https://github.com/cesanta/mongoose-iot).
 
 # Support
-- [Support Forum - Ask your technical questions here] (http://forum.cesanta.com/index.php?p=/categories/smart-js)
+- [Support Forum - Ask your technical questions here] (http://forum.cesanta.com/index.php?p=/categories/mongoose)
 - [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)
 
@@ -41,7 +36,6 @@ If you are looking for a complete IoT platform with firmware and cloud compotent
    - plain TCP, plain UDP, SSL/TLS (over TCP, one-way or two-way)
    - HTTP client, HTTP server
    - WebSocket client, WebSocket server
-   - JSON-RPC client, JSON-RPC server
    - MQTT client, MQTT broker
    - CoAP client, CoAP server
    - DNS client, DNS server, async DNS resolver
@@ -75,6 +69,12 @@ the functionality:
 
 # 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.
+To submit contributions, sign
+[Cesanta CLA](https://docs.cesanta.com/contributors_la.shtml)
+and send GitHub pull request. You retain the copyright on your contributions.
+
+## Working with the Source Code
+
+See [tools](https://github.com/cesanta/mongoose/tree/master/tools) directory.
 
 [![Analytics](https://ga-beacon.appspot.com/UA-42732794-5/project-page)](https://github.com/cesanta/mongoose)

docs/build-options/intro.md

@@ -1,17 +0,0 @@
----
-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

@@ -1,9 +0,0 @@
-{
-  "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/c-api/coap.h/intro.md

@@ -1,7 +1,17 @@
 ---
-title: "CoAP"
+title: "CoAP API reference"
 symbol_kind: "intro"
 decl_name: "coap.h"
+items:
+  - { name: mg_set_protocol_coap.md }
+  - { name: mg_coap_add_option.md }
+  - { name: mg_coap_free_options.md }
+  - { name: mg_coap_send_message.md }
+  - { name: mg_coap_send_ack.md }
+  - { name: mg_coap_parse.md }
+  - { name: mg_coap_compose.md }
+  - { name: struct_mg_coap_option.md }
+  - { name: struct_mg_coap_message.md }
 ---
 
 CoAP message format:

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

@@ -1,44 +0,0 @@
-{
-    "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

@@ -8,6 +8,6 @@ signature: |
                                             size_t len);
 ---
 
-Add new option to mg_coap_message structure.
+Adds a new option to mg_coap_message structure.
 Returns pointer to the newly created option. 
 

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

@@ -6,6 +6,6 @@ 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. 
+Frees the memory allocated for options.
+If the cm paramater doesn't contain any option it does nothing. 
 

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

@@ -6,13 +6,13 @@ 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.
+Parses 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)
+NOTE: usually CoAP works 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
+The caller has 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,

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

@@ -6,7 +6,7 @@ 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.
+Composes CoAP acknowledgement from `mg_coap_message`
+and sends it into `nc` connection.
 Return value: see `mg_coap_send_message()` 
 

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

@@ -7,9 +7,9 @@ signature: |
                                 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:
+Composes a CoAP message from `mg_coap_message`
+and sends it into `nc` connection.
+Returns 0 on success. On error, it is a bitmask:
 
 - `#define MG_COAP_ERROR 0x10000`
 - `#define MG_COAP_FORMAT_ERROR (MG_COAP_ERROR | 0x20000)`

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

@@ -6,5 +6,5 @@ signature: |
   int mg_set_protocol_coap(struct mg_connection *nc);
 ---
 
-Set CoAP protocol handler - trigger CoAP specific events 
+Sets CoAP protocol handler - triggers CoAP specific events. 
 

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

@@ -1,8 +0,0 @@
----
-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

@@ -1,20 +0,0 @@
-{
-    "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.h/intro.md

@@ -1,7 +1,19 @@
 ---
-title: "DNS"
+title: "DNS API reference"
 symbol_kind: "intro"
 decl_name: "dns.h"
+items:
+  - { name: mg_dns_parse_record_data.md }
+  - { name: mg_send_dns_query.md }
+  - { name: mg_dns_insert_header.md }
+  - { name: mg_dns_copy_questions.md }
+  - { name: mg_dns_encode_record.md }
+  - { name: mg_dns_encode_name.md }
+  - { name: mg_parse_dns.md }
+  - { name: mg_dns_uncompress_name.md }
+  - { name: mg_set_protocol_dns.md }
+  - { name: struct_mg_dns_resource_record.md }
+  - { name: struct_mg_dns_message.md }
 ---
 
 

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

@@ -1,48 +0,0 @@
-{
-    "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

@@ -1,15 +0,0 @@
----
-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_copy_questions.md

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

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

@@ -0,0 +1,10 @@
+---
+title: "mg_dns_encode_name()"
+decl_name: "mg_dns_encode_name"
+symbol_kind: "func"
+signature: |
+  int mg_dns_encode_name(struct mbuf *io, const char *name, size_t len);
+---
+
+Encodes a DNS name. 
+

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

@@ -8,18 +8,18 @@ signature: |
                            size_t rlen);
 ---
 
-Encode and append a DNS resource record to an IO buffer.
+Encodes and appends 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
+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.
+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.
+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. 
+Returns the number of bytes appened or -1 in case of error. 
 

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

@@ -7,7 +7,7 @@ signature: |
                            struct mg_dns_message *msg);
 ---
 
-Insert a DNS header to an IO buffer.
+Inserts a DNS header to an IO buffer.
 
-Return number of bytes inserted. 
+Returns the number of bytes inserted. 
 

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

@@ -8,7 +8,7 @@ signature: |
                                size_t data_len);
 ---
 
-Parse the record data from a DNS resource record.
+Parses the record data from a DNS resource record.
 
  - A:     struct in_addr *ina
  - AAAA:  struct in6_addr *ina

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

@@ -7,15 +7,15 @@ signature: |
                                 char *dst, int dst_len);
 ---
 
-Uncompress a DNS compressed name.
+Uncompresses a DNS compressed name.
 
-The containing dns message is required because the compressed encoding
+The containing DNS message is required because of 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 the 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. 
+Returns the uncompressed name length. 
 

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

@@ -7,5 +7,5 @@ signature: |
                          int query_type);
 ---
 
-Send a DNS query to the remote end. 
+Sends a DNS query to the remote end. 
 

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

@@ -6,11 +6,11 @@ signature: |
   void mg_set_protocol_dns(struct mg_connection *nc);
 ---
 
-Attach built-in DNS event handler to the given listening connection.
+Attaches a 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
+The DNS event handler parses the incoming UDP packets, treating them as DNS
+requests. If an incoming packet gets successfully parsed by the DNS event
+handler, a user event handler will receive an `MG_DNS_REQUEST` event, with
 `ev_data` pointing to the parsed `struct mg_dns_message`.
 
 See

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

@@ -0,0 +1,12 @@
+---
+title: "DNS server API reference"
+symbol_kind: "intro"
+decl_name: "dns_server.h"
+items:
+  - { name: mg_dns_create_reply.md }
+  - { name: mg_dns_reply_record.md }
+  - { name: mg_dns_send_reply.md }
+---
+
+Disabled by default; enable with `-DMG_ENABLE_DNS_SERVER`.
+

docs/c-api/dns_server.h/mg_dns_create_reply.md

@@ -7,18 +7,18 @@ signature: |
                                           struct mg_dns_message *msg);
 ---
 
-Create a DNS reply.
+Creates 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
+"reply + recursion allowed" will be added to the message flags and the
 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,
+In order to send a reply use `mg_dns_send_reply`.
+It's possible to use a connection's send buffer as reply buffer,
 and it will work for both UDP and TCP connections.
 
 Example:

docs/c-api/dns_server.h/mg_dns_reply_record.md

@@ -9,10 +9,10 @@ signature: |
                           size_t rdata_len);
 ---
 
-Append a DNS reply record to the IO buffer and to the DNS message.
+Appends 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.
+The message's num_answers field will be incremented. It's the caller's duty
+to ensure num_answers is properly initialised.
 
 Returns -1 on error. 
 

docs/c-api/dns_server.h/mg_dns_send_reply.md

@@ -6,12 +6,12 @@ signature: |
   void mg_dns_send_reply(struct mg_connection *nc, struct mg_dns_reply *r);
 ---
 
-Send a DNS reply through a connection.
+Sends 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
+the DNS header reflects the size and flags of the message, 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

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

@@ -1,7 +1,21 @@
 ---
-title: "HTTP + Websocket"
+title: "Common API reference"
 symbol_kind: "intro"
 decl_name: "http.h"
+items:
+  - { name: mg_set_protocol_http_websocket.md }
+  - { name: mg_send_websocket_handshake.md }
+  - { name: mg_send_websocket_handshake2.md }
+  - { name: mg_connect_ws.md }
+  - { name: mg_connect_ws_opt.md }
+  - { name: mg_send_websocket_frame.md }
+  - { name: mg_send_websocket_framev.md }
+  - { name: mg_printf_websocket_frame.md }
+  - { name: mg_url_decode.md }
+  - { name: struct_http_message.md }
+  - { name: struct_websocket_message.md }
+  - { name: struct_mg_http_multipart_part.md }
+  - { name: struct_mg_ssi_call_ctx.md }
 ---
 
 

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

@@ -1,128 +0,0 @@
-{
-    "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_ws.md

@@ -13,7 +13,7 @@ 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.
+Host headers. `extra_headers` is an extra HTTP header to send, e.g.
 `"User-Agent: my-app\r\n"`.
 If `protocol` is not NULL, then a `Sec-WebSocket-Protocol` header is sent.
 

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

@@ -12,6 +12,6 @@ signature: |
 
 Helper function that creates an outbound WebSocket connection
 
-Mostly identical to mg_connect_ws, but allows to provide extra parameters
-(for example, SSL parameters 
+Mostly identical to `mg_connect_ws`, but allows to provide extra parameters
+(for example, SSL parameters) 
 

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

@@ -1,16 +0,0 @@
----
-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_parse_http.md

@@ -1,15 +0,0 @@
----
-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_printf_websocket_frame.md

@@ -7,8 +7,8 @@ signature: |
                                  const char *fmt, ...);
 ---
 
-Send websocket frame to the remote end.
+Sends WebSocket frame to the remote end.
 
-Like `mg_send_websocket_frame()`, but allows to create formatted message
+Like `mg_send_websocket_frame()`, but allows to create formatted messages
 with `printf()`-like semantics. 
 

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

@@ -1,25 +0,0 @@
----
-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_websocket_frame.md

@@ -7,9 +7,9 @@ signature: |
                                const void *data, size_t data_len);
 ---
 
-Send websocket frame to the remote end.
+Send WebSocket frame to the remote end.
 
-`op_and_flags` specifies frame's type, one of:
+`op_and_flags` specifies the frame's type. It's one of:
 
 - WEBSOCKET_OP_CONTINUE
 - WEBSOCKET_OP_TEXT

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

@@ -7,7 +7,7 @@ signature: |
                                 const struct mg_str *strings, int num_strings);
 ---
 
-Send multiple websocket frames.
+Sends multiple websocket frames.
 
 Like `mg_send_websocket_frame()`, but composes a frame from multiple buffers. 
 

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

@@ -6,40 +6,41 @@ 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:
+Attaches a built-in HTTP event handler to the given connection.
+The 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
+  This event is sent before body is parsed. After this, the 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
+- MG_EV_HTTP_REPLY: The HTTP reply has arrived. The parsed HTTP reply is
+  passed as `struct http_message` through the handler's `void *ev_data`
+  pointer.
+- MG_EV_HTTP_CHUNK: The HTTP chunked-encoding chunk has arrived.
+  The 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
+  It will grow with every new chunk that arrives, and it can
+  potentially 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
+- MG_EV_WEBSOCKET_HANDSHAKE_REQUEST: server has received the WebSocket
+  handshake request. `ev_data` contains parsed HTTP request.
+- MG_EV_WEBSOCKET_HANDSHAKE_DONE: server has completed the 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
+- MG_EV_HTTP_PART_DATA: new portion of data from the 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

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

@@ -7,12 +7,12 @@ signature: |
                     int is_form_url_encoded);
 ---
 
-Decode URL-encoded string.
+Decodes a 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`. 
+guarantees to NUL-terminate the destination. If destination is too small,
+then the source string is partially decoded and `-1` is returned. Otherwise,
+a length of the decoded string is returned, not counting final NUL. 
 

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

@@ -0,0 +1,14 @@
+---
+title: "struct mg_ssi_call_ctx"
+decl_name: "struct mg_ssi_call_ctx"
+symbol_kind: "struct"
+signature: |
+  struct mg_ssi_call_ctx {
+    struct http_message *req; /* The request being processed. */
+    struct mg_str file;       /* Filesystem path of the file being processed. */
+    struct mg_str arg; /* The argument passed to the tag: <!-- call arg -->. */
+  };
+---
+
+SSI call context 
+

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

@@ -0,0 +1,12 @@
+---
+title: "Client API reference"
+symbol_kind: "intro"
+decl_name: "http_client.h"
+items:
+  - { name: mg_connect_http.md }
+  - { name: mg_connect_http_opt.md }
+  - { name: mg_http_create_digest_auth_header.md }
+---
+
+
+

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

@@ -10,16 +10,16 @@ signature: |
                                         const char *post_data);
 ---
 
-Helper function that creates outbound HTTP connection.
+Helper function that creates an 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.
+`url` is the URL to fetch. It must be properly URL-encoded, e.g. have
+no spaces, etc. By default, `mg_connect_http()` sends the Connection and
+Host headers. `extra_headers` is an extra HTTP header 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).
+If `post_data` is NULL, then a GET request is created. Otherwise, a 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:
 

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

@@ -11,8 +11,9 @@ signature: |
                                             const char *post_data);
 ---
 
-Helper function that creates outbound HTTP connection.
+Helper function that creates an outbound HTTP connection.
 
-Mostly identical to mg_connect_http, but allows to provide extra parameters
-(for example, SSL parameters 
+Mostly identical to mg_connect_http, but allows you to provide extra
+*parameters
+(for example, SSL parameters) 
 

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

@@ -9,5 +9,5 @@ signature: |
                                         const char *passwd);
 ---
 
-Create Digest authentication header for client request. 
+Creates digest authentication header for a client request. 
 

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

@@ -0,0 +1,27 @@
+---
+title: "Server API reference"
+symbol_kind: "intro"
+decl_name: "http_server.h"
+items:
+  - { name: mg_parse_http.md }
+  - { name: mg_get_http_header.md }
+  - { name: mg_http_parse_header.md }
+  - { name: mg_parse_multipart.md }
+  - { name: mg_get_http_var.md }
+  - { name: mg_serve_http.md }
+  - { name: mg_http_serve_file.md }
+  - { name: mg_register_http_endpoint.md }
+  - { name: mg_file_upload_handler.md }
+  - { name: mg_http_check_digest_auth.md }
+  - { name: mg_send_http_chunk.md }
+  - { name: mg_printf_http_chunk.md }
+  - { name: mg_send_response_line.md }
+  - { name: mg_http_send_redirect.md }
+  - { name: mg_send_head.md }
+  - { name: mg_printf_html_escape.md }
+  - { name: mg_fu_fname_fn.md }
+  - { name: struct_mg_serve_http_opts.md }
+---
+
+
+

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

@@ -12,9 +12,10 @@ 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.
+and will expect the name of the local file to open. A 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:

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

@@ -6,7 +6,7 @@ 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`.
+Searches and returns the 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_server.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);
+---
+
+Fetches a HTTP form variable.
+
+Fetches a variable `name` from a `buf` into a buffer specified by `dst`,
+`dst_len`. The destination is always zero-terminated. Returns the 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_server.h/mg_http_check_digest_auth.md

@@ -0,0 +1,12 @@
+---
+title: "mg_http_check_digest_auth()"
+decl_name: "mg_http_check_digest_auth"
+symbol_kind: "func"
+signature: |
+  int mg_http_check_digest_auth(struct http_message *hm, const char *auth_domain,
+                                FILE *fp);
+---
+
+Authenticates a HTTP request against an opened password file.
+Returns 1 if authenticated, 0 otherwise. 
+

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

@@ -7,17 +7,17 @@ signature: |
                            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
+Parses the HTTP header `hdr`. Finds variable `var_name` and stores its value
+in the buffer `buf`, `buf_size`. Returns 0 if variable not found, non-zero
 otherwise.
 
-This function is supposed to parse
-cookies, authentication headers, etcetera. Example (error handling omitted):
+This function is supposed to parse cookies, authentication headers, etc.
+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,
+Returns the length of the variable's value. If buffer is not large enough,
 or variable not found, 0 is returned. 
 

docs/c-api/http_server.h/mg_http_send_redirect.md

@@ -0,0 +1,20 @@
+---
+title: "mg_http_send_redirect()"
+decl_name: "mg_http_send_redirect"
+symbol_kind: "func"
+signature: |
+  void mg_http_send_redirect(struct mg_connection *nc, int status_code,
+                             const struct mg_str location,
+                             const struct mg_str extra_headers);
+---
+
+Sends a redirect response.
+`status_code` should be either 301 or 302 and `location` point to the
+new location.
+If `extra_headers` is not empty, then `extra_headers` are also sent
+after the reponse line. `extra_headers` must NOT end end with new line.
+
+Example:
+
+     mg_http_send_redirect(nc, 302, mg_mk_str("/login"), mg_mk_str(NULL)); 
+

docs/c-api/http_server.h/mg_http_serve_file.md

@@ -0,0 +1,28 @@
+---
+title: "mg_http_serve_file()"
+decl_name: "mg_http_serve_file"
+symbol_kind: "func"
+signature: |
+  void mg_http_serve_file(struct mg_connection *nc, struct http_message *hm,
+                          const char *path, const struct mg_str mime_type,
+                          const struct mg_str extra_headers);
+---
+
+Serves a specific file with a given MIME type and optional extra headers.
+
+Example code snippet:
+
+```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;
+      mg_http_serve_file(nc, hm, "file.txt",
+                         mg_mk_str("text/plain"), mg_mk_str(""));
+      break;
+    }
+    ...
+  }
+}
+``` 
+

docs/c-api/http_server.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);
+---
+
+Parses a HTTP message.
+
+`is_req` should be set to 1 if parsing a request, 0 if reply.
+
+Returns the number of bytes parsed. If HTTP message is
+incomplete `0` is returned. On parse error, a negative number is returned. 
+

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

@@ -9,13 +9,13 @@ signature: |
                             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.
+Parses the buffer `buf`, `buf_len` that contains multipart form data chunks.
+Stores the 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
+Return: number of bytes to skip to the next chunk or 0 if there are
         no more chunks.
 
 Usage example:

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

@@ -6,5 +6,5 @@ signature: |
   void mg_printf_html_escape(struct mg_connection *nc, const char *fmt, ...);
 ---
 
-Send printf-formatted HTTP chunk, escaping HTML tags. 
+Sends a printf-formatted HTTP chunk, escaping HTML tags. 
 

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

@@ -6,6 +6,6 @@ signature: |
   void mg_printf_http_chunk(struct mg_connection *nc, const char *fmt, ...);
 ---
 
-Send printf-formatted HTTP chunk.
+Sends a printf-formatted HTTP chunk.
 Functionality is similar to `mg_send_http_chunk()`. 
 

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

@@ -7,8 +7,8 @@ signature: |
                                  mg_event_handler_t handler);
 ---
 
-Register callback for specified http endpoint
-Note: if callback is registered it is called instead of
+Registers a callback for a specified http endpoint
+Note: if callback is registered it is called instead of the
 callback provided in mg_bind
 
 Example code snippet:

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

@@ -7,15 +7,16 @@ signature: |
                     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".
+Sends the response line and headers.
+This function sends the 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`
+Extra headers could be set through `extra_headers`. Note `extra_headers`
 must NOT be terminated by a new line. 
 

docs/c-api/http_server.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);
+---
+
+Sends buffer `buf` of size `len` to the client using chunked HTTP encoding.
+This function sends the buffer size as hex number + newline first, then
+the buffer itself, then the newline. For example,
+`mg_send_http_chunk(nc, "foo", 3)` whill append the `3\r\nfoo\r\n` string
+to the `nc->send_mbuf` output IO buffer.
+
+NOTE: The HTTP header "Transfer-Encoding: chunked" should be sent prior to
+using this function.
+
+NOTE: do not forget to send an 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_server.h/mg_send_response_line.md

@@ -3,11 +3,11 @@ 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,
+  void mg_send_response_line(struct mg_connection *nc, int status_code,
                              const char *extra_headers);
 ---
 
-Send response status line.
+Sends the 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:

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

@@ -7,7 +7,7 @@ signature: |
                      struct mg_serve_http_opts opts);
 ---
 
-Serve given HTTP request according to the `options`.
+Serves given HTTP request according to the `options`.
 
 Example code snippet:
 

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

@@ -37,7 +37,64 @@ signature: |
     /* 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. */
+    /*
+     * SSI files pattern. If not set, "**.shtml$|**.shtm$" is used.
+     *
+     * All files that match ssi_pattern are treated as SSI.
+     *
+     * Server Side Includes (SSI) is a simple interpreted server-side scripting
+     * language which is most commonly used to include the contents of a file
+     * into a web page. It can be useful when it is desirable to include a common
+     * piece of code throughout a website, for example, headers and footers.
+     *
+     * In order for a webpage to recognize an SSI-enabled HTML file, the
+     * filename should end with a special extension, by default the extension
+     * should be either .shtml or .shtm
+     *
+     * Unknown SSI directives are silently ignored by Mongoose. Currently,
+     * the following SSI directives are supported:
+     *    <!--#include FILE_TO_INCLUDE -->
+     *    <!--#exec "COMMAND_TO_EXECUTE" -->
+     *    <!--#call COMMAND -->
+     *
+     * Note that <!--#include ...> directive supports three path
+     *specifications:
+     *
+     * <!--#include virtual="path" -->  Path is relative to web server root
+     * <!--#include abspath="path" -->  Path is absolute or relative to the
+     *                                  web server working dir
+     * <!--#include file="path" -->,    Path is relative to current document
+     * <!--#include "path" -->
+     *
+     * The include directive may be used to include the contents of a file or
+     * the result of running a CGI script.
+     *
+     * The exec directive is used to execute
+     * a command on a server, and show command's output. Example:
+     *
+     * <!--#exec "ls -l" -->
+     *
+     * The call directive is a way to invoke a C handler from the HTML page.
+     * On each occurence of <!--#call COMMAND OPTIONAL_PARAMS> directive,
+     * Mongoose calls a registered event handler with MG_EV_SSI_CALL event,
+     * and event parameter will point to the COMMAND OPTIONAL_PARAMS string.
+     * An event handler can output any text, for example by calling
+     * `mg_printf()`. This is a flexible way of generating a web page on
+     * server side by calling a C event handler. Example:
+     *
+     * <!--#call foo --> ... <!--#call bar -->
+     *
+     * In the event handler:
+     *    case MG_EV_SSI_CALL: {
+     *      const char *param = (const char *) ev_data;
+     *      if (strcmp(param, "foo") == 0) {
+     *        mg_printf(c, "hello from foo");
+     *      } else if (strcmp(param, "bar") == 0) {
+     *        mg_printf(c, "hello from bar");
+     *      }
+     *      break;
+     *    }
+     */
     const char *ssi_pattern;
   
     /* IP ACL. By default, NULL, meaning all IPs are allowed to connect */

docs/c-api/intro.md

@@ -0,0 +1,16 @@
+---
+items:
+  - { name: mbuf.h }
+  - { name: net.h }
+  - { name: http.h }
+  - { name: http_server.h }
+  - { name: http_client.h }
+  - { name: dns.h }
+  - { name: dns_server.h }
+  - { name: resolv.h }
+  - { name: mqtt.h }
+  - { name: mqtt_server.h }
+  - { name: coap.h }
+  - { name: util.h }
+  - { name: uri.h }
+---

docs/c-api/items.json

@@ -1,44 +0,0 @@
-{
-    "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

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

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

@@ -1,44 +0,0 @@
-{
-    "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

@@ -1,16 +0,0 @@
----
-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

@@ -1,16 +0,0 @@
----
-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

@@ -1,16 +0,0 @@
----
-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

@@ -1,22 +0,0 @@
----
-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

@@ -1,20 +0,0 @@
----
-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

@@ -1,24 +0,0 @@
----
-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

@@ -1,16 +0,0 @@
----
-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

@@ -1,14 +0,0 @@
----
-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

@@ -1,15 +0,0 @@
----
-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

@@ -2,10 +2,19 @@
 title: "Memory Buffers"
 symbol_kind: "intro"
 decl_name: "mbuf.h"
+items:
+  - { name: mbuf_init.md }
+  - { name: mbuf_free.md }
+  - { name: mbuf_append.md }
+  - { name: mbuf_insert.md }
+  - { name: mbuf_remove.md }
+  - { name: mbuf_resize.md }
+  - { name: mbuf_trim.md }
+  - { name: struct_mbuf.md }
 ---
 
 Mbufs are mutable/growing memory buffers, like C++ strings.
-Mbuf can append data to the end of a buffer, or insert data into arbitrary
+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

@@ -1,40 +0,0 @@
-{
-    "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

@@ -8,5 +8,5 @@ signature: |
 
 Appends data to the Mbuf.
 
-Return the number of bytes appended, or 0 if out of memory. 
+Returns the number of bytes appended or 0 if out of memory. 
 

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

@@ -6,5 +6,5 @@ signature: |
   void mbuf_free(struct mbuf *);
 ---
 
-Free the space allocated for the mbuffer and resets the mbuf structure. 
+Frees the space allocated for the mbuffer and resets the mbuf structure. 
 

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

@@ -6,6 +6,6 @@ signature: |
   void mbuf_init(struct mbuf *, size_t initial_capacity);
 ---
 
-Initialize an Mbuf.
+Initialises an Mbuf.
 `initial_capacity` specifies the initial capacity of the mbuf. 
 

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

@@ -6,9 +6,9 @@ signature: |
   size_t mbuf_insert(struct mbuf *, size_t, const void *, size_t);
 ---
 
-Insert data at a specified offset in the Mbuf.
+Inserts 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. 
+Returns the number of bytes inserted. 
 

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

@@ -6,5 +6,5 @@ signature: |
   void mbuf_remove(struct mbuf *, size_t data_size);
 ---
 
-Remove `data_size` bytes from the beginning of the buffer. 
+Removes `data_size` bytes from the beginning of the buffer. 
 

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

@@ -6,7 +6,7 @@ signature: |
   void mbuf_resize(struct mbuf *, size_t new_size);
 ---
 
-Resize an Mbuf.
+Resizes an Mbuf.
 
 If `new_size` is smaller than buffer's `len`, the
 resize is not performed. 

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

@@ -6,5 +6,5 @@ signature: |
   void mbuf_trim(struct mbuf *);
 ---
 
-Shrink an Mbuf by resizing its `size` to `len`. 
+Shrinks an Mbuf by resizing its `size` to `len`. 
 

docs/c-api/mqtt-broker.h/intro.md

@@ -1,8 +0,0 @@
----
-title: "MQTT Broker"
-symbol_kind: "intro"
-decl_name: "mqtt-broker.h"
----
-
-
-

docs/c-api/mqtt-broker.h/items.json

@@ -1,28 +0,0 @@
-{
-    "items": [
-        {
-            "type": "markdown",
-            "name": "intro.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_broker_init.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_broker.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_next.md"
-        },
-        {
-            "type": "markdown",
-            "name": "struct_mg_mqtt_session.md"
-        },
-        {
-            "type": "markdown",
-            "name": "struct_mg_mqtt_broker.md"
-        }
-    ]
-}

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

@@ -1,7 +1,26 @@
 ---
-title: "MQTT"
+title: "MQTT API reference"
 symbol_kind: "intro"
 decl_name: "mqtt.h"
+items:
+  - { name: mg_set_protocol_mqtt.md }
+  - { name: mg_send_mqtt_handshake.md }
+  - { name: mg_send_mqtt_handshake_opt.md }
+  - { name: mg_mqtt_publish.md }
+  - { name: mg_mqtt_subscribe.md }
+  - { name: mg_mqtt_unsubscribe.md }
+  - { name: mg_mqtt_disconnect.md }
+  - { name: mg_mqtt_connack.md }
+  - { name: mg_mqtt_puback.md }
+  - { name: mg_mqtt_pubrec.md }
+  - { name: mg_mqtt_pubrel.md }
+  - { name: mg_mqtt_pubcomp.md }
+  - { name: mg_mqtt_suback.md }
+  - { name: mg_mqtt_unsuback.md }
+  - { name: mg_mqtt_ping.md }
+  - { name: mg_mqtt_pong.md }
+  - { name: mg_mqtt_next_subscribe_topic.md }
+  - { name: struct_mg_mqtt_topic_expression.md }
 ---
 
 

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

@@ -1,80 +0,0 @@
-{
-    "items": [
-        {
-            "type": "markdown",
-            "name": "intro.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_set_protocol_mqtt.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_send_mqtt_handshake.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_send_mqtt_handshake_opt.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_publish.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_subscribe.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_unsubscribe.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_disconnect.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_connack.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_puback.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_pubrec.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_pubrel.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_pubcomp.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_suback.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_unsuback.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_ping.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_pong.md"
-        },
-        {
-            "type": "markdown",
-            "name": "mg_mqtt_next_subscribe_topic.md"
-        },
-        {
-            "type": "markdown",
-            "name": "struct_mg_mqtt_topic_expression.md"
-        }
-    ]
-}

docs/c-api/mqtt.h/mg_mqtt_connack.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_connack(struct mg_connection *nc, uint8_t return_code);
 ---
 
-Send a CONNACK command with a given `return_code`. 
+Sends a CONNACK command with a given `return_code`. 
 

docs/c-api/mqtt.h/mg_mqtt_disconnect.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_disconnect(struct mg_connection *nc);
 ---
 
-Send a DISCONNECT command. 
+Sends a DISCONNECT command. 
 

docs/c-api/mqtt.h/mg_mqtt_next_subscribe_topic.md

@@ -7,9 +7,9 @@ signature: |
                                    struct mg_str *topic, uint8_t *qos, int pos);
 ---
 
-Extract the next topic expression from a SUBSCRIBE command payload.
+Extracts the next topic expression from a SUBSCRIBE command payload.
 
-Topic expression name will point to a string in the payload buffer.
-Return the pos of the next topic expression or -1 when the list
+The topic expression name will point to a string in the payload buffer.
+Returns the pos of the next topic expression or -1 when the list
 of topics is exhausted. 
 

docs/c-api/mqtt.h/mg_mqtt_ping.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_ping(struct mg_connection *nc);
 ---
 
-Send a PINGREQ command. 
+Sends a PINGREQ command. 
 

docs/c-api/mqtt.h/mg_mqtt_pong.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_pong(struct mg_connection *nc);
 ---
 
-Send a PINGRESP command. 
+Sends a PINGRESP command. 
 

docs/c-api/mqtt.h/mg_mqtt_puback.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_puback(struct mg_connection *nc, uint16_t message_id);
 ---
 
-Send a PUBACK command with a given `message_id`. 
+Sends a PUBACK command with a given `message_id`. 
 

docs/c-api/mqtt.h/mg_mqtt_pubcomp.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_pubcomp(struct mg_connection *nc, uint16_t message_id);
 ---
 
-Send a PUBCOMP command with a given `message_id`. 
+Sends a PUBCOMP command with a given `message_id`. 
 

docs/c-api/mqtt.h/mg_mqtt_publish.md

@@ -8,5 +8,5 @@ signature: |
                        size_t len);
 ---
 
-Publish a message to a given topic. 
+Publishes a message to a given topic. 
 

docs/c-api/mqtt.h/mg_mqtt_pubrec.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_pubrec(struct mg_connection *nc, uint16_t message_id);
 ---
 
-Send a PUBREC command with a given `message_id`. 
+Sends a PUBREC command with a given `message_id`. 
 

docs/c-api/mqtt.h/mg_mqtt_pubrel.md

@@ -6,5 +6,5 @@ signature: |
   void mg_mqtt_pubrel(struct mg_connection *nc, uint16_t message_id);
 ---
 
-Send a PUBREL command with a given `message_id`. 
+Sends a PUBREL command with a given `message_id`.