diff options
Diffstat (limited to 'src/civetweb/docs/api/mg_stop.md')
| -rw-r--r-- | src/civetweb/docs/api/mg_stop.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_stop.md b/src/civetweb/docs/api/mg_stop.md new file mode 100644 index 00000000..ea0d2466 --- /dev/null +++ b/src/civetweb/docs/api/mg_stop.md @@ -0,0 +1,22 @@ +# Civetweb API Reference + +### `mg_stop( ctx );` + +#### Parameters + +| Parameter | Type | Description | +| :--- | :--- | :--- | +|**`ctx`**|**`struct mg_context *`**| A pointer to the current webserver context | + +### Return Value + +*none* + +### Description + +The function `mg_stop()` is used to stop and cleanup a running webserver. A pointer to the context of the running webserver is provided as a parameter. The execution of this function may take some time because it waits until all threads have stopped and returns all memory to the heap. After the function returns, the location the context pointer points to is invalid. The function does not return a return value and it is therefore not possible to know if stopping the webserver succeeded or not. + +### See Also + +* [`mg_start();`](mg_start.md) +* [`mg_start_thread();`](mg_start_thread.md) |