classgrpc_1_1_resource_quota.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ResourceQuota Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::ResourceQuota Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory usage by the gRPC library. ">ResourceQuota</a> represents a bound on memory usage by the gRPC library.
  71. <a href="classgrpc_1_1_resource_quota.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2resource__quota_8h_source.html">resource_quota.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:a5014fc19c5c5e8e6cdb8eb9c21a1f170"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#a5014fc19c5c5e8e6cdb8eb9c21a1f170">ResourceQuota</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;name)</td></tr>
  77. <tr class="separator:a5014fc19c5c5e8e6cdb8eb9c21a1f170"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:a452006a82860143a83aefaf42ba2fb48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ad398badd3b31871dce142e9ba18b45ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_resource_quota.html#ad398badd3b31871dce142e9ba18b45ce">~ResourceQuota</a> ()</td></tr>
  81. <tr class="separator:ad398badd3b31871dce142e9ba18b45ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <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 usage by the gRPC library. ">ResourceQuota</a></em> to a new size. <a href="#a3e9034af4f310baa9bcc11ccfe46170f">More...</a><br /></td></tr>
  84. <tr class="separator:a3e9034af4f310baa9bcc11ccfe46170f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <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>
  86. <tr class="separator:a1c8f03a21aba636ba5ed2504a0754085"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89. <div class="textblock"><p><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory usage by the gRPC library. ">ResourceQuota</a> represents a bound on memory usage by the gRPC library. </p>
  90. <p>A <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory 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 used by all attached entities below the <a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory usage by the gRPC library. ">ResourceQuota</a> bound. </p>
  91. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  92. <a id="a5014fc19c5c5e8e6cdb8eb9c21a1f170"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#a5014fc19c5c5e8e6cdb8eb9c21a1f170">&#9670;&nbsp;</a></span>ResourceQuota() <span class="overload">[1/2]</span></h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="mlabels">
  97. <tr>
  98. <td class="mlabels-left">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">grpc::ResourceQuota::ResourceQuota </td>
  102. <td>(</td>
  103. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  104. <td class="paramname"><em>name</em></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </td>
  109. <td class="mlabels-right">
  110. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <dl class="params"><dt>Parameters</dt><dd>
  115. <table class="params">
  116. <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 usage by the gRPC library. ">ResourceQuota</a>. </td></tr>
  117. </table>
  118. </dd>
  119. </dl>
  120. </div>
  121. </div>
  122. <a id="a452006a82860143a83aefaf42ba2fb48"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#a452006a82860143a83aefaf42ba2fb48">&#9670;&nbsp;</a></span>ResourceQuota() <span class="overload">[2/2]</span></h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">grpc::ResourceQuota::ResourceQuota </td>
  129. <td>(</td>
  130. <td class="paramname"></td><td>)</td>
  131. <td></td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. </div>
  136. </div>
  137. <a id="ad398badd3b31871dce142e9ba18b45ce"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#ad398badd3b31871dce142e9ba18b45ce">&#9670;&nbsp;</a></span>~ResourceQuota()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">grpc::ResourceQuota::~ResourceQuota </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. </div>
  151. </div>
  152. <h2 class="groupheader">Member Function Documentation</h2>
  153. <a id="a1c8f03a21aba636ba5ed2504a0754085"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a1c8f03a21aba636ba5ed2504a0754085">&#9670;&nbsp;</a></span>c_resource_quota()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="grpc__types_8h.html#a16d58b8d7c93609d01311b869f4a8d05">grpc_resource_quota</a>* grpc::ResourceQuota::c_resource_quota </td>
  163. <td>(</td>
  164. <td class="paramname"></td><td>)</td>
  165. <td> const</td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <a id="a3e9034af4f310baa9bcc11ccfe46170f"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#a3e9034af4f310baa9bcc11ccfe46170f">&#9670;&nbsp;</a></span>Resize()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname"><a class="el" href="classgrpc_1_1_resource_quota.html">ResourceQuota</a>&amp; grpc::ResourceQuota::Resize </td>
  183. <td>(</td>
  184. <td class="paramtype">size_t&#160;</td>
  185. <td class="paramname"><em>new_size</em></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Resize this <em><a class="el" href="classgrpc_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory usage by the gRPC library. ">ResourceQuota</a></em> to a new size. </p>
  191. <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>
  192. </div>
  193. </div>
  194. <hr/>The documentation for this class was generated from the following file:<ul>
  195. <li>include/grpcpp/<a class="el" href="grpcpp_2resource__quota_8h_source.html">resource_quota.h</a></li>
  196. </ul>
  197. </div><!-- contents -->
  198. <!-- start footer part -->
  199. <hr class="footer"/><address class="footer"><small>
  200. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  201. <img class="footer" src="doxygen.png" alt="doxygen"/>
  202. </a> 1.8.13
  203. </small></address>
  204. </body>
  205. </html>