summaryrefslogtreecommitdiffstats
path: root/src/civetweb/docs/api/mg_lock_context.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/civetweb/docs/api/mg_lock_context.md')
-rw-r--r--src/civetweb/docs/api/mg_lock_context.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_lock_context.md b/src/civetweb/docs/api/mg_lock_context.md
new file mode 100644
index 00000000..8be6bac7
--- /dev/null
+++ b/src/civetweb/docs/api/mg_lock_context.md
@@ -0,0 +1,23 @@
+# Civetweb API Reference
+
+### `mg_lock_context( ctx );`
+
+### Parameters
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+|**`ctx`**|`struct mg_context *`|The context to put the lock on|
+
+### Return Value
+
+*none*
+
+### Description
+
+The function `mg_lock_context()` can be used to acquire a lock for exclusive access to resources which are shared between connection of threads. The lock is context wide. The lock must be released with a call to [`mg_unlock_context()`](mg_unlock_context.md).
+
+### See Also
+
+* [`mg_lock_connection();`](mg_lock_connection.md)
+* [`mg_unlock_connection();`](mg_unlock_connection.md)
+* [`mg_unlock_context();`](mg_unlock_context.md)