classgrpc_1_1_call.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  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::Call 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.4.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_call.html">Call</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::Call Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Straightforward wrapping of the C call object.
  97. <a href="classgrpc_1_1_call.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="codegen_2call_8h_source.html">call.h</a>&gt;</code></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:ade1359e6eeb9043abaa3df98550b57ee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#ade1359e6eeb9043abaa3df98550b57ee">Call</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *<a class="el" href="classgrpc_1_1_call.html#a23a7d7adfefc1f6baad31234aa49729b">call</a>, <a class="el" href="classgrpc_1_1_call_hook.html">CallHook</a> *call_hook, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *<a class="el" href="classgrpc_1_1_call.html#a98b8e1fe212f2d8648c316f433a40bdf">cq</a>)</td></tr>
  103. <tr class="memdesc:ade1359e6eeb9043abaa3df98550b57ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">call is owned by the caller <a href="#ade1359e6eeb9043abaa3df98550b57ee">More...</a><br/></td></tr>
  104. <tr class="separator:ade1359e6eeb9043abaa3df98550b57ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a8f3c3f3860b062eb76be2bb4ce47d3f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#a8f3c3f3860b062eb76be2bb4ce47d3f1">Call</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *<a class="el" href="classgrpc_1_1_call.html#a23a7d7adfefc1f6baad31234aa49729b">call</a>, <a class="el" href="classgrpc_1_1_call_hook.html">CallHook</a> *call_hook, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *<a class="el" href="classgrpc_1_1_call.html#a98b8e1fe212f2d8648c316f433a40bdf">cq</a>, int <a class="el" href="classgrpc_1_1_call.html#a2127f5a519f9d82cfc034b5e46cfd63d">max_receive_message_size</a>)</td></tr>
  106. <tr class="separator:a8f3c3f3860b062eb76be2bb4ce47d3f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a78ca141a1008fbbb122ee4de076edcc4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#a78ca141a1008fbbb122ee4de076edcc4">PerformOps</a> (<a class="el" href="classgrpc_1_1_call_op_set_interface.html">CallOpSetInterface</a> *ops)</td></tr>
  108. <tr class="separator:a78ca141a1008fbbb122ee4de076edcc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a23a7d7adfefc1f6baad31234aa49729b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#a23a7d7adfefc1f6baad31234aa49729b">call</a> () const </td></tr>
  110. <tr class="separator:a23a7d7adfefc1f6baad31234aa49729b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a98b8e1fe212f2d8648c316f433a40bdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#a98b8e1fe212f2d8648c316f433a40bdf">cq</a> () const </td></tr>
  112. <tr class="separator:a98b8e1fe212f2d8648c316f433a40bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a2127f5a519f9d82cfc034b5e46cfd63d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call.html#a2127f5a519f9d82cfc034b5e46cfd63d">max_receive_message_size</a> () const </td></tr>
  114. <tr class="separator:a2127f5a519f9d82cfc034b5e46cfd63d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  117. <div class="textblock"><p>Straightforward wrapping of the C call object. </p>
  118. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  119. <a class="anchor" id="ade1359e6eeb9043abaa3df98550b57ee"></a>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="mlabels">
  123. <tr>
  124. <td class="mlabels-left">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">grpc::Call::Call </td>
  128. <td>(</td>
  129. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  130. <td class="paramname"><em>call</em>, </td>
  131. </tr>
  132. <tr>
  133. <td class="paramkey"></td>
  134. <td></td>
  135. <td class="paramtype"><a class="el" href="classgrpc_1_1_call_hook.html">CallHook</a> *&#160;</td>
  136. <td class="paramname"><em>call_hook</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  142. <td class="paramname"><em>cq</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. <p>call is owned by the caller </p>
  157. </div>
  158. </div>
  159. <a class="anchor" id="a8f3c3f3860b062eb76be2bb4ce47d3f1"></a>
  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::Call::Call </td>
  168. <td>(</td>
  169. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  170. <td class="paramname"><em>call</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype"><a class="el" href="classgrpc_1_1_call_hook.html">CallHook</a> *&#160;</td>
  176. <td class="paramname"><em>call_hook</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  182. <td class="paramname"><em>cq</em>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">int&#160;</td>
  188. <td class="paramname"><em>max_receive_message_size</em>&#160;</td>
  189. </tr>
  190. <tr>
  191. <td></td>
  192. <td>)</td>
  193. <td></td><td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. </div>
  203. </div>
  204. <h2 class="groupheader">Member Function Documentation</h2>
  205. <a class="anchor" id="a23a7d7adfefc1f6baad31234aa49729b"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a>* grpc::Call::call </td>
  214. <td>(</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td> const</td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. </div>
  226. </div>
  227. <a class="anchor" id="a98b8e1fe212f2d8648c316f433a40bdf"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="mlabels">
  231. <tr>
  232. <td class="mlabels-left">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a>* grpc::Call::cq </td>
  236. <td>(</td>
  237. <td class="paramname"></td><td>)</td>
  238. <td> const</td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. </div>
  248. </div>
  249. <a class="anchor" id="a2127f5a519f9d82cfc034b5e46cfd63d"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">int grpc::Call::max_receive_message_size </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td> const</td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. </div>
  270. </div>
  271. <a class="anchor" id="a78ca141a1008fbbb122ee4de076edcc4"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">void grpc::Call::PerformOps </td>
  280. <td>(</td>
  281. <td class="paramtype"><a class="el" href="classgrpc_1_1_call_op_set_interface.html">CallOpSetInterface</a> *&#160;</td>
  282. <td class="paramname"><em>ops</em></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. </div>
  293. </div>
  294. <hr/>The documentation for this class was generated from the following file:<ul>
  295. <li>include/grpc++/impl/codegen/<a class="el" href="codegen_2call_8h_source.html">call.h</a></li>
  296. </ul>
  297. </div><!-- contents -->
  298. <!-- start footer part -->
  299. <hr class="footer"/><address class="footer"><small>
  300. Generated on Wed Jun 21 2017 14:13:08 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  301. <img class="footer" src="doxygen.png" alt="doxygen"/>
  302. </a> 1.8.6
  303. </small></address>
  304. </body>
  305. </html>