classgrpc__impl_1_1internal_1_1_rpc_method_handler.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc_impl::internal::RpcMethodHandler&lt; ServiceType, RequestType, ResponseType &gt; Class Template 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.30.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="namespacegrpc__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="namespacegrpc__impl_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">RpcMethodHandler</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc_impl::internal::RpcMethodHandler&lt; ServiceType, RequestType, ResponseType &gt; Class Template Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>A wrapper class of an application provided rpc method handler.
  74. <a href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2byte__buffer_8h_source.html">byte_buffer.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:a3da195171fabc1c8d08a49c3b58b4ab9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html#a3da195171fabc1c8d08a49c3b58b4ab9">RpcMethodHandler</a> (std::function&lt;::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>(ServiceType *, ::<a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> *, const RequestType *, ResponseType *)&gt; func, ServiceType *service)</td></tr>
  80. <tr class="separator:a3da195171fabc1c8d08a49c3b58b4ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a51ddb8547e61b025ab9060fce95517a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html#a51ddb8547e61b025ab9060fce95517a6">RunHandler</a> (const <a class="el" href="structgrpc_1_1internal_1_1_method_handler_1_1_handler_parameter.html">HandlerParameter</a> &amp;param) final</td></tr>
  82. <tr class="separator:a51ddb8547e61b025ab9060fce95517a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aba087a2c07eb2c86a80b17ff1ed2cd96"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html#aba087a2c07eb2c86a80b17ff1ed2cd96">Deserialize</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call, <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *req, ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void **) final</td></tr>
  84. <tr class="separator:aba087a2c07eb2c86a80b17ff1ed2cd96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_method_handler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_method_handler')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_method_handler.html">grpc::internal::MethodHandler</a></td></tr>
  86. <tr class="memitem:a6c9896af1ffd8b22d0bc197fbd946a33 inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_method_handler.html#a6c9896af1ffd8b22d0bc197fbd946a33">~MethodHandler</a> ()</td></tr>
  87. <tr class="separator:a6c9896af1ffd8b22d0bc197fbd946a33 inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ab2e06e37ecfe5f4dbdb200f8323995bd inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_method_handler.html#ab2e06e37ecfe5f4dbdb200f8323995bd">Deserialize</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *, <a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *req, <a class="el" href="classgrpc_1_1_status.html">Status</a> *, void **)</td></tr>
  89. <tr class="separator:ab2e06e37ecfe5f4dbdb200f8323995bd inherit pub_methods_classgrpc_1_1internal_1_1_method_handler"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><h3>template&lt;class ServiceType, class RequestType, class ResponseType&gt;<br />
  93. class grpc_impl::internal::RpcMethodHandler&lt; ServiceType, RequestType, ResponseType &gt;</h3>
  94. <p>A wrapper class of an application provided rpc method handler. </p>
  95. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  96. <a id="a3da195171fabc1c8d08a49c3b58b4ab9"></a>
  97. <h2 class="memtitle"><span class="permalink"><a href="#a3da195171fabc1c8d08a49c3b58b4ab9">&#9670;&nbsp;</a></span>RpcMethodHandler()</h2>
  98. <div class="memitem">
  99. <div class="memproto">
  100. <div class="memtemplate">
  101. template&lt;class ServiceType , class RequestType , class ResponseType &gt; </div>
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname"><a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">grpc_impl::internal::RpcMethodHandler</a>&lt; ServiceType, RequestType, ResponseType &gt;::<a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">RpcMethodHandler</a> </td>
  108. <td>(</td>
  109. <td class="paramtype">std::function&lt;::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>(ServiceType *, ::<a class="el" href="classgrpc__impl_1_1_server_context.html">grpc_impl::ServerContext</a> *, const RequestType *, ResponseType *)&gt;&#160;</td>
  110. <td class="paramname"><em>func</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">ServiceType *&#160;</td>
  116. <td class="paramname"><em>service</em>&#160;</td>
  117. </tr>
  118. <tr>
  119. <td></td>
  120. <td>)</td>
  121. <td></td><td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. </div>
  131. </div>
  132. <h2 class="groupheader">Member Function Documentation</h2>
  133. <a id="aba087a2c07eb2c86a80b17ff1ed2cd96"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#aba087a2c07eb2c86a80b17ff1ed2cd96">&#9670;&nbsp;</a></span>Deserialize()</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <div class="memtemplate">
  138. template&lt;class ServiceType , class RequestType , class ResponseType &gt; </div>
  139. <table class="mlabels">
  140. <tr>
  141. <td class="mlabels-left">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">void* <a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">grpc_impl::internal::RpcMethodHandler</a>&lt; ServiceType, RequestType, ResponseType &gt;::Deserialize </td>
  145. <td>(</td>
  146. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  147. <td class="paramname"><em>call</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;</td>
  153. <td class="paramname"><em>req</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *&#160;</td>
  159. <td class="paramname"><em>status</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">void **&#160;</td>
  165. <td class="paramname">&#160;</td>
  166. </tr>
  167. <tr>
  168. <td></td>
  169. <td>)</td>
  170. <td></td><td></td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. </div>
  180. </div>
  181. <a id="a51ddb8547e61b025ab9060fce95517a6"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a51ddb8547e61b025ab9060fce95517a6">&#9670;&nbsp;</a></span>RunHandler()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <div class="memtemplate">
  186. template&lt;class ServiceType , class RequestType , class ResponseType &gt; </div>
  187. <table class="mlabels">
  188. <tr>
  189. <td class="mlabels-left">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">void <a class="el" href="classgrpc__impl_1_1internal_1_1_rpc_method_handler.html">grpc_impl::internal::RpcMethodHandler</a>&lt; ServiceType, RequestType, ResponseType &gt;::RunHandler </td>
  193. <td>(</td>
  194. <td class="paramtype">const <a class="el" href="structgrpc_1_1internal_1_1_method_handler_1_1_handler_parameter.html">HandlerParameter</a> &amp;&#160;</td>
  195. <td class="paramname"><em>param</em></td><td>)</td>
  196. <td></td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_method_handler.html#a61b91173bcf71a512a80947a5413c6c6">grpc::internal::MethodHandler</a>.</p>
  206. </div>
  207. </div>
  208. <hr/>The documentation for this class was generated from the following files:<ul>
  209. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2byte__buffer_8h_source.html">byte_buffer.h</a></li>
  210. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2method__handler__impl_8h_source.html">method_handler_impl.h</a></li>
  211. </ul>
  212. </div><!-- contents -->
  213. <!-- start footer part -->
  214. <hr class="footer"/><address class="footer"><small>
  215. Generated on Tue Jun 30 2020 18:16:57 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  216. <img class="footer" src="doxygen.png" alt="doxygen"/>
  217. </a> 1.8.16
  218. </small></address>
  219. </body>
  220. </html>