crashpad/doc/generated/doxygen/classcrashpad_1_1ProcStatReader.html
2017-07-29 17:13:40 -04:00

218 lines
10 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::ProcStatReader 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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="crashpad_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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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_1ProcStatReader.html">ProcStatReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1ProcStatReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ProcStatReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Reads the /proc/[pid]/stat file for a thread.
<a href="classcrashpad_1_1ProcStatReader.html#details">More...</a></p>
<p><code>#include &quot;util/linux/proc_stat_reader.h&quot;</code></p>
<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:a463cccb70ae8bc5fb5103a08564b8258"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcStatReader.html#a463cccb70ae8bc5fb5103a08564b8258">Initialize</a> (pid_t tid)</td></tr>
<tr class="memdesc:a463cccb70ae8bc5fb5103a08564b8258"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the reader. <a href="#a463cccb70ae8bc5fb5103a08564b8258">More...</a><br /></td></tr>
<tr class="separator:a463cccb70ae8bc5fb5103a08564b8258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1736cf08293694fe3d9151081450848"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcStatReader.html#ad1736cf08293694fe3d9151081450848">UserCPUTime</a> (timeval *user_time) const</td></tr>
<tr class="memdesc:ad1736cf08293694fe3d9151081450848"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the time the thread has spent executing in user mode. <a href="#ad1736cf08293694fe3d9151081450848">More...</a><br /></td></tr>
<tr class="separator:ad1736cf08293694fe3d9151081450848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac335f580ac74a24cce979c5874394d1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcStatReader.html#ac335f580ac74a24cce979c5874394d1f">SystemCPUTime</a> (timeval *system_time) const</td></tr>
<tr class="memdesc:ac335f580ac74a24cce979c5874394d1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the time the thread has spent executing in system mode. <a href="#ac335f580ac74a24cce979c5874394d1f">More...</a><br /></td></tr>
<tr class="separator:ac335f580ac74a24cce979c5874394d1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2b29dd0400eafde943c44482cfc2714"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcStatReader.html#aa2b29dd0400eafde943c44482cfc2714">StartTime</a> (timeval *start_time) const</td></tr>
<tr class="memdesc:aa2b29dd0400eafde943c44482cfc2714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the target threads start time. <a href="#aa2b29dd0400eafde943c44482cfc2714">More...</a><br /></td></tr>
<tr class="separator:aa2b29dd0400eafde943c44482cfc2714"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Reads the /proc/[pid]/stat file for a thread. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a463cccb70ae8bc5fb5103a08564b8258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a463cccb70ae8bc5fb5103a08564b8258">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcStatReader::Initialize </td>
<td>(</td>
<td class="paramtype">pid_t&#160;</td>
<td class="paramname"><em>tid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the reader. </p>
<p>This method must be successfully called before calling any other.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tid</td><td>The thread ID to read the stat file for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa2b29dd0400eafde943c44482cfc2714"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2b29dd0400eafde943c44482cfc2714">&#9670;&nbsp;</a></span>StartTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcStatReader::StartTime </td>
<td>(</td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>start_time</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the target threads start time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">start_time</td><td>The time that the thread started.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, with <em>start_time</em> set. Otherwise, <code>false</code> with a message logged. </dd></dl>
</div>
</div>
<a id="ac335f580ac74a24cce979c5874394d1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac335f580ac74a24cce979c5874394d1f">&#9670;&nbsp;</a></span>SystemCPUTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcStatReader::SystemCPUTime </td>
<td>(</td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>system_time</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the time the thread has spent executing in system mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">system_time</td><td>The time spent executing in system mode.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, with <em>system_time</em> set. Otherwise, <code>false</code> with a message logged. </dd></dl>
</div>
</div>
<a id="ad1736cf08293694fe3d9151081450848"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1736cf08293694fe3d9151081450848">&#9670;&nbsp;</a></span>UserCPUTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcStatReader::UserCPUTime </td>
<td>(</td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>user_time</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the time the thread has spent executing in user mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">user_time</td><td>The time spent executing in user mode.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, with <em>user_time</em> set. Otherwise, <code>false</code> with a message logged. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/linux/proc_stat_reader.h</li>
<li>util/linux/proc_stat_reader.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>