134 lines
13 KiB
HTML
134 lines
13 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/event_engine/endpoint_config.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++
|
|
 <span id="projectnumber">1.58.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&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&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_bd8dffe728229f23f136e38dafaf5150.html">event_engine</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">endpoint_config.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="endpoint__config_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> <span class="comment">// Copyright 2021 The gRPC Authors</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <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> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef GRPC_EVENT_ENGINE_ENDPOINT_CONFIG_H</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define GRPC_EVENT_ENGINE_ENDPOINT_CONFIG_H</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="support_2port__platform_8h.html">grpc/support/port_platform.h</a>></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "absl/strings/string_view.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "absl/types/optional.h"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespacegrpc__event__engine.html"> 24</a></span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc__event__engine.html">grpc_event_engine</a> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespacegrpc__event__engine_1_1experimental.html"> 25</a></span> <span class="keyword">namespace </span>experimental {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html">EndpointConfig</a> {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#af86d519833129ea7950b5449857c9c6e">~EndpointConfig</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// If the key points to an integer config, an integer value gets returned.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Otherwise it returns an absl::nullopt_t</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> absl::optional<int> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a59a2cc323e22c30a23c943f14e37d2b5">GetInt</a>(absl::string_view key) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// If the key points to an string config, an string value gets returned.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Otherwise it returns an absl::nullopt_t</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> absl::optional<absl::string_view> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a3399e01fc2e973112451546b59ec1c97">GetString</a>(</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  absl::string_view key) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// If the key points to an void* config, a void* pointer value gets returned.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Otherwise it returns nullptr</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a568da1db8412728292100849e4bc3ef9">GetVoidPointer</a>(absl::string_view key) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> };</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> } <span class="comment">// namespace experimental</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <span class="comment">// namespace grpc_event_engine</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif // GRPC_EVENT_ENGINE_ENDPOINT_CONFIG_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_endpoint_config_html_a3399e01fc2e973112451546b59ec1c97"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a3399e01fc2e973112451546b59ec1c97">grpc_event_engine::experimental::EndpointConfig::GetString</a></div><div class="ttdeci">virtual absl::optional< absl::string_view > GetString(absl::string_view key) const =0</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_endpoint_config_html_a568da1db8412728292100849e4bc3ef9"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a568da1db8412728292100849e4bc3ef9">grpc_event_engine::experimental::EndpointConfig::GetVoidPointer</a></div><div class="ttdeci">virtual void * GetVoidPointer(absl::string_view key) const =0</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_endpoint_config_html"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html">grpc_event_engine::experimental::EndpointConfig</a></div><div class="ttdoc">Collection of parameters used to configure client and server endpoints.</div><div class="ttdef"><b>Definition:</b> endpoint_config.h:31</div></div>
|
|
<div class="ttc" id="anamespacegrpc__event__engine_html"><div class="ttname"><a href="namespacegrpc__event__engine.html">grpc_event_engine</a></div><div class="ttdef"><b>Definition:</b> endpoint_config.h:24</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_endpoint_config_html_a59a2cc323e22c30a23c943f14e37d2b5"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#a59a2cc323e22c30a23c943f14e37d2b5">grpc_event_engine::experimental::EndpointConfig::GetInt</a></div><div class="ttdeci">virtual absl::optional< int > GetInt(absl::string_view key) const =0</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_endpoint_config_html_af86d519833129ea7950b5449857c9c6e"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_endpoint_config.html#af86d519833129ea7950b5449857c9c6e">grpc_event_engine::experimental::EndpointConfig::~EndpointConfig</a></div><div class="ttdeci">virtual ~EndpointConfig()=default</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 Wed Sep 6 2023 16:09:16 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|