aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/threading.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/src/threading.rst b/docs/src/threading.rst
index 72f8bae0..f40cf0a3 100644
--- a/docs/src/threading.rst
+++ b/docs/src/threading.rst
@@ -140,6 +140,23 @@ Threads
.. c:function:: int uv_thread_join(uv_thread_t *tid)
.. c:function:: int uv_thread_equal(const uv_thread_t* t1, const uv_thread_t* t2)
+.. c:function:: int uv_thread_setname(const char* name)
+
+ Sets the name of the current thread. Different platforms define different limits on the max number of characters
+ a thread name can be: Linux, IBM i (16), macOS (64), Windows (32767), and NetBSD (32), etc. `uv_thread_setname()`
+ will truncate it in case `name` is larger than the limit of the platform.
+
+ .. versionadded:: 1.50.0
+
+.. c:function:: int uv_thread_getname(uv_thread_t* tid, char* name, size_t* size)
+
+ Gets the name of the thread specified by `tid`. The thread name is copied, with the trailing NUL, into the buffer
+ pointed to by `name`. The `size` parameter specifies the size of the buffer pointed to by `name`.
+ The buffer should be large enough to hold the name of the thread plus the trailing NUL, or it will be truncated to fit
+ with the trailing NUL.
+
+ .. versionadded:: 1.50.0
+
.. c:function:: int uv_thread_setpriority(uv_thread_t tid, int priority)
If the function succeeds, the return value is 0.
If the function fails, the return value is less than zero.