diff options
Diffstat (limited to 'doc/ref/core/html/census_8h.html')
| -rw-r--r-- | doc/ref/core/html/census_8h.html | 369 |
1 files changed, 369 insertions, 0 deletions
diff --git a/doc/ref/core/html/census_8h.html b/doc/ref/core/html/census_8h.html new file mode 100644 index 0000000000..3be526cbc1 --- /dev/null +++ b/doc/ref/core/html/census_8h.html @@ -0,0 +1,369 @@ +<!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.6"/> +<title>GRPC Core: include/grpc/census.h File 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">GRPC Core +  <span id="projectnumber">0.10.0.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Data Structures</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">census.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>></code><br/> +</div> +<p><a href="census_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcensus__stat.html">census_stat</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a27fc8788690179599713226f1f054736"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a></td></tr> +<tr class="separator:a27fc8788690179599713226f1f054736"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:abe92e59c22481b0de3742673cbbb1bf8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8">census_features</a> { <br/> +  <a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8aac1986834f37851b8d899c4a08c8e3ab">CENSUS_FEATURE_NONE</a> = 0, +<a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8ab0722326e730113d5be97f643c3e6718">CENSUS_FEATURE_TRACING</a> = 1, +<a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8a84c772b868e53ee3487c7bfc8e8b2f1a">CENSUS_FEATURE_STATS</a> = 2, +<a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8a4808bff624e2377596b86a6f58ab04b5">CENSUS_FEATURE_CPU</a> = 4, +<br/> +  <a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8aba96a94fb7af8cf1144ca14edc0b1f0c">CENSUS_FEATURE_ALL</a> +<br/> + }</td></tr> +<tr class="separator:abe92e59c22481b0de3742673cbbb1bf8"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a4cea92157f3de215724f6bf4aeaee1b6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#a4cea92157f3de215724f6bf4aeaee1b6">census_initialize</a> (int features)</td></tr> +<tr class="memdesc:a4cea92157f3de215724f6bf4aeaee1b6"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown and startup census subsystem. <a href="#a4cea92157f3de215724f6bf4aeaee1b6">More...</a><br/></td></tr> +<tr class="separator:a4cea92157f3de215724f6bf4aeaee1b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa792b067548ecdd987d560b492c83d85"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#aa792b067548ecdd987d560b492c83d85">census_shutdown</a> (void)</td></tr> +<tr class="separator:aa792b067548ecdd987d560b492c83d85"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad5f627a64ac4febbc61d2b89801d40e9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#ad5f627a64ac4febbc61d2b89801d40e9">census_supported</a> (void)</td></tr> +<tr class="memdesc:ad5f627a64ac4febbc61d2b89801d40e9"><td class="mdescLeft"> </td><td class="mdescRight">Return the features supported by the current census implementation (not all features will be available on all platforms). <a href="#ad5f627a64ac4febbc61d2b89801d40e9">More...</a><br/></td></tr> +<tr class="separator:ad5f627a64ac4febbc61d2b89801d40e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a742616973e78aaf969389cea20feea9f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#a742616973e78aaf969389cea20feea9f">census_enabled</a> (void)</td></tr> +<tr class="memdesc:a742616973e78aaf969389cea20feea9f"><td class="mdescLeft"> </td><td class="mdescRight">Return the census features currently enabled. <a href="#a742616973e78aaf969389cea20feea9f">More...</a><br/></td></tr> +<tr class="separator:a742616973e78aaf969389cea20feea9f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad9a7d3170ecf720e1b22a4f255605748"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#ad9a7d3170ecf720e1b22a4f255605748">census_context_serialize</a> (const <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> *context, char *buffer, size_t buf_size)</td></tr> +<tr class="separator:ad9a7d3170ecf720e1b22a4f255605748"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad9daab242b41571299ac5b3bca71fc0d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#ad9daab242b41571299ac5b3bca71fc0d">census_context_deserialize</a> (const char *buffer, <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> **context)</td></tr> +<tr class="separator:ad9daab242b41571299ac5b3bca71fc0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5bfcd1edc546eeacf111c3316ae7785d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#a5bfcd1edc546eeacf111c3316ae7785d">census_context_destroy</a> (<a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> *context)</td></tr> +<tr class="separator:a5bfcd1edc546eeacf111c3316ae7785d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0cdd5ba86b080e6b5a4b47cfaa5b51cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="census_8h.html#a0cdd5ba86b080e6b5a4b47cfaa5b51cb">census_record_stat</a> (<a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> *context, <a class="el" href="structcensus__stat.html">census_stat</a> *stats, size_t nstats)</td></tr> +<tr class="separator:a0cdd5ba86b080e6b5a4b47cfaa5b51cb"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="a27fc8788690179599713226f1f054736"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="census_8h.html#abe92e59c22481b0de3742673cbbb1bf8">census_features</a></td> + </tr> + </table> +</div><div class="memdoc"> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8aac1986834f37851b8d899c4a08c8e3ab"></a>CENSUS_FEATURE_NONE</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8ab0722326e730113d5be97f643c3e6718"></a>CENSUS_FEATURE_TRACING</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8a84c772b868e53ee3487c7bfc8e8b2f1a"></a>CENSUS_FEATURE_STATS</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8a4808bff624e2377596b86a6f58ab04b5"></a>CENSUS_FEATURE_CPU</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="abe92e59c22481b0de3742673cbbb1bf8aba96a94fb7af8cf1144ca14edc0b1f0c"></a>CENSUS_FEATURE_ALL</em> </td><td class="fielddoc"> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ad9daab242b41571299ac5b3bca71fc0d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int census_context_deserialize </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> ** </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a5bfcd1edc546eeacf111c3316ae7785d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void census_context_destroy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> * </td> + <td class="paramname"><em>context</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ad9a7d3170ecf720e1b22a4f255605748"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">size_t census_context_serialize </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> * </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>buf_size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a742616973e78aaf969389cea20feea9f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int census_enabled </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return the census features currently enabled. </p> + +</div> +</div> +<a class="anchor" id="a4cea92157f3de215724f6bf4aeaee1b6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int census_initialize </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>features</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Shutdown and startup census subsystem. </p> +<p>The 'features' argument should be the OR (|) of census_features values. If census fails to initialize, then <a class="el" href="census_8h.html#a4cea92157f3de215724f6bf4aeaee1b6" title="Shutdown and startup census subsystem. ">census_initialize()</a> will return a non-zero value. It is an error to call <a class="el" href="census_8h.html#a4cea92157f3de215724f6bf4aeaee1b6" title="Shutdown and startup census subsystem. ">census_initialize()</a> more than once (without an intervening <a class="el" href="census_8h.html#aa792b067548ecdd987d560b492c83d85">census_shutdown()</a>). </p> + +</div> +</div> +<a class="anchor" id="a0cdd5ba86b080e6b5a4b47cfaa5b51cb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void census_record_stat </td> + <td>(</td> + <td class="paramtype"><a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> * </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structcensus__stat.html">census_stat</a> * </td> + <td class="paramname"><em>stats</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nstats</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aa792b067548ecdd987d560b492c83d85"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void census_shutdown </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ad5f627a64ac4febbc61d2b89801d40e9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int census_supported </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return the features supported by the current census implementation (not all features will be available on all platforms). </p> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Aug 5 2015 08:17:05 for GRPC Core by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |