classgrpc_1_1_rpc_service_method.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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.11"/>
  7. <title>GRPC C++: grpc::RpcServiceMethod Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_rpc_service_method.html">RpcServiceMethod</a></li> </ul>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::RpcServiceMethod Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="codegen_2rpc__service__method_8h_source.html">rpc_service_method.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:a9a4a54d93c2c5d2b5b52ff50af5971da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_service_method.html#a9a4a54d93c2c5d2b5b52ff50af5971da">RpcServiceMethod</a> (const char *<a class="el" href="classgrpc_1_1_rpc_method.html#a6fb4872e0af4c79faffe2bb30b2cafe3">name</a>, <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcMethod::RpcType</a> type, <a class="el" href="classgrpc_1_1_method_handler.html">MethodHandler</a> *<a class="el" href="classgrpc_1_1_rpc_service_method.html#a972ffd5505eece067968773b39aa76eb">handler</a>)</td></tr>
  101. <tr class="separator:a9a4a54d93c2c5d2b5b52ff50af5971da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:adaac8ae1916d1828fd6792e88e9dc206"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_service_method.html#adaac8ae1916d1828fd6792e88e9dc206">set_server_tag</a> (void *tag)</td></tr>
  103. <tr class="separator:adaac8ae1916d1828fd6792e88e9dc206"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a55a18bd91dd4c800e26ea3a92b5bc64d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_service_method.html#a55a18bd91dd4c800e26ea3a92b5bc64d">server_tag</a> () const </td></tr>
  105. <tr class="separator:a55a18bd91dd4c800e26ea3a92b5bc64d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a972ffd5505eece067968773b39aa76eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_method_handler.html">MethodHandler</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_service_method.html#a972ffd5505eece067968773b39aa76eb">handler</a> () const </td></tr>
  107. <tr class="separator:a972ffd5505eece067968773b39aa76eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a6ee8cb024290c0be6905ca2390e5ecbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_service_method.html#a6ee8cb024290c0be6905ca2390e5ecbd">ResetHandler</a> ()</td></tr>
  109. <tr class="separator:a6ee8cb024290c0be6905ca2390e5ecbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pub_methods_classgrpc_1_1_rpc_method"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_rpc_method')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_rpc_method.html">grpc::RpcMethod</a></td></tr>
  111. <tr class="memitem:a06b42037718cf822a4b30d14668613f0 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#a06b42037718cf822a4b30d14668613f0">RpcMethod</a> (const char *<a class="el" href="classgrpc_1_1_rpc_method.html#a6fb4872e0af4c79faffe2bb30b2cafe3">name</a>, <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a> type)</td></tr>
  112. <tr class="separator:a06b42037718cf822a4b30d14668613f0 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:af4be4b97022138385987eae380de5ddd inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#af4be4b97022138385987eae380de5ddd">RpcMethod</a> (const char *<a class="el" href="classgrpc_1_1_rpc_method.html#a6fb4872e0af4c79faffe2bb30b2cafe3">name</a>, <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a> type, const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> &gt; &amp;channel)</td></tr>
  114. <tr class="separator:af4be4b97022138385987eae380de5ddd inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a6fb4872e0af4c79faffe2bb30b2cafe3 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#a6fb4872e0af4c79faffe2bb30b2cafe3">name</a> () const </td></tr>
  116. <tr class="separator:a6fb4872e0af4c79faffe2bb30b2cafe3 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a1de5a64a1e57b5938c4733f9152291b6 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#a1de5a64a1e57b5938c4733f9152291b6">method_type</a> () const </td></tr>
  118. <tr class="separator:a1de5a64a1e57b5938c4733f9152291b6 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a59527e676d274583ec6961fb3f4356b3 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#a59527e676d274583ec6961fb3f4356b3">channel_tag</a> () const </td></tr>
  120. <tr class="separator:a59527e676d274583ec6961fb3f4356b3 inherit pub_methods_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  123. Additional Inherited Members</h2></td></tr>
  124. <tr class="inherit_header pub_types_classgrpc_1_1_rpc_method"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classgrpc_1_1_rpc_method')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classgrpc_1_1_rpc_method.html">grpc::RpcMethod</a></td></tr>
  125. <tr class="memitem:ace95416ed07409e43059a0dfe9e23688 inherit pub_types_classgrpc_1_1_rpc_method"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a> { <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688a8f7dac3c5cdbdbb204e3d3dbab033c2e">NORMAL_RPC</a> = 0,
  126. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688a93445bd936c37c2f089f8a9075ebcb2a">CLIENT_STREAMING</a>,
  127. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688a86f700048be78a1204139f70912f7775">SERVER_STREAMING</a>,
  128. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688ae482ab481fdc406d88adcdd088269894">BIDI_STREAMING</a>
  129. }</td></tr>
  130. <tr class="separator:ace95416ed07409e43059a0dfe9e23688 inherit pub_types_classgrpc_1_1_rpc_method"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  133. <a class="anchor" id="a9a4a54d93c2c5d2b5b52ff50af5971da"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">grpc::RpcServiceMethod::RpcServiceMethod </td>
  142. <td>(</td>
  143. <td class="paramtype">const char *&#160;</td>
  144. <td class="paramname"><em>name</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcMethod::RpcType</a>&#160;</td>
  150. <td class="paramname"><em>type</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype"><a class="el" href="classgrpc_1_1_method_handler.html">MethodHandler</a> *&#160;</td>
  156. <td class="paramname"><em>handler</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </td>
  165. <td class="mlabels-right">
  166. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. </div>
  171. </div>
  172. <h2 class="groupheader">Member Function Documentation</h2>
  173. <a class="anchor" id="a972ffd5505eece067968773b39aa76eb"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="mlabels">
  177. <tr>
  178. <td class="mlabels-left">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="classgrpc_1_1_method_handler.html">MethodHandler</a>* grpc::RpcServiceMethod::handler </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td> const</td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <a class="anchor" id="a6ee8cb024290c0be6905ca2390e5ecbd"></a>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void grpc::RpcServiceMethod::ResetHandler </td>
  204. <td>(</td>
  205. <td class="paramname"></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </td>
  210. <td class="mlabels-right">
  211. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. </div>
  216. </div>
  217. <a class="anchor" id="a55a18bd91dd4c800e26ea3a92b5bc64d"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">void* grpc::RpcServiceMethod::server_tag </td>
  226. <td>(</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td> const</td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a class="anchor" id="adaac8ae1916d1828fd6792e88e9dc206"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="mlabels">
  243. <tr>
  244. <td class="mlabels-left">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">void grpc::RpcServiceMethod::set_server_tag </td>
  248. <td>(</td>
  249. <td class="paramtype">void *&#160;</td>
  250. <td class="paramname"><em>tag</em></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </td>
  255. <td class="mlabels-right">
  256. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. </div>
  261. </div>
  262. <hr/>The documentation for this class was generated from the following file:<ul>
  263. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2rpc__service__method_8h_source.html">rpc_service_method.h</a></li>
  264. </ul>
  265. </div><!-- contents -->
  266. <!-- start footer part -->
  267. <hr class="footer"/><address class="footer"><small>
  268. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  269. <img class="footer" src="doxygen.png" alt="doxygen"/>
  270. </a> 1.8.11
  271. </small></address>
  272. </body>
  273. </html>