classgrpc_1_1internal_1_1_rpc_method.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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.6"/>
  7. <title>GRPC C++: grpc::internal::RpcMethod 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/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.8.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</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. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></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="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>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-types">Public Types</a> &#124;
  92. <a href="#pub-methods">Public Member Functions</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::internal::RpcMethod Class Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <p>Descriptor of an RPC method.
  98. <a href="classgrpc_1_1internal_1_1_rpc_method.html#details">More...</a></p>
  99. <p><code>#include &lt;<a class="el" href="codegen_2rpc__method_8h_source.html">rpc_method.h</a>&gt;</code></p>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  102. Public Types</h2></td></tr>
  103. <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,
  104. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd">CLIENT_STREAMING</a>,
  105. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6">SERVER_STREAMING</a>,
  106. <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f">BIDI_STREAMING</a>
  107. }</td></tr>
  108. <tr class="separator:a40ce84e3569f6a327468ae59f04c7dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  111. Public Member Functions</h2></td></tr>
  112. <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#ab5c363c57d5d44be8cc3e15196d9c5a3">name</a>, <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> type)</td></tr>
  113. <tr class="separator:a1c13d569c84898f688b74958a4d7db49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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#ab5c363c57d5d44be8cc3e15196d9c5a3">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>
  115. <tr class="separator:a254b308ceaa38d17c99afb71f4fc1d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ab5c363c57d5d44be8cc3e15196d9c5a3"><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#ab5c363c57d5d44be8cc3e15196d9c5a3">name</a> () const </td></tr>
  117. <tr class="separator:ab5c363c57d5d44be8cc3e15196d9c5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:aad94fa08736ea497fe39ecbb4f3cafce"><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#aad94fa08736ea497fe39ecbb4f3cafce">method_type</a> () const </td></tr>
  119. <tr class="separator:aad94fa08736ea497fe39ecbb4f3cafce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a3d84cbcc47861ba127f053bb9590ff1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a6d28f6023ade45d4557bcdec30f5d869"><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#a6d28f6023ade45d4557bcdec30f5d869">channel_tag</a> () const </td></tr>
  123. <tr class="separator:a6d28f6023ade45d4557bcdec30f5d869"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p>Descriptor of an RPC method. </p>
  127. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  128. <a class="anchor" id="a40ce84e3569f6a327468ae59f04c7dd1"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">enum <a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">grpc::internal::RpcMethod::RpcType</a></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <table class="fieldtable">
  138. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a40ce84e3569f6a327468ae59f04c7dd1a73dbd8998b4364e284ade7c00a57ec37"></a>NORMAL_RPC</em>&#160;</td><td class="fielddoc">
  139. </td></tr>
  140. <tr><td class="fieldname"><em><a class="anchor" id="a40ce84e3569f6a327468ae59f04c7dd1a4138c4a820e1b96d502f32548e88d3fd"></a>CLIENT_STREAMING</em>&#160;</td><td class="fielddoc">
  141. </td></tr>
  142. <tr><td class="fieldname"><em><a class="anchor" id="a40ce84e3569f6a327468ae59f04c7dd1a3b3eb41de854898c2481fb454fc8e2f6"></a>SERVER_STREAMING</em>&#160;</td><td class="fielddoc">
  143. </td></tr>
  144. <tr><td class="fieldname"><em><a class="anchor" id="a40ce84e3569f6a327468ae59f04c7dd1a8308d189db6d81509042a321ac91b00f"></a>BIDI_STREAMING</em>&#160;</td><td class="fielddoc">
  145. </td></tr>
  146. </table>
  147. </div>
  148. </div>
  149. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  150. <a class="anchor" id="a1c13d569c84898f688b74958a4d7db49"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="mlabels">
  154. <tr>
  155. <td class="mlabels-left">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">grpc::internal::RpcMethod::RpcMethod </td>
  159. <td>(</td>
  160. <td class="paramtype">const char *&#160;</td>
  161. <td class="paramname"><em>name</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  167. <td class="paramname"><em>type</em>&#160;</td>
  168. </tr>
  169. <tr>
  170. <td></td>
  171. <td>)</td>
  172. <td></td><td></td>
  173. </tr>
  174. </table>
  175. </td>
  176. <td class="mlabels-right">
  177. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. </div>
  182. </div>
  183. <a class="anchor" id="a254b308ceaa38d17c99afb71f4fc1d73"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="mlabels">
  187. <tr>
  188. <td class="mlabels-left">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">grpc::internal::RpcMethod::RpcMethod </td>
  192. <td>(</td>
  193. <td class="paramtype">const char *&#160;</td>
  194. <td class="paramname"><em>name</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  200. <td class="paramname"><em>type</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> &gt; &amp;&#160;</td>
  206. <td class="paramname"><em>channel</em>&#160;</td>
  207. </tr>
  208. <tr>
  209. <td></td>
  210. <td>)</td>
  211. <td></td><td></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. <h2 class="groupheader">Member Function Documentation</h2>
  223. <a class="anchor" id="a6d28f6023ade45d4557bcdec30f5d869"></a>
  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">void* grpc::internal::RpcMethod::channel_tag </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 class="anchor" id="aad94fa08736ea497fe39ecbb4f3cafce"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a> grpc::internal::RpcMethod::method_type </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td> const</td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. </div>
  266. </div>
  267. <a class="anchor" id="ab5c363c57d5d44be8cc3e15196d9c5a3"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="mlabels">
  271. <tr>
  272. <td class="mlabels-left">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">const char* grpc::internal::RpcMethod::name </td>
  276. <td>(</td>
  277. <td class="paramname"></td><td>)</td>
  278. <td> const</td>
  279. </tr>
  280. </table>
  281. </td>
  282. <td class="mlabels-right">
  283. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. </div>
  288. </div>
  289. <a class="anchor" id="a3d84cbcc47861ba127f053bb9590ff1f"></a>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="mlabels">
  293. <tr>
  294. <td class="mlabels-left">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void grpc::internal::RpcMethod::SetMethodType </td>
  298. <td>(</td>
  299. <td class="paramtype"><a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html#a40ce84e3569f6a327468ae59f04c7dd1">RpcType</a>&#160;</td>
  300. <td class="paramname"><em>type</em></td><td>)</td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </td>
  305. <td class="mlabels-right">
  306. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. </div>
  311. </div>
  312. <hr/>The documentation for this class was generated from the following file:<ul>
  313. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2rpc__method_8h_source.html">rpc_method.h</a></li>
  314. </ul>
  315. </div><!-- contents -->
  316. <!-- start footer part -->
  317. <hr class="footer"/><address class="footer"><small>
  318. Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  319. <img class="footer" src="doxygen.png" alt="doxygen"/>
  320. </a> 1.8.6
  321. </small></address>
  322. </body>
  323. </html>