classgrpc__impl_1_1_server_context.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  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_impl::ServerContext 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. </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.26.0</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_server_context.html">ServerContext</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> &#124;
  66. <a href="#friends">Friends</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc_impl::ServerContext Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>A <a class="el" href="classgrpc__impl_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to: ...">ServerContext</a> or <a class="el" href="classgrpc__impl_1_1_callback_server_context.html">CallbackServerContext</a> allows the code implementing a service handler to:
  72. <a href="classgrpc__impl_1_1_server_context.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="server__context__impl_8h_source.html">server_context_impl.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a6c2fd97db3225c4d2a6871bad3d3ea4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context.html#a6c2fd97db3225c4d2a6871bad3d3ea4b">ServerContext</a> ()</td></tr>
  78. <tr class="separator:a6c2fd97db3225c4d2a6871bad3d3ea4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="inherit_header pub_methods_classgrpc__impl_1_1_server_context_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1_server_context_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1_server_context_base.html">grpc_impl::ServerContextBase</a></td></tr>
  80. <tr class="memitem:a8003b9060961b7df12faa949c21f55cf inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a8003b9060961b7df12faa949c21f55cf">~ServerContextBase</a> ()</td></tr>
  81. <tr class="separator:a8003b9060961b7df12faa949c21f55cf inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a744be5eb26c86367a7b1b992a80c1c8c inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a744be5eb26c86367a7b1b992a80c1c8c">deadline</a> () const</td></tr>
  83. <tr class="memdesc:a744be5eb26c86367a7b1b992a80c1c8c inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the deadline for the server call. <a href="classgrpc__impl_1_1_server_context_base.html#a744be5eb26c86367a7b1b992a80c1c8c">More...</a><br /></td></tr>
  84. <tr class="separator:a744be5eb26c86367a7b1b992a80c1c8c inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a73b960be3567cad8d8e75261c229ad72 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a73b960be3567cad8d8e75261c229ad72">raw_deadline</a> () const</td></tr>
  86. <tr class="memdesc:a73b960be3567cad8d8e75261c229ad72 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <em><a class="el" href="structgpr__timespec.html" title="Analogous to struct timespec. ">gpr_timespec</a></em> representation of the server call's deadline. <a href="classgrpc__impl_1_1_server_context_base.html#a73b960be3567cad8d8e75261c229ad72">More...</a><br /></td></tr>
  87. <tr class="separator:a73b960be3567cad8d8e75261c229ad72 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aa951eb952cf449662de65646d3b53799 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#aa951eb952cf449662de65646d3b53799">AddInitialMetadata</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;value)</td></tr>
  89. <tr class="memdesc:aa951eb952cf449662de65646d3b53799 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc__impl_1_1_server_context_base.html#aa951eb952cf449662de65646d3b53799">More...</a><br /></td></tr>
  90. <tr class="separator:aa951eb952cf449662de65646d3b53799 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a7b70b6c9d8f5dc9ce95e18e95b9fb861 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a7b70b6c9d8f5dc9ce95e18e95b9fb861">AddTrailingMetadata</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;value)</td></tr>
  92. <tr class="memdesc:a7b70b6c9d8f5dc9ce95e18e95b9fb861 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc__impl_1_1_server_context_base.html#a7b70b6c9d8f5dc9ce95e18e95b9fb861">More...</a><br /></td></tr>
  93. <tr class="separator:a7b70b6c9d8f5dc9ce95e18e95b9fb861 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a8cddeac523cbcfb67113bfd39b70c148 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a8cddeac523cbcfb67113bfd39b70c148">IsCancelled</a> () const</td></tr>
  95. <tr class="memdesc:a8cddeac523cbcfb67113bfd39b70c148 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsCancelled is always safe to call when using sync or callback API. <a href="classgrpc__impl_1_1_server_context_base.html#a8cddeac523cbcfb67113bfd39b70c148">More...</a><br /></td></tr>
  96. <tr class="separator:a8cddeac523cbcfb67113bfd39b70c148 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a6a7eb157b51f12e9b36c2ebf4849d8b8 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a6a7eb157b51f12e9b36c2ebf4849d8b8">TryCancel</a> () const</td></tr>
  98. <tr class="memdesc:a6a7eb157b51f12e9b36c2ebf4849d8b8 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the Call from the server. <a href="classgrpc__impl_1_1_server_context_base.html#a6a7eb157b51f12e9b36c2ebf4849d8b8">More...</a><br /></td></tr>
  99. <tr class="separator:a6a7eb157b51f12e9b36c2ebf4849d8b8 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:adf56f90c19120ce0885bc97348a6e604 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">const std::multimap&lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#adf56f90c19120ce0885bc97348a6e604">client_metadata</a> () const</td></tr>
  101. <tr class="memdesc:adf56f90c19120ce0885bc97348a6e604 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a collection of initial metadata key-value pairs sent from the client. <a href="classgrpc__impl_1_1_server_context_base.html#adf56f90c19120ce0885bc97348a6e604">More...</a><br /></td></tr>
  102. <tr class="separator:adf56f90c19120ce0885bc97348a6e604 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:af1269faf8ade6276e856082c382413bb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#af1269faf8ade6276e856082c382413bb">compression_level</a> () const</td></tr>
  104. <tr class="memdesc:af1269faf8ade6276e856082c382413bb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the compression algorithm to be used by the server call. <a href="classgrpc__impl_1_1_server_context_base.html#af1269faf8ade6276e856082c382413bb">More...</a><br /></td></tr>
  105. <tr class="separator:af1269faf8ade6276e856082c382413bb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:aa029ac26886b5f2c2171fc94a6be43d2 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#aa029ac26886b5f2c2171fc94a6be43d2">set_compression_level</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr>
  107. <tr class="memdesc:aa029ac26886b5f2c2171fc94a6be43d2 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <em>level</em> to be the compression level used for the server call. <a href="classgrpc__impl_1_1_server_context_base.html#aa029ac26886b5f2c2171fc94a6be43d2">More...</a><br /></td></tr>
  108. <tr class="separator:aa029ac26886b5f2c2171fc94a6be43d2 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ab5d5441203d8817484cd3d68bcb53167 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#ab5d5441203d8817484cd3d68bcb53167">compression_level_set</a> () const</td></tr>
  110. <tr class="memdesc:ab5d5441203d8817484cd3d68bcb53167 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a bool indicating whether the compression level for this call has been set (either implicitly or through a previous call to <em>set_compression_level</em>. <a href="classgrpc__impl_1_1_server_context_base.html#ab5d5441203d8817484cd3d68bcb53167">More...</a><br /></td></tr>
  111. <tr class="separator:ab5d5441203d8817484cd3d68bcb53167 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a4c6a3e5aae2f5e7967903529b56c52c9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a4c6a3e5aae2f5e7967903529b56c52c9">compression_algorithm</a> () const</td></tr>
  113. <tr class="memdesc:a4c6a3e5aae2f5e7967903529b56c52c9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the compression algorithm the server call will request be used. <a href="classgrpc__impl_1_1_server_context_base.html#a4c6a3e5aae2f5e7967903529b56c52c9">More...</a><br /></td></tr>
  114. <tr class="separator:a4c6a3e5aae2f5e7967903529b56c52c9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ab04f5ba85b5f5b0c90eca93998091361 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#ab04f5ba85b5f5b0c90eca93998091361">set_compression_algorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  116. <tr class="memdesc:ab04f5ba85b5f5b0c90eca93998091361 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the server call. <a href="classgrpc__impl_1_1_server_context_base.html#ab04f5ba85b5f5b0c90eca93998091361">More...</a><br /></td></tr>
  117. <tr class="separator:ab04f5ba85b5f5b0c90eca93998091361 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a9780f1190bab12697d72eb44be722df9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a9780f1190bab12697d72eb44be722df9">SetLoadReportingCosts</a> (const std::vector&lt; <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &gt; &amp;cost_data)</td></tr>
  119. <tr class="memdesc:a9780f1190bab12697d72eb44be722df9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the serialized load reporting costs in <em>cost_data</em> for the call. <a href="classgrpc__impl_1_1_server_context_base.html#a9780f1190bab12697d72eb44be722df9">More...</a><br /></td></tr>
  120. <tr class="separator:a9780f1190bab12697d72eb44be722df9 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ab5d856fd54c832abb4b0e80858be55eb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const ::<a class="el" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#ab5d856fd54c832abb4b0e80858be55eb">auth_context</a> () const</td></tr>
  122. <tr class="memdesc:ab5d856fd54c832abb4b0e80858be55eb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the authentication context for this server call. <a href="classgrpc__impl_1_1_server_context_base.html#ab5d856fd54c832abb4b0e80858be55eb">More...</a><br /></td></tr>
  123. <tr class="separator:ab5d856fd54c832abb4b0e80858be55eb inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a4818906c2d69c386160d04300dbe10d1 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a4818906c2d69c386160d04300dbe10d1">peer</a> () const</td></tr>
  125. <tr class="memdesc:a4818906c2d69c386160d04300dbe10d1 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the peer uri in a string. <a href="classgrpc__impl_1_1_server_context_base.html#a4818906c2d69c386160d04300dbe10d1">More...</a><br /></td></tr>
  126. <tr class="separator:a4818906c2d69c386160d04300dbe10d1 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a13b08964c84f404198361cf0f2df6a44 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">const struct census_context *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a13b08964c84f404198361cf0f2df6a44">census_context</a> () const</td></tr>
  128. <tr class="memdesc:a13b08964c84f404198361cf0f2df6a44 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the census context associated with this server call. <a href="classgrpc__impl_1_1_server_context_base.html#a13b08964c84f404198361cf0f2df6a44">More...</a><br /></td></tr>
  129. <tr class="separator:a13b08964c84f404198361cf0f2df6a44 inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a4c0a9b6de6e9fa91577f8c30720100be inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a4c0a9b6de6e9fa91577f8c30720100be">c_call</a> ()</td></tr>
  131. <tr class="memdesc:a4c0a9b6de6e9fa91577f8c30720100be inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be used for framework-level extensions only. <a href="classgrpc__impl_1_1_server_context_base.html#a4c0a9b6de6e9fa91577f8c30720100be">More...</a><br /></td></tr>
  132. <tr class="separator:a4c0a9b6de6e9fa91577f8c30720100be inherit pub_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  135. Friends</h2></td></tr>
  136. <tr class="memitem:a3e6ceb26728f815024f4e836b9ffd56f"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context.html#a3e6ceb26728f815024f4e836b9ffd56f">::grpc_impl::Server</a></td></tr>
  137. <tr class="separator:a3e6ceb26728f815024f4e836b9ffd56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table><table class="memberdecls">
  139. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  140. Additional Inherited Members</h2></td></tr>
  141. <tr class="inherit_header pro_methods_classgrpc__impl_1_1_server_context_base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc__impl_1_1_server_context_base')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc__impl_1_1_server_context_base.html">grpc_impl::ServerContextBase</a></td></tr>
  142. <tr class="memitem:a0f1289f31257e6dbef57bc901bd7b5f2 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a0f1289f31257e6dbef57bc901bd7b5f2">AsyncNotifyWhenDone</a> (void *tag)</td></tr>
  143. <tr class="memdesc:a0f1289f31257e6dbef57bc901bd7b5f2 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Async only. <a href="classgrpc__impl_1_1_server_context_base.html#a0f1289f31257e6dbef57bc901bd7b5f2">More...</a><br /></td></tr>
  144. <tr class="separator:a0f1289f31257e6dbef57bc901bd7b5f2 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ac4d686bfd7f6704b21988cb5ae620c6a inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classgrpc_1_1experimental_1_1_rpc_allocator_state.html">grpc::experimental::RpcAllocatorState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#ac4d686bfd7f6704b21988cb5ae620c6a">GetRpcAllocatorState</a> ()</td></tr>
  146. <tr class="memdesc:ac4d686bfd7f6704b21988cb5ae620c6a inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">NOTE: This is an API for advanced users who need custom allocators. <a href="classgrpc__impl_1_1_server_context_base.html#ac4d686bfd7f6704b21988cb5ae620c6a">More...</a><br /></td></tr>
  147. <tr class="separator:ac4d686bfd7f6704b21988cb5ae620c6a inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a90dedbcb860ba09533908bf69e3700f8 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classgrpc__impl_1_1_server_unary_reactor.html">grpc_impl::ServerUnaryReactor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a90dedbcb860ba09533908bf69e3700f8">DefaultReactor</a> ()</td></tr>
  149. <tr class="memdesc:a90dedbcb860ba09533908bf69e3700f8 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a library-owned default unary reactor for use in minimal reaction cases. <a href="classgrpc__impl_1_1_server_context_base.html#a90dedbcb860ba09533908bf69e3700f8">More...</a><br /></td></tr>
  150. <tr class="separator:a90dedbcb860ba09533908bf69e3700f8 inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:adb4a6d4c558fe72da4e2403dc525b4ec inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#adb4a6d4c558fe72da4e2403dc525b4ec">ServerContextBase</a> ()</td></tr>
  152. <tr class="memdesc:adb4a6d4c558fe72da4e2403dc525b4ec inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructors for use by derived classes. <a href="classgrpc__impl_1_1_server_context_base.html#adb4a6d4c558fe72da4e2403dc525b4ec">More...</a><br /></td></tr>
  153. <tr class="separator:adb4a6d4c558fe72da4e2403dc525b4ec inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a035fcaa4ca30227e320b8f2053ddaefc inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context_base.html#a035fcaa4ca30227e320b8f2053ddaefc">ServerContextBase</a> (<a class="el" href="structgpr__timespec.html">gpr_timespec</a> <a class="el" href="classgrpc__impl_1_1_server_context_base.html#a744be5eb26c86367a7b1b992a80c1c8c">deadline</a>, <a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a> *arr)</td></tr>
  155. <tr class="separator:a035fcaa4ca30227e320b8f2053ddaefc inherit pro_methods_classgrpc__impl_1_1_server_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table>
  157. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  158. <div class="textblock"><p>A <a class="el" href="classgrpc__impl_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to: ...">ServerContext</a> or <a class="el" href="classgrpc__impl_1_1_callback_server_context.html">CallbackServerContext</a> allows the code implementing a service handler to: </p>
  159. <ul>
  160. <li>Add custom initial and trailing metadata key-value pairs that will propagated to the client side.</li>
  161. <li>Control call settings such as compression and authentication.</li>
  162. <li>Access metadata coming from the client.</li>
  163. <li>Get performance metrics (ie, census).</li>
  164. </ul>
  165. <p>Context settings are only relevant to the call handler they are supplied to, that is to say, they aren't sticky across multiple calls. Some of these settings, such as the compression options, can be made persistent at server construction time by specifying the appropriate <em><a class="el" href="classgrpc__impl_1_1_channel_arguments.html" title="Options for channel creation. ">ChannelArguments</a></em> to a <em><a class="el" href="namespacegrpc.html#a7b50d12b234e25308abf40024b860737">grpc::ServerBuilder</a></em>, via <em><a class="el" href="classgrpc__impl_1_1_server_builder.html#ad2ed9b377fb7395b8d79de33aeb66723" title="Add a channel argument (an escape hatch to tuning core library parameters directly) ...">ServerBuilder::AddChannelArgument</a></em>.</p>
  166. <dl class="section warning"><dt>Warning</dt><dd><a class="el" href="classgrpc__impl_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to: ...">ServerContext</a> instances should <em>not</em> be reused across rpcs. </dd></dl>
  167. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  168. <a id="a6c2fd97db3225c4d2a6871bad3d3ea4b"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#a6c2fd97db3225c4d2a6871bad3d3ea4b">&#9670;&nbsp;</a></span>ServerContext()</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">grpc_impl::ServerContext::ServerContext </td>
  178. <td>(</td>
  179. <td class="paramname"></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </td>
  184. <td class="mlabels-right">
  185. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. </div>
  190. </div>
  191. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  192. <a id="a3e6ceb26728f815024f4e836b9ffd56f"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a3e6ceb26728f815024f4e836b9ffd56f">&#9670;&nbsp;</a></span>::grpc_impl::Server</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">friend class ::<a class="el" href="classgrpc__impl_1_1_server.html">grpc_impl::Server</a></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <hr/>The documentation for this class was generated from the following file:<ul>
  213. <li>include/grpcpp/impl/codegen/<a class="el" href="server__context__impl_8h_source.html">server_context_impl.h</a></li>
  214. </ul>
  215. </div><!-- contents -->
  216. <!-- start footer part -->
  217. <hr class="footer"/><address class="footer"><small>
  218. Generated on Wed Dec 18 2019 17:23:07 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  219. <img class="footer" src="doxygen.png" alt="doxygen"/>
  220. </a> 1.8.13
  221. </small></address>
  222. </body>
  223. </html>