From 6c5070d9157ab0de667568655f0bbeb60780d701 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sat, 8 Aug 2020 18:25:48 -0700
Subject: fixes #960 NNG threads inherit application thread name

This also exposes an nng_thread_set_name() function for
applications to use.  All NNG thread names start with "nng:".
Note that support is highly dependent on the operating system.
---
 docs/man/nng_thread_set_name.3supp.adoc | 48 +++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 docs/man/nng_thread_set_name.3supp.adoc

(limited to 'docs/man/nng_thread_set_name.3supp.adoc')

diff --git a/docs/man/nng_thread_set_name.3supp.adoc b/docs/man/nng_thread_set_name.3supp.adoc
new file mode 100644
index 00000000..385d2727
--- /dev/null
+++ b/docs/man/nng_thread_set_name.3supp.adoc
@@ -0,0 +1,48 @@
+= nng_thread_set_name(3supp)
+//
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt).  A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_thread_set_name - set thread name
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/util/platform.h>
+
+void nng_set_thread_name(nng_thread *thread, const char *name);
+----
+
+== DESCRIPTION
+
+The `nng_thread_set_name()` function attempts to set the name for the _thread_ to _name_.
+
+If _thread_ is `NULL`, then the name is set for the current thread.
+
+Support for this, and how names are exposed, varies between platform implementations.
+This function is intended to facilitate debugging applications that may have many threads.
+
+TIP: Internal threads created by _NNG_ will have names beginning with `nng:`.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_thread_create.3supp.adoc[nng_thread_create(3supp)],
+xref:nng.7.adoc[nng(7)]
-- 
cgit v1.2.3-70-g09d2

