classgrpc_1_1internal_1_1_rpc_method.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::internal::RpcMethod 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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  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.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html">RpcMethod</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-types">Public Types</a> &#124;
  69. <a href="#pub-methods">Public Member Functions</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::internal::RpcMethod Class Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Descriptor of an RPC method.
  75. <a href="classgrpc_1_1internal_1_1_rpc_method.html#details">More...</a></p>
  76. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2rpc__method_8h_source.html">rpc_method.h</a>&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  79. Public Types</h2></td></tr>
  80. <tr class="memitem:a40ce84e3569f6a327468ae59f04c7dd1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> { <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37">NORMAL_RPC</a> = 0,
  81. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd">CLIENT_STREAMING</a>,
  82. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6">SERVER_STREAMING</a>,
  83. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f">BIDI_STREAMING</a>
  84. }</td></tr>
  85. <tr class="separator:a40ce84e3569f6a327468ae59f04c7dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  88. Public Member Functions</h2></td></tr>
  89. <tr class="memitem:a1c13d569c84898f688b74958a4d7db49"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a1c13d569c84898f688b74958a4d7db49">RpcMethod</a> (const char *<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a>, <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type)</td></tr>
  90. <tr class="separator:a1c13d569c84898f688b74958a4d7db49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a254b308ceaa38d17c99afb71f4fc1d73"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a254b308ceaa38d17c99afb71f4fc1d73">RpcMethod</a> (const char *<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a>, <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">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>
  92. <tr class="separator:a254b308ceaa38d17c99afb71f4fc1d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:aa3d98227a1a0481308de6bc398163713"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#aa3d98227a1a0481308de6bc398163713">name</a> () const</td></tr>
  94. <tr class="separator:aa3d98227a1a0481308de6bc398163713"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:abaf8f616c3d919da6dffc182d39a8d74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#abaf8f616c3d919da6dffc182d39a8d74">method_type</a> () const</td></tr>
  96. <tr class="separator:abaf8f616c3d919da6dffc182d39a8d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a3d84cbcc47861ba127f053bb9590ff1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a3d84cbcc47861ba127f053bb9590ff1f">SetMethodType</a> (<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type)</td></tr>
  98. <tr class="separator:a3d84cbcc47861ba127f053bb9590ff1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a32ba89bda8a4242ff6e18f66d84d671d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a32ba89bda8a4242ff6e18f66d84d671d">channel_tag</a> () const</td></tr>
  100. <tr class="separator:a32ba89bda8a4242ff6e18f66d84d671d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table>
  102. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  103. <div class="textblock"><p>Descriptor of an RPC method. </p>
  104. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  105. <a id="a40ce84e3569f6a327468ae59f04c7dd1"></a>
  106. <h2 class="memtitle"><span class="permalink"><a href="#a40ce84e3569f6a327468ae59f04c7dd1">&#9670;&nbsp;</a></span>RpcType</h2>
  107. <div class="memitem">
  108. <div class="memproto">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">enum <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">grpc::internal::RpcMethod::RpcType</a></td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. <table class="fieldtable">
  116. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37"></a>NORMAL_RPC&#160;</td><td class="fielddoc"></td></tr>
  117. <tr><td class="fieldname"><a id="a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd"></a>CLIENT_STREAMING&#160;</td><td class="fielddoc"></td></tr>
  118. <tr><td class="fieldname"><a id="a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6"></a>SERVER_STREAMING&#160;</td><td class="fielddoc"></td></tr>
  119. <tr><td class="fieldname"><a id="a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f"></a>BIDI_STREAMING&#160;</td><td class="fielddoc"></td></tr>
  120. </table>
  121. </div>
  122. </div>
  123. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  124. <a id="a1c13d569c84898f688b74958a4d7db49"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a1c13d569c84898f688b74958a4d7db49">&#9670;&nbsp;</a></span>RpcMethod() <span class="overload">[1/2]</span></h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="mlabels">
  129. <tr>
  130. <td class="mlabels-left">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">grpc::internal::RpcMethod::RpcMethod </td>
  134. <td>(</td>
  135. <td class="paramtype">const char *&#160;</td>
  136. <td class="paramname"><em>name</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  142. <td class="paramname"><em>type</em>&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. </div>
  157. </div>
  158. <a id="a254b308ceaa38d17c99afb71f4fc1d73"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#a254b308ceaa38d17c99afb71f4fc1d73">&#9670;&nbsp;</a></span>RpcMethod() <span class="overload">[2/2]</span></h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="mlabels">
  163. <tr>
  164. <td class="mlabels-left">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">grpc::internal::RpcMethod::RpcMethod </td>
  168. <td>(</td>
  169. <td class="paramtype">const char *&#160;</td>
  170. <td class="paramname"><em>name</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  176. <td class="paramname"><em>type</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> &gt; &amp;&#160;</td>
  182. <td class="paramname"><em>channel</em>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <h2 class="groupheader">Member Function Documentation</h2>
  199. <a id="a32ba89bda8a4242ff6e18f66d84d671d"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#a32ba89bda8a4242ff6e18f66d84d671d">&#9670;&nbsp;</a></span>channel_tag()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">void* grpc::internal::RpcMethod::channel_tag </td>
  209. <td>(</td>
  210. <td class="paramname"></td><td>)</td>
  211. <td> const</td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. </div>
  221. </div>
  222. <a id="abaf8f616c3d919da6dffc182d39a8d74"></a>
  223. <h2 class="memtitle"><span class="permalink"><a href="#abaf8f616c3d919da6dffc182d39a8d74">&#9670;&nbsp;</a></span>method_type()</h2>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="mlabels">
  227. <tr>
  228. <td class="mlabels-left">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> grpc::internal::RpcMethod::method_type </td>
  232. <td>(</td>
  233. <td class="paramname"></td><td>)</td>
  234. <td> const</td>
  235. </tr>
  236. </table>
  237. </td>
  238. <td class="mlabels-right">
  239. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. </div>
  244. </div>
  245. <a id="aa3d98227a1a0481308de6bc398163713"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#aa3d98227a1a0481308de6bc398163713">&#9670;&nbsp;</a></span>name()</h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="mlabels">
  250. <tr>
  251. <td class="mlabels-left">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">const char* grpc::internal::RpcMethod::name </td>
  255. <td>(</td>
  256. <td class="paramname"></td><td>)</td>
  257. <td> const</td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. </div>
  267. </div>
  268. <a id="a3d84cbcc47861ba127f053bb9590ff1f"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#a3d84cbcc47861ba127f053bb9590ff1f">&#9670;&nbsp;</a></span>SetMethodType()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="mlabels">
  273. <tr>
  274. <td class="mlabels-left">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname">void grpc::internal::RpcMethod::SetMethodType </td>
  278. <td>(</td>
  279. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  280. <td class="paramname"><em>type</em></td><td>)</td>
  281. <td></td>
  282. </tr>
  283. </table>
  284. </td>
  285. <td class="mlabels-right">
  286. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. </div>
  291. </div>
  292. <hr/>The documentation for this class was generated from the following file:<ul>
  293. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2rpc__method_8h_source.html">rpc_method.h</a></li>
  294. </ul>
  295. </div><!-- contents -->
  296. <!-- start footer part -->
  297. <hr class="footer"/><address class="footer"><small>
  298. Generated on Wed Mar 3 2021 19:17:26 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  299. <img class="footer" src="doxygen.png" alt="doxygen"/>
  300. </a> 1.8.17
  301. </small></address>
  302. </body>
  303. </html>