<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>Crashpad: crashpad::ThreadSnapshot Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html">ThreadSnapshot</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classcrashpad_1_1ThreadSnapshot-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ThreadSnapshot Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot process.
<a href="classcrashpad_1_1ThreadSnapshot.html#details">More...</a></p>
<p><code>#include "snapshot/thread_snapshot.h"</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::ThreadSnapshot:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1ThreadSnapshot.png" usemap="#crashpad::ThreadSnapshot_map" alt=""/>
<map id="crashpad::ThreadSnapshot_map" name="crashpad::ThreadSnapshot_map">
<area href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html" title="A ThreadSnapshot of a thread in a running (or crashed) process on a Mac OS X system. " alt="crashpad::internal::ThreadSnapshotMac" shape="rect" coords="0,56,355,80"/>
<area href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html" title="A ThreadSnapshot of a thread in a running (or crashed) process on a Windows system. " alt="crashpad::internal::ThreadSnapshotWin" shape="rect" coords="365,56,720,80"/>
<area href="classcrashpad_1_1test_1_1TestThreadSnapshot.html" title="A test ThreadSnapshot that can carry arbitrary data for testing purposes. " alt="crashpad::test::TestThreadSnapshot" shape="rect" coords="730,56,1085,80"/>
<area href="classcrashpad_1_1PointerContainer.html" alt="crashpad::PointerContainer< crashpad::ThreadSnapshot >" shape="rect" coords="1095,56,1450,80"/>
<area href="classcrashpad_1_1PointerContainer.html" alt="crashpad::PointerContainer< internal::ThreadSnapshotMac >" shape="rect" coords="0,112,355,136"/>
<area href="classcrashpad_1_1PointerContainer.html" alt="crashpad::PointerContainer< internal::ThreadSnapshotWin >" shape="rect" coords="365,112,720,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a50f10ede534f63a4c4ce75f4021666ae"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a50f10ede534f63a4c4ce75f4021666ae">Context</a> () const =0</td></tr>
<tr class="memdesc:a50f10ede534f63a4c4ce75f4021666ae"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. <a href="#a50f10ede534f63a4c4ce75f4021666ae">More...</a><br /></td></tr>
<tr class="separator:a50f10ede534f63a4c4ce75f4021666ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fd160661141c262db7f10b6aba146b7"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a4fd160661141c262db7f10b6aba146b7">Stack</a> () const =0</td></tr>
<tr class="memdesc:a4fd160661141c262db7f10b6aba146b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. <a href="#a4fd160661141c262db7f10b6aba146b7">More...</a><br /></td></tr>
<tr class="separator:a4fd160661141c262db7f10b6aba146b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21b11bab41a09226db8cdb6e629ebfc4"><td class="memItemLeft" align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a21b11bab41a09226db8cdb6e629ebfc4">ThreadID</a> () const =0</td></tr>
<tr class="memdesc:a21b11bab41a09226db8cdb6e629ebfc4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s identifier. <a href="#a21b11bab41a09226db8cdb6e629ebfc4">More...</a><br /></td></tr>
<tr class="separator:a21b11bab41a09226db8cdb6e629ebfc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d999ae7a68cc7a15e54e84abf875df0"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a1d999ae7a68cc7a15e54e84abf875df0">SuspendCount</a> () const =0</td></tr>
<tr class="memdesc:a1d999ae7a68cc7a15e54e84abf875df0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s suspend count. <a href="#a1d999ae7a68cc7a15e54e84abf875df0">More...</a><br /></td></tr>
<tr class="separator:a1d999ae7a68cc7a15e54e84abf875df0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc92d204f84b7e533068f924c195195c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#abc92d204f84b7e533068f924c195195c">Priority</a> () const =0</td></tr>
<tr class="memdesc:abc92d204f84b7e533068f924c195195c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s priority. <a href="#abc92d204f84b7e533068f924c195195c">More...</a><br /></td></tr>
<tr class="separator:abc92d204f84b7e533068f924c195195c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2488beec090e16e6825d68c791d0af3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2488beec090e16e6825d68c791d0af3e"></a>
virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a2488beec090e16e6825d68c791d0af3e">ThreadSpecificDataAddress</a> () const =0</td></tr>
<tr class="memdesc:a2488beec090e16e6825d68c791d0af3e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base address of a region used to store thread-specific data. <br /></td></tr>
<tr class="separator:a2488beec090e16e6825d68c791d0af3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa10a563fdf24cf2b321ef8f0f92829d2"><td class="memItemLeft" align="right" valign="top">virtual std::vector< const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadSnapshot.html#aa10a563fdf24cf2b321ef8f0f92829d2">ExtraMemory</a> () const =0</td></tr>
<tr class="memdesc:aa10a563fdf24cf2b321ef8f0f92829d2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector of additional memory blocks that should be included in a minidump. <a href="#aa10a563fdf24cf2b321ef8f0f92829d2">More...</a><br /></td></tr>
<tr class="separator:aa10a563fdf24cf2b321ef8f0f92829d2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot process. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a50f10ede534f63a4c4ce75f4021666ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a>* crashpad::ThreadSnapshot::Context </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. </p>
<p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#a9e936eb0a5e8b5792ee8804611d7e6f3">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a54a30092927ae965fc1b6ca5001af532">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#acc67b86bdcb38a50651b14a39b9c2036">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<a class="anchor" id="aa10a563fdf24cf2b321ef8f0f92829d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector<const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a>*> crashpad::ThreadSnapshot::ExtraMemory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a vector of additional memory blocks that should be included in a minidump. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> objects that will be included in the crash dump. The caller does not take ownership of these objects, they are scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that they were obtained from. </dd></dl>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#afde179275a9d3b01103264400c4e0e3e">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a994744850599adcf23bba5417a304ec2">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#aebd4b9ebe83af0e8c7581eac590d68eb">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<a class="anchor" id="abc92d204f84b7e533068f924c195195c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int crashpad::ThreadSnapshot::Priority </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s priority. </p>
<p>Threads with higher priorities will have higher priority values. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#ad5d5f2998027442fe96fd7977fa73a1e">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a3fca37fde5571302ad6ca46182ae081b">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a4b75256da46e63543298475d64c99697">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<a class="anchor" id="a4fd160661141c262db7f10b6aba146b7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a>* crashpad::ThreadSnapshot::Stack </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. </p>
<p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#af4d76ef3adcadf3c02efb3ffb68dfdfe">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#ababd38c54c1b464ebee8a9ee4c9ab6d4">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#ae24a61b5890c07c1c50be4fb838c6e61">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<a class="anchor" id="a1d999ae7a68cc7a15e54e84abf875df0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int crashpad::ThreadSnapshot::SuspendCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s suspend count. </p>
<p>A suspend count of <code>0</code> denotes a schedulable (not suspended) thread. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#a212c13c2f4c0c4334f2b8485ff066222">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a5d852ab008e5826ae9f19a36698a459e">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#aa2356fd633378e2bdfe4355f07a4509d">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<a class="anchor" id="a21b11bab41a09226db8cdb6e629ebfc4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t crashpad::ThreadSnapshot::ThreadID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s identifier. </p>
<p>Thread identifiers are at least unique within a process, and may be unique system-wide. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1test_1_1TestThreadSnapshot.html#a2e1aae49f6c657aa38b0582d08bd1690">crashpad::test::TestThreadSnapshot</a>, <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#af04a3f18cff1a130f4f3343c1654689a">crashpad::internal::ThreadSnapshotWin</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a89206c3a5253874266e955d03a5e5de2">crashpad::internal::ThreadSnapshotMac</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>snapshot/thread_snapshot.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>