lib/libhttp
1
0
Fork 0
mirror of https://github.com/lammertb/libhttp.git synced 2025-08-10 14:23:00 +03:00
Code Activity

Bold typeface for parameters and fields

Browse Source
This commit is contained in:
Lammert Bies
2016-09-26 18:47:23 +02:00
parent b7f1eb0e82
commit 96ca181ab0
1 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/APIReference.md
View File

@@ -53,22 +53,22 @@ The structure `mg_header` is used as a sub-structure in the `mg_request_info` st
| Field | Type | Description |
| :--- | :--- | :--- |
| `request_method` | `const char *` | The request method used by the client for the connection this can be **GET**, **POST** or one of the other common HTTP request methods |
| `request_uri` | `const char *` | The absolute or URL-encoded URI as it was sent in the request |
| `local_uri` | `const char *` | The relative URL-encoded URI as it references the local resource. If the request URI does not reference a resource on the local server, this field is NULL |
| `uri` | `const char *` | *Deprecated. Use* `local_uri` *instead* |
| `http_version` | `const char *` | The HTTP version as mentioned in the client request. This can be "1.0", "1.1", etc. |
| `remote_user` | `const char *` | The name of the authenticated remote user, or NULL if no authentication was used |
| `remote addr` | `char[48]` | The IP address of the remote client as a string. This can either represent an IPv4 or an IPv6 address. |
| `remote_ip` | `long` | *Deprecated. Use* `remote_addr` *instead* |
| `content_length` | `long long` | The content length of the request body. This value can be -1 if no content length was provided. |
| `remote_port` | `int` | The port number at the client's side |
| `is_ssl` | `int` | 1 if the connection is over SSL, and 0 if it is a plain connection |
| `user_data` | `void *` | A pointer to the `user_data` information which was provided as a parameter to `mg_start()`. |
| `conn_data` | `void *` | A pointer to connection specific user data |
| `num_headers` | `int` | The number of HTTP request headers sent by the client |
| `http_headers` | `struct mg_header[64]` | Array of structures with the HTTP request headers sent by the client |
| `client_cert` | `struct client_cert *` | Pointer to the client certificate information, when available |
|**`request_method**|`const char *`| The request method used by the client for the connection this can be **GET**, **POST** or one of the other common HTTP request methods |
|**`request_uri`**|`const char *`| The absolute or URL-encoded URI as it was sent in the request |
|**`local_uri`**|`const char *`| The relative URL-encoded URI as it references the local resource. If the request URI does not reference a resource on the local server, this field is NULL |
|**`uri`**|`const char *`| *Deprecated. Use* `local_uri` *instead* |
|**`http_version`**|`const char *`| The HTTP version as mentioned in the client request. This can be "1.0", "1.1", etc. |
|**`remote_user`**|`const char *`| The name of the authenticated remote user, or NULL if no authentication was used |
|**`remote addr`**|`char[48]`| The IP address of the remote client as a string. This can either represent an IPv4 or an IPv6 address. |
|**`remote_ip`**|`long`| *Deprecated. Use* `remote_addr` *instead* |
|**`content_length`**|`long long`| The content length of the request body. This value can be -1 if no content length was provided. |
|**`remote_port`**|`int`| The port number at the client's side |
|**`is_ssl`**|`int`| 1 if the connection is over SSL, and 0 if it is a plain connection |
|**`user_data`**|`void *`| A pointer to the `user_data` information which was provided as a parameter to `mg_start()`. |
|**`conn_data`**|`void *`| A pointer to connection specific user data |
|**`num_headers`**|`int`| The number of HTTP request headers sent by the client |
|**`http_headers`**|`struct mg_header[64]`| Array of structures with the HTTP request headers sent by the client |
|**`client_cert`**|`struct client_cert *`| Pointer to the client certificate information, when available |
#### Description
@@ -82,7 +82,7 @@ The `mg_request_info` structure contains the client information of an existing c
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `feature` | `unsigned` | A value indicating the feature to be checked |
|**`feature`**|`unsigned`| A value indicating the feature to be checked |
#### Returns
@@ -154,8 +154,8 @@ When starting the CivetWeb webserver, options are provided to set the wanted beh
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `conn` | `struct mg_connection *` | A pointer referencing the connection |
| `response_code` | `int` | Response code for which the text is queried |
|**`conn`**|`struct mg_connection *`| A pointer referencing the connection |
|**`response_code`**|`int`| Response code for which the text is queried |
#### Returns
@@ -174,9 +174,9 @@ The function `mg_get_response_code_text()` returns a pointer to a human readable
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `conn` | `struct mg_connection *` | A pointer referencing the connection |
| `buf` | `void *` | A pointer to the location where the received data can be stored |
| `len` | `size_t` | The maximum number of bytes to be stored in the buffer |
|**`conn`**|`struct mg_connection *`| A pointer referencing the connection |
|**`buf`**|`void *`| A pointer to the location where the received data can be stored |
|**`len`**|`size_t`| The maximum number of bytes to be stored in the buffer |
#### Returns
@@ -194,9 +194,9 @@ The function `mg_read()` receives data over an existing connection. The data is
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `callbacks` | `const struct mg_callbacks *` | A structure with optional callback functions to process requests from the web server |
| `user_data` |`void *` | A pointer to optional user data |
| `options` | `char **` | A list of options used to initialize the web server |
|**`callbacks`**|`const struct mg_callbacks *`| A structure with optional callback functions to process requests from the web server |
|**`user_data`**|`void *`| A pointer to optional user data |
|**`options`**|`char **`| A list of options used to initialize the web server |
#### Returns