grpc/cpp/metrics_8h_source.html

135 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpc/support/metrics.h Source File</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" />
</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">GRPC C++
&#160;<span id="projectnumber">1.64.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_cad3142e04109052413f2d2a2d1813b0.html">support</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">metrics.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="metrics_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2024 The gRPC Authors.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef GRPC_SUPPORT_METRICS_H</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define GRPC_SUPPORT_METRICS_H</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;absl/strings/string_view.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="support_2port__platform_8h.html">grpc/support/port_platform.h</a>&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc__core.html">grpc_core</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span>experimental {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// Configuration (scope) for a specific client channel to be used for stats</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// plugins.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html">StatsPluginChannelScope</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#ac1337ba0c1bd805deff2792f73233cde"> 29</a></span>&#160; <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#ac1337ba0c1bd805deff2792f73233cde">StatsPluginChannelScope</a>(absl::string_view <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a7dc406f58e9ca45a095549f315eae670">target</a>,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; absl::string_view <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a353d35ef2e6fd925f3e707af9c874c5b">default_authority</a>)</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; : target_(<a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a7dc406f58e9ca45a095549f315eae670">target</a>), default_authority_(<a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a353d35ef2e6fd925f3e707af9c874c5b">default_authority</a>) {}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a7dc406f58e9ca45a095549f315eae670"> 36</a></span>&#160; absl::string_view <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a7dc406f58e9ca45a095549f315eae670">target</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> target_; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a353d35ef2e6fd925f3e707af9c874c5b"> 38</a></span>&#160; absl::string_view <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a353d35ef2e6fd925f3e707af9c874c5b">default_authority</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> default_authority_; }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// Disable copy constructor and copy-assignment operator.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#ac1337ba0c1bd805deff2792f73233cde">StatsPluginChannelScope</a>(<span class="keyword">const</span> <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html">StatsPluginChannelScope</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html">StatsPluginChannelScope</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html">StatsPluginChannelScope</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; absl::string_view target_;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; absl::string_view default_authority_;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;};</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;} <span class="comment">// namespace experimental</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;} <span class="comment">// namespace grpc_core</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_SUPPORT_METRICS_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacegrpc__core_html"><div class="ttname"><a href="namespacegrpc__core.html">grpc_core</a></div><div class="ttdef"><b>Definition:</b> grpc_audit_logging.h:31</div></div>
<div class="ttc" id="aclassgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope_html_ac1337ba0c1bd805deff2792f73233cde"><div class="ttname"><a href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#ac1337ba0c1bd805deff2792f73233cde">grpc_core::experimental::StatsPluginChannelScope::StatsPluginChannelScope</a></div><div class="ttdeci">StatsPluginChannelScope(absl::string_view target, absl::string_view default_authority)</div><div class="ttdef"><b>Definition:</b> metrics.h:29</div></div>
<div class="ttc" id="aclassgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope_html_a7dc406f58e9ca45a095549f315eae670"><div class="ttname"><a href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a7dc406f58e9ca45a095549f315eae670">grpc_core::experimental::StatsPluginChannelScope::target</a></div><div class="ttdeci">absl::string_view target() const</div><div class="ttdoc">Returns the target used for creating the channel in the canonical form.</div><div class="ttdef"><b>Definition:</b> metrics.h:36</div></div>
<div class="ttc" id="aclassgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope_html"><div class="ttname"><a href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html">grpc_core::experimental::StatsPluginChannelScope</a></div><div class="ttdef"><b>Definition:</b> metrics.h:27</div></div>
<div class="ttc" id="aclassgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope_html_a353d35ef2e6fd925f3e707af9c874c5b"><div class="ttname"><a href="classgrpc__core_1_1experimental_1_1_stats_plugin_channel_scope.html#a353d35ef2e6fd925f3e707af9c874c5b">grpc_core::experimental::StatsPluginChannelScope::default_authority</a></div><div class="ttdeci">absl::string_view default_authority() const</div><div class="ttdoc">Returns the default authority for the channel.</div><div class="ttdef"><b>Definition:</b> metrics.h:38</div></div>
<div class="ttc" id="asupport_2port__platform_8h_html"><div class="ttname"><a href="support_2port__platform_8h.html">port_platform.h</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:15 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>