summaryrefslogtreecommitdiffstats
path: root/lldb/scripts/Python/interface/SBThread.i
diff options
context:
space:
mode:
Diffstat (limited to 'lldb/scripts/Python/interface/SBThread.i')
-rw-r--r--lldb/scripts/Python/interface/SBThread.i19
1 files changed, 19 insertions, 0 deletions
diff --git a/lldb/scripts/Python/interface/SBThread.i b/lldb/scripts/Python/interface/SBThread.i
index 92ea929c6b9..f2517366160 100644
--- a/lldb/scripts/Python/interface/SBThread.i
+++ b/lldb/scripts/Python/interface/SBThread.i
@@ -121,9 +121,28 @@ public:
SBValue
GetStopReturnValue ();
+ %feature("autodoc", "
+ Returns a unique thread identifier (type lldb::tid_t, typically a 64-bit type)
+ for the current SBThread that will remain constant throughout the thread's
+ lifetime in this process and will not be reused by another thread during this
+ process lifetime. On Mac OS X systems, this is a system-wide unique thread
+ identifier; this identifier is also used by other tools like sample which helps
+ to associate data from those tools with lldb. See related GetIndexID.
+ ")
+ GetThreadID;
lldb::tid_t
GetThreadID () const;
+ %feature("autodoc", "
+ Return the index number for this SBThread. The index number is the same thing
+ that a user gives as an argument to 'thread select' in the command line lldb.
+ These numbers start at 1 (for the first thread lldb sees in a debug session)
+ and increments up throughout the process lifetime. An index number will not be
+ reused for a different thread later in a process - thread 1 will always be
+ associated with the same thread. See related GetThreadID.
+ This method returns a uint32_t index number, takes no arguments.
+ ")
+ GetIndexID;
uint32_t
GetIndexID () const;
OpenPOWER on IntegriCloud