diff options
Diffstat (limited to '')
| -rw-r--r-- | src/civetweb/docs/api/mg_read.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_read.md b/src/civetweb/docs/api/mg_read.md new file mode 100644 index 000000000..c7ec6c3df --- /dev/null +++ b/src/civetweb/docs/api/mg_read.md @@ -0,0 +1,26 @@ +# Civetweb API Reference + +### `mg_read( conn, buf, len );` + +### Parameters + +| 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 | + +### Return Value + +| Type | Description | +| :--- | :--- | +|`int`| The number of read bytes, or a status indication | + +### Description + +The function `mg_read()` receives data over an existing connection. The data is handled as binary and is stored in a buffer whose address has been provided as a parameter. The function returns the number of read bytes when successful, the value **0** when the connection has been closed by peer and a negative value when no more data could be read from the connection. + +### See Also + +* [`mg_printf();`](mg_printf.md) +* [`mg_write();`](mg_write.md) |