140 lines
16 KiB
HTML
140 lines
16 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/memory_request.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.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&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">memory_request.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="memory__request_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_MEMORY_REQUEST_H</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define GRPC_EVENT_ENGINE_MEMORY_REQUEST_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 <stddef.h></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 "absl/strings/string_view.h"</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 <<a class="code" href="support_2port__platform_8h.html">grpc/support/port_platform.h</a>></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc__event__engine.html">grpc_event_engine</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>experimental {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html">MemoryRequest</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// NOLINTNEXTLINE(google-explicit-constructor)</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a2502ca8932ee81cf8015db45bc5188c6"> 31</a></span>  <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a2502ca8932ee81cf8015db45bc5188c6">MemoryRequest</a>(<span class="keywordtype">size_t</span> n) : min_(n), max_(n) {}</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a4b865723f0e2c15af381ab516cad5d1d"> 35</a></span>  <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a4b865723f0e2c15af381ab516cad5d1d">MemoryRequest</a>(<span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a0ae4bf6f6efa919f6a0f467467c5dcdf">min</a>, <span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab2b5a954b783be3bc90a6870ff02843f">max</a>) : min_(<a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a0ae4bf6f6efa919f6a0f467467c5dcdf">min</a>), max_(<a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab2b5a954b783be3bc90a6870ff02843f">max</a>) {}</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab8d74d1b6b325a4cbc5fa7b63cbe9056"> 38</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab8d74d1b6b325a4cbc5fa7b63cbe9056">max_allowed_size</a>() { <span class="keywordflow">return</span> 1024 * 1024 * 1024; }</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a63a2c7255efde882b3c6d0e501ee5256"> 42</a></span>  <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html">MemoryRequest</a> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a63a2c7255efde882b3c6d0e501ee5256">Increase</a>(<span class="keywordtype">size_t</span> amount)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a2502ca8932ee81cf8015db45bc5188c6">MemoryRequest</a>(min_ + amount, max_ + amount);</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"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a0ae4bf6f6efa919f6a0f467467c5dcdf"> 46</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a0ae4bf6f6efa919f6a0f467467c5dcdf">min</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> min_; }</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab2b5a954b783be3bc90a6870ff02843f"> 47</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab2b5a954b783be3bc90a6870ff02843f">max</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> max_; }</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="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">size_t</span> min_;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">size_t</span> max_;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> } <span class="comment">// namespace experimental</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } <span class="comment">// namespace grpc_event_engine</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif // GRPC_EVENT_ENGINE_MEMORY_REQUEST_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html_ab2b5a954b783be3bc90a6870ff02843f"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab2b5a954b783be3bc90a6870ff02843f">grpc_event_engine::experimental::MemoryRequest::max</a></div><div class="ttdeci">size_t max() const</div><div class="ttdef"><b>Definition:</b> memory_request.h:47</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html_a4b865723f0e2c15af381ab516cad5d1d"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a4b865723f0e2c15af381ab516cad5d1d">grpc_event_engine::experimental::MemoryRequest::MemoryRequest</a></div><div class="ttdeci">MemoryRequest(size_t min, size_t max)</div><div class="ttdoc">Request a range of memory.</div><div class="ttdef"><b>Definition:</b> memory_request.h:35</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html">grpc_event_engine::experimental::MemoryRequest</a></div><div class="ttdoc">Reservation request - how much memory do we want to allocate?</div><div class="ttdef"><b>Definition:</b> memory_request.h:27</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html_a63a2c7255efde882b3c6d0e501ee5256"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a63a2c7255efde882b3c6d0e501ee5256">grpc_event_engine::experimental::MemoryRequest::Increase</a></div><div class="ttdeci">MemoryRequest Increase(size_t amount) const</div><div class="ttdoc">Increase the size by amount.</div><div class="ttdef"><b>Definition:</b> memory_request.h:42</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html_a0ae4bf6f6efa919f6a0f467467c5dcdf"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a0ae4bf6f6efa919f6a0f467467c5dcdf">grpc_event_engine::experimental::MemoryRequest::min</a></div><div class="ttdeci">size_t min() const</div><div class="ttdef"><b>Definition:</b> memory_request.h:46</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_memory_request_html_a2502ca8932ee81cf8015db45bc5188c6"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#a2502ca8932ee81cf8015db45bc5188c6">grpc_event_engine::experimental::MemoryRequest::MemoryRequest</a></div><div class="ttdeci">MemoryRequest(size_t n)</div><div class="ttdoc">Request a fixed amount of memory.</div><div class="ttdef"><b>Definition:</b> memory_request.h:31</div></div>
|
|
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1_memory_request_html_ab8d74d1b6b325a4cbc5fa7b63cbe9056"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html#ab8d74d1b6b325a4cbc5fa7b63cbe9056">grpc_event_engine::experimental::MemoryRequest::max_allowed_size</a></div><div class="ttdeci">static constexpr size_t max_allowed_size()</div><div class="ttdoc">Maximum allowable request size - hard coded to 1GB.</div><div class="ttdef"><b>Definition:</b> memory_request.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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|