classgrpc_1_1_client_reader_writer.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ClientReaderWriter&lt; W, R &gt; Class Template 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. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#friends">Friends</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::ClientReaderWriter&lt; W, R &gt; Class Template Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>.
  72. <a href="classgrpc_1_1_client_reader_writer.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:ab6f436ca034fbc2e5e8035e637f7f5fc"><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#ab6f436ca034fbc2e5e8035e637f7f5fc">WaitForInitialMetadata</a> () override</td></tr>
  78. <tr class="memdesc:ab6f436ca034fbc2e5e8035e637f7f5fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block waiting to read initial metadata from the server. <a href="#ab6f436ca034fbc2e5e8035e637f7f5fc">More...</a><br /></td></tr>
  79. <tr class="separator:ab6f436ca034fbc2e5e8035e637f7f5fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a85c3018b87b4110c98b9f7f91adbfcef"><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#a85c3018b87b4110c98b9f7f91adbfcef">NextMessageSize</a> (uint32_t *sz) override</td></tr>
  81. <tr class="memdesc:a85c3018b87b4110c98b9f7f91adbfcef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an upper bound on the next message size available for reading on this stream. <a href="#a85c3018b87b4110c98b9f7f91adbfcef">More...</a><br /></td></tr>
  82. <tr class="separator:a85c3018b87b4110c98b9f7f91adbfcef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aa8887778273bea6ad32ffea3a6105699"><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#aa8887778273bea6ad32ffea3a6105699">Read</a> (R *msg) override</td></tr>
  84. <tr class="memdesc:aa8887778273bea6ad32ffea3a6105699"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ReaderInterface.Read</em> method for semantics. <a href="#aa8887778273bea6ad32ffea3a6105699">More...</a><br /></td></tr>
  85. <tr class="separator:aa8887778273bea6ad32ffea3a6105699"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ae30b0e18622f4132b1c7654e24605d53"><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#ae30b0e18622f4132b1c7654e24605d53">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) override</td></tr>
  87. <tr class="memdesc:ae30b0e18622f4132b1c7654e24605d53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> <em>options</em>. <a href="#ae30b0e18622f4132b1c7654e24605d53">More...</a><br /></td></tr>
  88. <tr class="separator:ae30b0e18622f4132b1c7654e24605d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a183f35c478b847e939c76cb20c69a359"><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#a183f35c478b847e939c76cb20c69a359">WritesDone</a> () override</td></tr>
  90. <tr class="memdesc:a183f35c478b847e939c76cb20c69a359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Half close writing from the client. <a href="#a183f35c478b847e939c76cb20c69a359">More...</a><br /></td></tr>
  91. <tr class="separator:a183f35c478b847e939c76cb20c69a359"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a9fe0acda29ba46726d69cedfdb043c79"><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#a9fe0acda29ba46726d69cedfdb043c79">Finish</a> () override</td></tr>
  93. <tr class="memdesc:a9fe0acda29ba46726d69cedfdb043c79"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the ClientStreamingInterface.Finish method for semantics. <a href="#a9fe0acda29ba46726d69cedfdb043c79">More...</a><br /></td></tr>
  94. <tr class="separator:a9fe0acda29ba46726d69cedfdb043c79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html">grpc::internal::ClientStreamingInterface</a></td></tr>
  96. <tr class="memitem:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_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_1internal_1_1_client_streaming_interface.html#ab1a7a2664187d88d0354b69138db7eb1">~ClientStreamingInterface</a> ()</td></tr>
  97. <tr class="separator:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html">grpc::internal::WriterInterface&lt; W &gt;</a></td></tr>
  99. <tr class="memitem:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_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_1internal_1_1_writer_interface.html#a0f3bb9c5625b43d600d33d2bf8c17b60">~WriterInterface</a> ()</td></tr>
  100. <tr class="separator:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_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_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">Write</a> (const W &amp;msg)</td></tr>
  102. <tr class="memdesc:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with default write options. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">More...</a><br /></td></tr>
  103. <tr class="separator:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">WriteLast</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)</td></tr>
  105. <tr class="memdesc:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write <em>msg</em> and coalesce it with the writing of trailing metadata, using <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> <em>options</em>. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">More...</a><br /></td></tr>
  106. <tr class="separator:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface&lt; R &gt;</a></td></tr>
  108. <tr class="memitem:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_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_1internal_1_1_reader_interface.html#ad1d28c0720937a61b0f7952d3add7bba">~ReaderInterface</a> ()</td></tr>
  109. <tr class="separator:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  112. Friends</h2></td></tr>
  113. <tr class="memitem:afecda317e553ccff29f57d43166b2d34"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader_writer.html#afecda317e553ccff29f57d43166b2d34">internal::ClientReaderWriterFactory&lt; W, R &gt;</a></td></tr>
  114. <tr class="separator:afecda317e553ccff29f57d43166b2d34"><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"><h3>template&lt;class W, class R&gt;<br />
  118. class grpc::ClientReaderWriter&lt; W, R &gt;</h3>
  119. <p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>. </p>
  120. </div><h2 class="groupheader">Member Function Documentation</h2>
  121. <a id="a9fe0acda29ba46726d69cedfdb043c79"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#a9fe0acda29ba46726d69cedfdb043c79">&#9670;&nbsp;</a></span>Finish()</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <div class="memtemplate">
  126. template&lt;class W, class R&gt; </div>
  127. <table class="mlabels">
  128. <tr>
  129. <td class="mlabels-left">
  130. <table class="memname">
  131. <tr>
  132. <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; W, R &gt;::Finish </td>
  133. <td>(</td>
  134. <td class="paramname"></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>See the ClientStreamingInterface.Finish method for semantics. </p>
  145. <p>Side effect:</p><ul>
  146. <li>the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a></em> associated with this call is updated with possible trailing metadata sent from the server. </li>
  147. </ul>
  148. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#a47321b8c130947bcef5c793329a54619">grpc::internal::ClientStreamingInterface</a>.</p>
  149. </div>
  150. </div>
  151. <a id="a85c3018b87b4110c98b9f7f91adbfcef"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a85c3018b87b4110c98b9f7f91adbfcef">&#9670;&nbsp;</a></span>NextMessageSize()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <div class="memtemplate">
  156. template&lt;class W, class R&gt; </div>
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; W, R &gt;::NextMessageSize </td>
  163. <td>(</td>
  164. <td class="paramtype">uint32_t *&#160;</td>
  165. <td class="paramname"><em>sz</em></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Get an upper bound on the next message size available for reading on this stream. </p>
  176. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">grpc::internal::ReaderInterface&lt; R &gt;</a>.</p>
  177. </div>
  178. </div>
  179. <a id="aa8887778273bea6ad32ffea3a6105699"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#aa8887778273bea6ad32ffea3a6105699">&#9670;&nbsp;</a></span>Read()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <div class="memtemplate">
  184. template&lt;class W, class R&gt; </div>
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; W, R &gt;::Read </td>
  191. <td>(</td>
  192. <td class="paramtype">R *&#160;</td>
  193. <td class="paramname"><em>msg</em></td><td>)</td>
  194. <td></td>
  195. </tr>
  196. </table>
  197. </td>
  198. <td class="mlabels-right">
  199. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>See the <em>ReaderInterface.Read</em> method for semantics. </p>
  204. <p>Side effect: Also receives initial metadata if not already received (updates the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a></em> associated with this call in that case). </p>
  205. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">grpc::internal::ReaderInterface&lt; R &gt;</a>.</p>
  206. </div>
  207. </div>
  208. <a id="ab6f436ca034fbc2e5e8035e637f7f5fc"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#ab6f436ca034fbc2e5e8035e637f7f5fc">&#9670;&nbsp;</a></span>WaitForInitialMetadata()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <div class="memtemplate">
  213. template&lt;class W, class R&gt; </div>
  214. <table class="mlabels">
  215. <tr>
  216. <td class="mlabels-left">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">void <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; W, R &gt;::WaitForInitialMetadata </td>
  220. <td>(</td>
  221. <td class="paramname"></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Block waiting to read initial metadata from the server. </p>
  232. <p>This call is optional, but if it is used, it cannot be used concurrently with or after the <em>Finish</em> method.</p>
  233. <p>Once complete, the initial metadata read from the server will be accessable through the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a></em> used to construct this object. </p>
  234. <p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a6ead554cc1b991f2289b26fb80fdde5e">grpc::ClientReaderWriterInterface&lt; W, R &gt;</a>.</p>
  235. </div>
  236. </div>
  237. <a id="ae30b0e18622f4132b1c7654e24605d53"></a>
  238. <h2 class="memtitle"><span class="permalink"><a href="#ae30b0e18622f4132b1c7654e24605d53">&#9670;&nbsp;</a></span>Write()</h2>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <div class="memtemplate">
  242. template&lt;class W, class R&gt; </div>
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; W, R &gt;::Write </td>
  249. <td>(</td>
  250. <td class="paramtype">const W &amp;&#160;</td>
  251. <td class="paramname"><em>msg</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  257. <td class="paramname"><em>options</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Block to write <em>msg</em> to the stream with <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> <em>options</em>. </p>
  272. <p>This is thread-safe with respect to <em>ReaderInterface::Read</em> </p>
  273. <dl class="params"><dt>Parameters</dt><dd>
  274. <table class="params">
  275. <tr><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>
  276. <tr><td class="paramname">options</td><td>The <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options. ">WriteOptions</a> affecting the write operation.</td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. <dl class="section return"><dt>Returns</dt><dd><em>true</em> on success, <em>false</em> when the stream has been closed. </dd></dl>
  281. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#add3e3940ba338ab08705ea69d017a80b">grpc::internal::WriterInterface&lt; W &gt;</a>.</p>
  282. </div>
  283. </div>
  284. <a id="a183f35c478b847e939c76cb20c69a359"></a>
  285. <h2 class="memtitle"><span class="permalink"><a href="#a183f35c478b847e939c76cb20c69a359">&#9670;&nbsp;</a></span>WritesDone()</h2>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <div class="memtemplate">
  289. template&lt;class W, class R&gt; </div>
  290. <table class="mlabels">
  291. <tr>
  292. <td class="mlabels-left">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a>&lt; W, R &gt;::WritesDone </td>
  296. <td>(</td>
  297. <td class="paramname"></td><td>)</td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>Half close writing from the client. </p>
  308. <p>(signal that the stream of messages coming from the clinet is complete). Blocks until currently-pending writes are completed. Thread-safe with respect to <em>ReaderInterface::Read</em> </p>
  309. <dl class="section return"><dt>Returns</dt><dd>Whether the writes were successful. </dd></dl>
  310. <p>Implements <a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a52f4e5d5ac7fe0e4995cb337aa0ecfc8">grpc::ClientReaderWriterInterface&lt; W, R &gt;</a>.</p>
  311. </div>
  312. </div>
  313. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  314. <a id="afecda317e553ccff29f57d43166b2d34"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#afecda317e553ccff29f57d43166b2d34">&#9670;&nbsp;</a></span>internal::ClientReaderWriterFactory< W, R ></h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <div class="memtemplate">
  319. template&lt;class W, class R&gt; </div>
  320. <table class="mlabels">
  321. <tr>
  322. <td class="mlabels-left">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_client_reader_writer_factory.html">internal::ClientReaderWriterFactory</a>&lt; W, R &gt;</td>
  326. </tr>
  327. </table>
  328. </td>
  329. <td class="mlabels-right">
  330. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. </div>
  335. </div>
  336. <hr/>The documentation for this class was generated from the following files:<ul>
  337. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
  338. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  339. </ul>
  340. </div><!-- contents -->
  341. <!-- start footer part -->
  342. <hr class="footer"/><address class="footer"><small>
  343. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  344. <img class="footer" src="doxygen.png" alt="doxygen"/>
  345. </a> 1.8.13
  346. </small></address>
  347. </body>
  348. </html>