classgrpc_1_1_client_reader_writer.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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::ClientReaderWriter&lt; R, W &gt; Class Template 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">0.10.0.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="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <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></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_reader_writer.html">ClientReaderWriter</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> </div>
  90. <div class="headertitle">
  91. <div class="title">grpc::ClientReaderWriter&lt; R, W &gt; Class Template Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <p><code>#include &lt;<a class="el" href="client__context_8h_source.html">client_context.h</a>&gt;</code></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr class="memitem:a787e8b30520c9b32ef877bf1d3298dcc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a787e8b30520c9b32ef877bf1d3298dcc">ClientReaderWriter</a> (<a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *channel, const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;method, <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *context)</td></tr>
  99. <tr class="separator:a787e8b30520c9b32ef877bf1d3298dcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:af19ce81004b69300aa18d9ce14be29be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#af19ce81004b69300aa18d9ce14be29be">WaitForInitialMetadata</a> ()</td></tr>
  101. <tr class="separator:af19ce81004b69300aa18d9ce14be29be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:adcf4e48162a850ae106e9d2f6fd03d0c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#adcf4e48162a850ae106e9d2f6fd03d0c">Read</a> (R *msg) <a class="el" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  103. <tr class="separator:adcf4e48162a850ae106e9d2f6fd03d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a5e579c3ff2854b7776fe125a0a0cf762"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a5e579c3ff2854b7776fe125a0a0cf762">Write</a> (const W &amp;msg, const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;options) <a class="el" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  105. <tr class="separator:a5e579c3ff2854b7776fe125a0a0cf762"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5ed775777711d64b848f31260aef2898"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#a5ed775777711d64b848f31260aef2898">WritesDone</a> () <a class="el" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  107. <tr class="separator:a5ed775777711d64b848f31260aef2898"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:aabd46ba35f39419bbcfeff8c0843c116"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#aabd46ba35f39419bbcfeff8c0843c116">Finish</a> () <a class="el" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr>
  109. <tr class="separator:aabd46ba35f39419bbcfeff8c0843c116"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pub_methods_classgrpc_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_client_streaming_interface.html">grpc::ClientStreamingInterface</a></td></tr>
  111. <tr class="memitem:a312c9454c0f950e1c75b5c802bcbb00e inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_streaming_interface.html#a312c9454c0f950e1c75b5c802bcbb00e">~ClientStreamingInterface</a> ()</td></tr>
  112. <tr class="separator:a312c9454c0f950e1c75b5c802bcbb00e inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="inherit_header pub_methods_classgrpc_1_1_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_writer_interface.html">grpc::WriterInterface&lt; W &gt;</a></td></tr>
  114. <tr class="memitem:a447d71736fb6e8c6bd21287ecc3a9f75 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_writer_interface.html#a447d71736fb6e8c6bd21287ecc3a9f75">~WriterInterface</a> ()</td></tr>
  115. <tr class="separator:a447d71736fb6e8c6bd21287ecc3a9f75 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_writer_interface.html#a5ddbce2a74455afea61fc21e16b01c6a">Write</a> (const W &amp;msg)</td></tr>
  117. <tr class="separator:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="inherit_header pub_methods_classgrpc_1_1_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_reader_interface.html">grpc::ReaderInterface&lt; R &gt;</a></td></tr>
  119. <tr class="memitem:a1fbd3d6e86e2f97e5444f29b0af0a9d5 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_reader_interface.html#a1fbd3d6e86e2f97e5444f29b0af0a9d5">~ReaderInterface</a> ()</td></tr>
  120. <tr class="separator:a1fbd3d6e86e2f97e5444f29b0af0a9d5 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  123. <a class="anchor" id="a787e8b30520c9b32ef877bf1d3298dcc"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <div class="memtemplate">
  127. template&lt;class R , class W &gt; </div>
  128. <table class="mlabels">
  129. <tr>
  130. <td class="mlabels-left">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::<a class="el" href="classgrpc_1_1_client_reader_writer.html">ClientReaderWriter</a> </td>
  134. <td>(</td>
  135. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *&#160;</td>
  136. <td class="paramname"><em>channel</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  142. <td class="paramname"><em>method</em>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *&#160;</td>
  148. <td class="paramname"><em>context</em>&#160;</td>
  149. </tr>
  150. <tr>
  151. <td></td>
  152. <td>)</td>
  153. <td></td><td></td>
  154. </tr>
  155. </table>
  156. </td>
  157. <td class="mlabels-right">
  158. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <h2 class="groupheader">Member Function Documentation</h2>
  165. <a class="anchor" id="aabd46ba35f39419bbcfeff8c0843c116"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <div class="memtemplate">
  169. template&lt;class R , class W &gt; </div>
  170. <table class="mlabels">
  171. <tr>
  172. <td class="mlabels-left">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::Finish </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Implements <a class="el" href="classgrpc_1_1_client_streaming_interface.html#a98e2927a42c793017ce7d8c6e88539c4">grpc::ClientStreamingInterface</a>.</p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="adcf4e48162a850ae106e9d2f6fd03d0c"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <div class="memtemplate">
  194. template&lt;class R , class W &gt; </div>
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::Read </td>
  201. <td>(</td>
  202. <td class="paramtype">R *&#160;</td>
  203. <td class="paramname"><em>msg</em></td><td>)</td>
  204. <td></td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Implements <a class="el" href="classgrpc_1_1_reader_interface.html#a04a1da8610d790ea86ecd5a14fe892b8">grpc::ReaderInterface&lt; R &gt;</a>.</p>
  214. </div>
  215. </div>
  216. <a class="anchor" id="af19ce81004b69300aa18d9ce14be29be"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <div class="memtemplate">
  220. template&lt;class R , class W &gt; </div>
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">void <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::WaitForInitialMetadata </td>
  227. <td>(</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a6ead554cc1b991f2289b26fb80fdde5e">grpc::ClientReaderWriterInterface&lt; W, R &gt;</a>.</p>
  239. </div>
  240. </div>
  241. <a class="anchor" id="a5e579c3ff2854b7776fe125a0a0cf762"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <div class="memtemplate">
  245. template&lt;class R , class W &gt; </div>
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::Write </td>
  252. <td>(</td>
  253. <td class="paramtype">const W &amp;&#160;</td>
  254. <td class="paramname"><em>msg</em>, </td>
  255. </tr>
  256. <tr>
  257. <td class="paramkey"></td>
  258. <td></td>
  259. <td class="paramtype">const <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> &amp;&#160;</td>
  260. <td class="paramname"><em>options</em>&#160;</td>
  261. </tr>
  262. <tr>
  263. <td></td>
  264. <td>)</td>
  265. <td></td><td></td>
  266. </tr>
  267. </table>
  268. </td>
  269. <td class="mlabels-right">
  270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Implements <a class="el" href="classgrpc_1_1_writer_interface.html#aa6b2aeb8957265b62bdc063b48f15d44">grpc::WriterInterface&lt; W &gt;</a>.</p>
  275. </div>
  276. </div>
  277. <a class="anchor" id="a5ed775777711d64b848f31260aef2898"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <div class="memtemplate">
  281. template&lt;class R , class W &gt; </div>
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; R, W &gt;::WritesDone </td>
  288. <td>(</td>
  289. <td class="paramname"></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a52f4e5d5ac7fe0e4995cb337aa0ecfc8">grpc::ClientReaderWriterInterface&lt; W, R &gt;</a>.</p>
  300. </div>
  301. </div>
  302. <hr/>The documentation for this class was generated from the following files:<ul>
  303. <li>include/grpc++/<a class="el" href="client__context_8h_source.html">client_context.h</a></li>
  304. <li>include/grpc++/<a class="el" href="stream_8h_source.html">stream.h</a></li>
  305. </ul>
  306. </div><!-- contents -->
  307. <!-- start footer part -->
  308. <hr class="footer"/><address class="footer"><small>
  309. Generated on Wed Aug 5 2015 08:17:06 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  310. <img class="footer" src="doxygen.png" alt="doxygen"/>
  311. </a> 1.8.6
  312. </small></address>
  313. </body>
  314. </html>