grpc/cpp/memory__allocator__impl_8h_...

150 lines
19 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/internal/memory_allocator_impl.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_bd8dffe728229f23f136e38dafaf5150.html">event_engine</a></li><li class="navelem"><a class="el" href="dir_f317bab89d176f7540f060919119ce81.html">internal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">memory_allocator_impl.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="memory__allocator__impl_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 2021 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;<span class="preprocessor">#ifndef GRPC_EVENT_ENGINE_INTERNAL_MEMORY_ALLOCATOR_IMPL_H</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define GRPC_EVENT_ENGINE_INTERNAL_MEMORY_ALLOCATOR_IMPL_H</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;vector&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="preprocessor">#include &lt;<a class="code" href="memory__request_8h.html">grpc/event_engine/memory_request.h</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc_2slice_8h.html">grpc/slice.h</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</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="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc__event__engine.html">grpc_event_engine</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>experimental {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacegrpc__event__engine_1_1experimental_1_1internal.html"> 29</a></span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html">MemoryAllocatorImpl</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; : <span class="keyword">public</span> std::enable_shared_from_this&lt;MemoryAllocatorImpl&gt; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a9e6a8e994d3e67e054d308142dd6dc8c"> 37</a></span>&#160; <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a9e6a8e994d3e67e054d308142dd6dc8c">MemoryAllocatorImpl</a>() {}</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a16bcdb29ea62d54e3f8c14f4c7af64eb"> 38</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a16bcdb29ea62d54e3f8c14f4c7af64eb">~MemoryAllocatorImpl</a>() {}</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; <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a9e6a8e994d3e67e054d308142dd6dc8c">MemoryAllocatorImpl</a>(<span class="keyword">const</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html">MemoryAllocatorImpl</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html">MemoryAllocatorImpl</a>&amp; <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a89a118fa4c2c8863f7339841a3d5bbf1">operator=</a>(<span class="keyword">const</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html">MemoryAllocatorImpl</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a668908d336cf3c21ad6f7dfe7f06739a">Reserve</a>(<a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html">MemoryRequest</a> request) = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">virtual</span> <a class="code" href="structgrpc__slice.html">grpc_slice</a> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#aba1813501d54cb8140c8c50024e8bb91">MakeSlice</a>(<a class="code" href="classgrpc__event__engine_1_1experimental_1_1_memory_request.html">MemoryRequest</a> request) = 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a7174ccff32e753e55b68e609b82f8617">Release</a>(<span class="keywordtype">size_t</span> n) = 0;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#abeee43fc002c4f3cc8cdb976424ec9c6">Shutdown</a>() = 0;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;} <span class="comment">// namespace internal</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// namespace experimental</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;} <span class="comment">// namespace grpc_event_engine</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif // GRPC_EVENT_ENGINE_INTERNAL_MEMORY_ALLOCATOR_IMPL_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html_a668908d336cf3c21ad6f7dfe7f06739a"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a668908d336cf3c21ad6f7dfe7f06739a">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::Reserve</a></div><div class="ttdeci">virtual size_t Reserve(MemoryRequest request)=0</div><div class="ttdoc">Reserve bytes from the quota.</div></div>
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html_abeee43fc002c4f3cc8cdb976424ec9c6"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#abeee43fc002c4f3cc8cdb976424ec9c6">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::Shutdown</a></div><div class="ttdeci">virtual void Shutdown()=0</div><div class="ttdoc">Shutdown this allocator.</div></div>
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html_aba1813501d54cb8140c8c50024e8bb91"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#aba1813501d54cb8140c8c50024e8bb91">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::MakeSlice</a></div><div class="ttdeci">virtual grpc_slice MakeSlice(MemoryRequest request)=0</div><div class="ttdoc">Allocate a slice, using MemoryRequest to size the number of returned bytes.</div></div>
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html">grpc_event_engine::experimental::internal::MemoryAllocatorImpl</a></div><div class="ttdoc">Underlying memory allocation interface.</div><div class="ttdef"><b>Definition:</b> memory_allocator_impl.h:34</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_1internal_1_1_memory_allocator_impl_html_a7174ccff32e753e55b68e609b82f8617"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a7174ccff32e753e55b68e609b82f8617">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::Release</a></div><div class="ttdeci">virtual void Release(size_t n)=0</div><div class="ttdoc">Release some bytes that were previously reserved.</div></div>
<div class="ttc" id="astructgrpc__slice_html"><div class="ttname"><a href="structgrpc__slice.html">grpc_slice</a></div><div class="ttdoc">A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].</div><div class="ttdef"><b>Definition:</b> slice_type.h:63</div></div>
<div class="ttc" id="amemory__request_8h_html"><div class="ttname"><a href="memory__request_8h.html">memory_request.h</a></div></div>
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html_a89a118fa4c2c8863f7339841a3d5bbf1"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a89a118fa4c2c8863f7339841a3d5bbf1">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::operator=</a></div><div class="ttdeci">MemoryAllocatorImpl &amp; operator=(const MemoryAllocatorImpl &amp;)=delete</div></div>
<div class="ttc" id="aclassgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl_html_a9e6a8e994d3e67e054d308142dd6dc8c"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a9e6a8e994d3e67e054d308142dd6dc8c">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::MemoryAllocatorImpl</a></div><div class="ttdeci">MemoryAllocatorImpl()</div><div class="ttdef"><b>Definition:</b> memory_allocator_impl.h:37</div></div>
<div class="ttc" id="agrpc_2slice_8h_html"><div class="ttname"><a href="grpc_2slice_8h.html">slice.h</a></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_1internal_1_1_memory_allocator_impl_html_a16bcdb29ea62d54e3f8c14f4c7af64eb"><div class="ttname"><a href="classgrpc__event__engine_1_1experimental_1_1internal_1_1_memory_allocator_impl.html#a16bcdb29ea62d54e3f8c14f4c7af64eb">grpc_event_engine::experimental::internal::MemoryAllocatorImpl::~MemoryAllocatorImpl</a></div><div class="ttdeci">virtual ~MemoryAllocatorImpl()</div><div class="ttdef"><b>Definition:</b> memory_allocator_impl.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>