carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
							<!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++: grpc::ResourceQuota Class 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/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.36.1</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="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc::ResourceQuota Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> represents a bound on memory and thread usage by the gRPC library.  
 <a href="classgrpc_1_1_resource_quota.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2resource__quota_8h_source.html">resource_quota.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a59884378c08c839b340063953925fdf7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a59884378c08c839b340063953925fdf7">ResourceQuota</a> (const std::string &amp;name)</td></tr>
<tr class="separator:a59884378c08c839b340063953925fdf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a452006a82860143a83aefaf42ba2fb48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a452006a82860143a83aefaf42ba2fb48">ResourceQuota</a> ()</td></tr>
<tr class="separator:a452006a82860143a83aefaf42ba2fb48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96d81328bf6fe9009ac1fa4ba19c7eaa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a96d81328bf6fe9009ac1fa4ba19c7eaa">~ResourceQuota</a> () override</td></tr>
<tr class="separator:a96d81328bf6fe9009ac1fa4ba19c7eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e9034af4f310baa9bcc11ccfe46170f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a3e9034af4f310baa9bcc11ccfe46170f">Resize</a> (size_t new_size)</td></tr>
<tr class="memdesc:a3e9034af4f310baa9bcc11ccfe46170f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resize this <em><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a></em> to a new size.  <a href="classgrpc_1_1_resource_quota.html#a3e9034af4f310baa9bcc11ccfe46170f">More...</a><br /></td></tr>
<tr class="separator:a3e9034af4f310baa9bcc11ccfe46170f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6845dbf2ca8d94df38c36fff9ac15ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#ae6845dbf2ca8d94df38c36fff9ac15ca">SetMaxThreads</a> (int new_max_threads)</td></tr>
<tr class="memdesc:ae6845dbf2ca8d94df38c36fff9ac15ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the max number of threads that can be allocated from this <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> object.  <a href="classgrpc_1_1_resource_quota.html#ae6845dbf2ca8d94df38c36fff9ac15ca">More...</a><br /></td></tr>
<tr class="separator:ae6845dbf2ca8d94df38c36fff9ac15ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c8f03a21aba636ba5ed2504a0754085"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a16d58b8d7c93609d01311b869f4a8d05">grpc_resource_quota</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a1c8f03a21aba636ba5ed2504a0754085">c_resource_quota</a> () const</td></tr>
<tr class="separator:a1c8f03a21aba636ba5ed2504a0754085"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> represents a bound on memory and thread usage by the gRPC library. </p>
<p>A <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> can be attached to a server (via <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">ServerBuilder</a></em>), or a client channel (via <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em>). gRPC will attempt to keep memory and threads used by all attached entities below the <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> bound. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a59884378c08c839b340063953925fdf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59884378c08c839b340063953925fdf7">&#9670;&nbsp;</a></span>ResourceQuota() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::ResourceQuota::ResourceQuota </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>- a unique name for this <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a452006a82860143a83aefaf42ba2fb48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a452006a82860143a83aefaf42ba2fb48">&#9670;&nbsp;</a></span>ResourceQuota() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::ResourceQuota::ResourceQuota </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a96d81328bf6fe9009ac1fa4ba19c7eaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96d81328bf6fe9009ac1fa4ba19c7eaa">&#9670;&nbsp;</a></span>~ResourceQuota()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::ResourceQuota::~ResourceQuota </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1c8f03a21aba636ba5ed2504a0754085"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c8f03a21aba636ba5ed2504a0754085">&#9670;&nbsp;</a></span>c_resource_quota()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="grpc__types_8h.html#a16d58b8d7c93609d01311b869f4a8d05">grpc_resource_quota</a>* grpc::ResourceQuota::c_resource_quota </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a3e9034af4f310baa9bcc11ccfe46170f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e9034af4f310baa9bcc11ccfe46170f">&#9670;&nbsp;</a></span>Resize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a>&amp; grpc::ResourceQuota::Resize </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>new_size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resize this <em><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a></em> to a new size. </p>
<p>If <em>new_size</em> is smaller than the current size of the pool, memory usage will be monotonically decreased until it falls under <em>new_size</em>. No time bound is given for this to occur however. </p>

</div>
</div>
<a id="ae6845dbf2ca8d94df38c36fff9ac15ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6845dbf2ca8d94df38c36fff9ac15ca">&#9670;&nbsp;</a></span>SetMaxThreads()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a>&amp; grpc::ResourceQuota::SetMaxThreads </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>new_max_threads</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the max number of threads that can be allocated from this <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library.">ResourceQuota</a> object. </p>
<p>If the new_max_threads value is smaller than the current value, no new threads are allocated until the number of active threads fall below new_max_threads. There is no time bound on when this may happen i.e none of the current threads are forcefully destroyed and all threads run their normal course. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/<a class="el" href="grpcpp_2resource__quota_8h_source.html">resource_quota.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:24 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>