summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getcurrentthread.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_getcurrentthread.rst')
-rw-r--r--docs/nspr/reference/pr_getcurrentthread.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_getcurrentthread.rst b/docs/nspr/reference/pr_getcurrentthread.rst
new file mode 100644
index 0000000000..b198ce1a6a
--- /dev/null
+++ b/docs/nspr/reference/pr_getcurrentthread.rst
@@ -0,0 +1,32 @@
+PR_GetCurrentThread
+===================
+
+Returns the current thread object for the currently running code.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prthread.h>
+
+ PRThread* PR_GetCurrentThread(void);
+
+
+Returns
+~~~~~~~
+
+Always returns a valid reference to the calling thread--a self-identity.
+
+
+Description
+~~~~~~~~~~~
+
+The currently running thread may discover its own identity by calling
+:ref:`PR_GetCurrentThread`.
+
+.. note::
+
+ **Note**: This is the only safe way to establish the identity of a
+ thread. Creation and enumeration are both subject to race conditions.