classgrpc_1_1_client_writer.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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::ClientWriter&lt; 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">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_client_writer.html">ClientWriter</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::ClientWriter&lt; W &gt; Class Template Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>Synchronous (blocking) client-side API for doing client-streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>.
  97. <a href="classgrpc_1_1_client_writer.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="channel__interface_8h_source.html">channel_interface.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:aed7d44896e0630a13409803459bd3cbe"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  103. <tr class="memitem:aed7d44896e0630a13409803459bd3cbe"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_writer.html#aed7d44896e0630a13409803459bd3cbe">ClientWriter</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, R *response)</td></tr>
  104. <tr class="memdesc:aed7d44896e0630a13409803459bd3cbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to create a stream (i.e. <a href="#aed7d44896e0630a13409803459bd3cbe">More...</a><br/></td></tr>
  105. <tr class="separator:aed7d44896e0630a13409803459bd3cbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a814a24b9a0348055195b3d9e837ae0a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_writer.html#a814a24b9a0348055195b3d9e837ae0a1">WaitForInitialMetadata</a> ()</td></tr>
  107. <tr class="memdesc:a814a24b9a0348055195b3d9e837ae0a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientStreamingInterface.WaitForInitialMetadata</em> method for semantics. <a href="#a814a24b9a0348055195b3d9e837ae0a1">More...</a><br/></td></tr>
  108. <tr class="separator:a814a24b9a0348055195b3d9e837ae0a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ad6b1906d4f9cb0a14431aeb310e6674b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_writer.html#ad6b1906d4f9cb0a14431aeb310e6674b">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) override</td></tr>
  110. <tr class="memdesc:ad6b1906d4f9cb0a14431aeb310e6674b"><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="#ad6b1906d4f9cb0a14431aeb310e6674b">More...</a><br/></td></tr>
  111. <tr class="separator:ad6b1906d4f9cb0a14431aeb310e6674b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ab77b5d10da6bd85684bffad7bf32ea63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_writer.html#ab77b5d10da6bd85684bffad7bf32ea63">WritesDone</a> () override</td></tr>
  113. <tr class="memdesc:ab77b5d10da6bd85684bffad7bf32ea63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Half close writing from the client. <a href="#ab77b5d10da6bd85684bffad7bf32ea63">More...</a><br/></td></tr>
  114. <tr class="separator:ab77b5d10da6bd85684bffad7bf32ea63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ab6c58e110c289ac0f76ae1fdb8fe24a3"><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_writer.html#ab6c58e110c289ac0f76ae1fdb8fe24a3">Finish</a> () override</td></tr>
  116. <tr class="memdesc:ab6c58e110c289ac0f76ae1fdb8fe24a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <a class="el" href="classgrpc_1_1_client_streaming_interface.html#a98e2927a42c793017ce7d8c6e88539c4" title="Block waiting until the stream finishes and a final status of the call is available. ">ClientStreamingInterface.Finish</a> method for semantics. <a href="#ab6c58e110c289ac0f76ae1fdb8fe24a3">More...</a><br/></td></tr>
  117. <tr class="separator:ab6c58e110c289ac0f76ae1fdb8fe24a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <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>
  120. <tr class="separator:a312c9454c0f950e1c75b5c802bcbb00e inherit pub_methods_classgrpc_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <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>
  123. <tr class="separator:a447d71736fb6e8c6bd21287ecc3a9f75 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="memdesc:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_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="#a5ddbce2a74455afea61fc21e16b01c6a">More...</a><br/></td></tr>
  126. <tr class="separator:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a8a4180c8928156e9daffa18465866ad2 inherit pub_methods_classgrpc_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_1_writer_interface.html#a8a4180c8928156e9daffa18465866ad2">WriteLast</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)</td></tr>
  128. <tr class="memdesc:a8a4180c8928156e9daffa18465866ad2 inherit pub_methods_classgrpc_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="#a8a4180c8928156e9daffa18465866ad2">More...</a><br/></td></tr>
  129. <tr class="separator:a8a4180c8928156e9daffa18465866ad2 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. </table>
  131. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  132. <div class="textblock"><h3>template&lt;class W&gt;<br/>
  133. class grpc::ClientWriter&lt; W &gt;</h3>
  134. <p>Synchronous (blocking) client-side API for doing client-streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>. </p>
  135. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  136. <a class="anchor" id="aed7d44896e0630a13409803459bd3cbe"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <div class="memtemplate">
  140. template&lt;class W &gt; </div>
  141. <div class="memtemplate">
  142. template&lt;class R &gt; </div>
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname"><a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a>&lt; W &gt;::<a class="el" href="classgrpc_1_1_client_writer.html">ClientWriter</a> </td>
  149. <td>(</td>
  150. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *&#160;</td>
  151. <td class="paramname"><em>channel</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  157. <td class="paramname"><em>method</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_client_context.html">ClientContext</a> *&#160;</td>
  163. <td class="paramname"><em>context</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">R *&#160;</td>
  169. <td class="paramname"><em>response</em>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </td>
  178. <td class="mlabels-right">
  179. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Block to create a stream (i.e. </p>
  184. <p>send request headers and other initial metadata to the server). Note that <em>context</em> will be used to fill in custom initial metadata. <em>response</em> will be filled in with the single expected response message from the server upon a successful call to the <em>Finish</em> method of this instance. </p>
  185. </div>
  186. </div>
  187. <h2 class="groupheader">Member Function Documentation</h2>
  188. <a class="anchor" id="ab6c58e110c289ac0f76ae1fdb8fe24a3"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;class W &gt; </div>
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> <a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a>&lt; W &gt;::Finish </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>See the <a class="el" href="classgrpc_1_1_client_streaming_interface.html#a98e2927a42c793017ce7d8c6e88539c4" title="Block waiting until the stream finishes and a final status of the call is available. ">ClientStreamingInterface.Finish</a> method for semantics. </p>
  211. <p>Side effects:</p>
  212. <ul>
  213. <li>Also receives initial metadata if not already received.</li>
  214. <li>Attempts to fill in the <em>response</em> parameter passed to the constructor of this instance with the response message from the server. </li>
  215. </ul>
  216. <p>Implements <a class="el" href="classgrpc_1_1_client_streaming_interface.html#a98e2927a42c793017ce7d8c6e88539c4">grpc::ClientStreamingInterface</a>.</p>
  217. </div>
  218. </div>
  219. <a class="anchor" id="a814a24b9a0348055195b3d9e837ae0a1"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <div class="memtemplate">
  223. template&lt;class W &gt; </div>
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">void <a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a>&lt; W &gt;::WaitForInitialMetadata </td>
  230. <td>(</td>
  231. <td class="paramname"></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>See the <em>ClientStreamingInterface.WaitForInitialMetadata</em> method for semantics. </p>
  242. <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>
  243. </div>
  244. </div>
  245. <a class="anchor" id="ad6b1906d4f9cb0a14431aeb310e6674b"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <div class="memtemplate">
  249. template&lt;class W &gt; </div>
  250. <table class="mlabels">
  251. <tr>
  252. <td class="mlabels-left">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a>&lt; W &gt;::Write </td>
  256. <td>(</td>
  257. <td class="paramtype">const W &amp;&#160;</td>
  258. <td class="paramname"><em>msg</em>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  264. <td class="paramname"><em>options</em>&#160;</td>
  265. </tr>
  266. <tr>
  267. <td></td>
  268. <td>)</td>
  269. <td></td><td></td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <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>
  279. <p>This is thread-safe with respect to <em><a class="el" href="classgrpc_1_1_reader_interface.html#a04a1da8610d790ea86ecd5a14fe892b8" title="Block to read a message and parse to msg. ">ReaderInterface::Read</a></em> </p>
  280. <dl class="params"><dt>Parameters</dt><dd>
  281. <table class="params">
  282. <tr><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>
  283. <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>
  284. </table>
  285. </dd>
  286. </dl>
  287. <dl class="section return"><dt>Returns</dt><dd><em>true</em> on success, <em>false</em> when the stream has been closed. </dd></dl>
  288. <p>Implements <a class="el" href="classgrpc_1_1_writer_interface.html#ae2ddda78f4e1deadf858a68b955e787d">grpc::WriterInterface&lt; W &gt;</a>.</p>
  289. </div>
  290. </div>
  291. <a class="anchor" id="ab77b5d10da6bd85684bffad7bf32ea63"></a>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <div class="memtemplate">
  295. template&lt;class W &gt; </div>
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">bool <a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a>&lt; W &gt;::WritesDone </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <p>Half close writing from the client. </p>
  314. <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><a class="el" href="classgrpc_1_1_reader_interface.html#a04a1da8610d790ea86ecd5a14fe892b8" title="Block to read a message and parse to msg. ">ReaderInterface::Read</a></em> operations only</p>
  315. <dl class="section return"><dt>Returns</dt><dd>Whether the writes were successful. </dd></dl>
  316. <p>Implements <a class="el" href="classgrpc_1_1_client_writer_interface.html#aff19574252338e9ac1b5446e82ed8ac5">grpc::ClientWriterInterface&lt; W &gt;</a>.</p>
  317. </div>
  318. </div>
  319. <hr/>The documentation for this class was generated from the following files:<ul>
  320. <li>include/grpc++/impl/codegen/<a class="el" href="channel__interface_8h_source.html">channel_interface.h</a></li>
  321. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  322. </ul>
  323. </div><!-- contents -->
  324. <!-- start footer part -->
  325. <hr class="footer"/><address class="footer"><small>
  326. Generated on Wed Jun 21 2017 14:13:08 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  327. <img class="footer" src="doxygen.png" alt="doxygen"/>
  328. </a> 1.8.6
  329. </small></address>
  330. </body>
  331. </html>