summaryrefslogtreecommitdiff
path: root/doc/reference/mutex.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/mutex.adoc')
-rw-r--r--doc/reference/mutex.adoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/reference/mutex.adoc b/doc/reference/mutex.adoc
new file mode 100644
index 0000000..d0493d6
--- /dev/null
+++ b/doc/reference/mutex.adoc
@@ -0,0 +1,16 @@
+== `sqlite/mutex.hpp`
+
+The mutex header provides to std::mutex compatible classes using the sqlite mutex implementation.
+
+This will allow C++ code to use mutex code matching the configuration of sqlite.
+This may include the mutex being a noop.
+
+[source,cpp,subs=+quotes]
+----
+// similar to std::mutex
+struct mutex;
+// similar to std::recursive_mutexx
+struct recursive_mutex;
+----
+
+