classgrpc_1_1_rpc_method.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  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::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.3.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="classgrpc_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::RpcMethod Class Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <p><code>#include &lt;<a class="el" href="codegen_2rpc__method_8h_source.html">rpc_method.h</a>&gt;</code></p>
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  100. Public Types</h2></td></tr>
  101. <tr class="memitem:ace95416ed07409e43059a0dfe9e23688"><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,
  102. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688a93445bd936c37c2f089f8a9075ebcb2a">CLIENT_STREAMING</a>,
  103. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688a86f700048be78a1204139f70912f7775">SERVER_STREAMING</a>,
  104. <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688ae482ab481fdc406d88adcdd088269894">BIDI_STREAMING</a>
  105. }</td></tr>
  106. <tr class="separator:ace95416ed07409e43059a0dfe9e23688"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  109. Public Member Functions</h2></td></tr>
  110. <tr class="memitem:a06b42037718cf822a4b30d14668613f0"><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>
  111. <tr class="separator:a06b42037718cf822a4b30d14668613f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:af4be4b97022138385987eae380de5ddd"><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>
  113. <tr class="separator:af4be4b97022138385987eae380de5ddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a6fb4872e0af4c79faffe2bb30b2cafe3"><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>
  115. <tr class="separator:a6fb4872e0af4c79faffe2bb30b2cafe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a1de5a64a1e57b5938c4733f9152291b6"><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>
  117. <tr class="separator:a1de5a64a1e57b5938c4733f9152291b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a4abec78d39e7bdba8c739bd4cdc064de"><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#a4abec78d39e7bdba8c739bd4cdc064de">SetMethodType</a> (<a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a> type)</td></tr>
  119. <tr class="separator:a4abec78d39e7bdba8c739bd4cdc064de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a59527e676d274583ec6961fb3f4356b3"><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>
  121. <tr class="separator:a59527e676d274583ec6961fb3f4356b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table>
  123. <h2 class="groupheader">Member Enumeration Documentation</h2>
  124. <a class="anchor" id="ace95416ed07409e43059a0dfe9e23688"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">enum <a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">grpc::RpcMethod::RpcType</a></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <table class="fieldtable">
  134. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ace95416ed07409e43059a0dfe9e23688a8f7dac3c5cdbdbb204e3d3dbab033c2e"></a>NORMAL_RPC</em>&#160;</td><td class="fielddoc">
  135. </td></tr>
  136. <tr><td class="fieldname"><em><a class="anchor" id="ace95416ed07409e43059a0dfe9e23688a93445bd936c37c2f089f8a9075ebcb2a"></a>CLIENT_STREAMING</em>&#160;</td><td class="fielddoc">
  137. </td></tr>
  138. <tr><td class="fieldname"><em><a class="anchor" id="ace95416ed07409e43059a0dfe9e23688a86f700048be78a1204139f70912f7775"></a>SERVER_STREAMING</em>&#160;</td><td class="fielddoc">
  139. </td></tr>
  140. <tr><td class="fieldname"><em><a class="anchor" id="ace95416ed07409e43059a0dfe9e23688ae482ab481fdc406d88adcdd088269894"></a>BIDI_STREAMING</em>&#160;</td><td class="fielddoc">
  141. </td></tr>
  142. </table>
  143. </div>
  144. </div>
  145. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  146. <a class="anchor" id="a06b42037718cf822a4b30d14668613f0"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">grpc::RpcMethod::RpcMethod </td>
  155. <td>(</td>
  156. <td class="paramtype">const char *&#160;</td>
  157. <td class="paramname"><em>name</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a>&#160;</td>
  163. <td class="paramname"><em>type</em>&#160;</td>
  164. </tr>
  165. <tr>
  166. <td></td>
  167. <td>)</td>
  168. <td></td><td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a class="anchor" id="af4be4b97022138385987eae380de5ddd"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="mlabels">
  183. <tr>
  184. <td class="mlabels-left">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">grpc::RpcMethod::RpcMethod </td>
  188. <td>(</td>
  189. <td class="paramtype">const char *&#160;</td>
  190. <td class="paramname"><em>name</em>, </td>
  191. </tr>
  192. <tr>
  193. <td class="paramkey"></td>
  194. <td></td>
  195. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a>&#160;</td>
  196. <td class="paramname"><em>type</em>, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> &gt; &amp;&#160;</td>
  202. <td class="paramname"><em>channel</em>&#160;</td>
  203. </tr>
  204. <tr>
  205. <td></td>
  206. <td>)</td>
  207. <td></td><td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. </div>
  217. </div>
  218. <h2 class="groupheader">Member Function Documentation</h2>
  219. <a class="anchor" id="a59527e676d274583ec6961fb3f4356b3"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">void* grpc::RpcMethod::channel_tag </td>
  228. <td>(</td>
  229. <td class="paramname"></td><td>)</td>
  230. <td> const</td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. </div>
  240. </div>
  241. <a class="anchor" id="a1de5a64a1e57b5938c4733f9152291b6"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a> grpc::RpcMethod::method_type </td>
  250. <td>(</td>
  251. <td class="paramname"></td><td>)</td>
  252. <td> const</td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. </div>
  262. </div>
  263. <a class="anchor" id="a6fb4872e0af4c79faffe2bb30b2cafe3"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">const char* grpc::RpcMethod::name </td>
  272. <td>(</td>
  273. <td class="paramname"></td><td>)</td>
  274. <td> const</td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. </div>
  284. </div>
  285. <a class="anchor" id="a4abec78d39e7bdba8c739bd4cdc064de"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">void grpc::RpcMethod::SetMethodType </td>
  294. <td>(</td>
  295. <td class="paramtype"><a class="el" href="classgrpc_1_1_rpc_method.html#ace95416ed07409e43059a0dfe9e23688">RpcType</a>&#160;</td>
  296. <td class="paramname"><em>type</em></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </td>
  301. <td class="mlabels-right">
  302. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. </div>
  307. </div>
  308. <hr/>The documentation for this class was generated from the following file:<ul>
  309. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2rpc__method_8h_source.html">rpc_method.h</a></li>
  310. </ul>
  311. </div><!-- contents -->
  312. <!-- start footer part -->
  313. <hr class="footer"/><address class="footer"><small>
  314. Generated on Thu Apr 27 2017 17:26:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  315. <img class="footer" src="doxygen.png" alt="doxygen"/>
  316. </a> 1.8.6
  317. </small></address>
  318. </body>
  319. </html>