classgrpc_1_1_server_split_streamer.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  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::ServerSplitStreamer&lt; RequestType, ResponseType &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.3.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_split_streamer.html">ServerSplitStreamer</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::ServerSplitStreamer&lt; RequestType, ResponseType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>A class to represent a flow-controlled server-side streaming call.
  97. <a href="classgrpc_1_1_server_split_streamer.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="impl_2codegen_2sync__stream_8h_source.html">sync_stream.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:a09a860679f0a46e52490a8e6b41b89d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a09a860679f0a46e52490a8e6b41b89d4">ServerSplitStreamer</a> (<a class="el" href="classgrpc_1_1_call.html">Call</a> *call, <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *ctx)</td></tr>
  103. <tr class="separator:a09a860679f0a46e52490a8e6b41b89d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a291fd87fdf9306a75ad904120b0c59f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a291fd87fdf9306a75ad904120b0c59f1">SendInitialMetadata</a> () override</td></tr>
  105. <tr class="memdesc:a291fd87fdf9306a75ad904120b0c59f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking send initial metadata to client. <a href="#a291fd87fdf9306a75ad904120b0c59f1">More...</a><br/></td></tr>
  106. <tr class="separator:a291fd87fdf9306a75ad904120b0c59f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:afd992b3d73e9da01b4267b443fe39176"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#afd992b3d73e9da01b4267b443fe39176">NextMessageSize</a> (uint32_t *sz) override</td></tr>
  108. <tr class="memdesc:afd992b3d73e9da01b4267b443fe39176"><td class="mdescLeft">&#160;</td><td class="mdescRight">Upper bound on the next message size available for reading on this stream. <a href="#afd992b3d73e9da01b4267b443fe39176">More...</a><br/></td></tr>
  109. <tr class="separator:afd992b3d73e9da01b4267b443fe39176"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a0f408957f9071bb498b6f4a948ef6113"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a0f408957f9071bb498b6f4a948ef6113">Read</a> (RequestType *request) override</td></tr>
  111. <tr class="memdesc:a0f408957f9071bb498b6f4a948ef6113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking read a message and parse to <em>msg</em>. <a href="#a0f408957f9071bb498b6f4a948ef6113">More...</a><br/></td></tr>
  112. <tr class="separator:a0f408957f9071bb498b6f4a948ef6113"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a3dbab04817791c65c8222daee9f6f46f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a3dbab04817791c65c8222daee9f6f46f">Write</a> (const ResponseType &amp;response, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) override</td></tr>
  114. <tr class="memdesc:a3dbab04817791c65c8222daee9f6f46f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking 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="#a3dbab04817791c65c8222daee9f6f46f">More...</a><br/></td></tr>
  115. <tr class="separator:a3dbab04817791c65c8222daee9f6f46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="inherit_header pub_methods_classgrpc_1_1_server_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_server_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_server_streaming_interface.html">grpc::ServerStreamingInterface</a></td></tr>
  117. <tr class="memitem:a3c4c1bb05e9a92ca9095bcb63301d8a1 inherit pub_methods_classgrpc_1_1_server_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_streaming_interface.html#a3c4c1bb05e9a92ca9095bcb63301d8a1">~ServerStreamingInterface</a> ()</td></tr>
  118. <tr class="separator:a3c4c1bb05e9a92ca9095bcb63301d8a1 inherit pub_methods_classgrpc_1_1_server_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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; ResponseType &gt;</a></td></tr>
  120. <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>
  121. <tr class="separator:a447d71736fb6e8c6bd21287ecc3a9f75 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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 ResponseType &amp;msg)</td></tr>
  123. <tr class="memdesc:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking write <em>msg</em> to the stream with default write options. <a href="#a5ddbce2a74455afea61fc21e16b01c6a">More...</a><br/></td></tr>
  124. <tr class="separator:a5ddbce2a74455afea61fc21e16b01c6a inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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 ResponseType &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)</td></tr>
  126. <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 WriteOptions <em>options</em>. <a href="#a8a4180c8928156e9daffa18465866ad2">More...</a><br/></td></tr>
  127. <tr class="separator:a8a4180c8928156e9daffa18465866ad2 inherit pub_methods_classgrpc_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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; RequestType &gt;</a></td></tr>
  129. <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>
  130. <tr class="separator:a1fbd3d6e86e2f97e5444f29b0af0a9d5 inherit pub_methods_classgrpc_1_1_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><h3>template&lt;class RequestType, class ResponseType&gt;<br/>
  134. class grpc::ServerSplitStreamer&lt; RequestType, ResponseType &gt;</h3>
  135. <p>A class to represent a flow-controlled server-side streaming call. </p>
  136. <p>This is something of a hybrid between server-side and bidi streaming. This is invoked through a server-side streaming call on the client side, but the server responds to it as though it were a bidi streaming call that must first have exactly 1 Read and then any number of Writes. </p>
  137. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  138. <a class="anchor" id="a09a860679f0a46e52490a8e6b41b89d4"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <div class="memtemplate">
  142. template&lt;class RequestType , class ResponseType &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_server_split_streamer.html">grpc::ServerSplitStreamer</a>&lt; RequestType, ResponseType &gt;::<a class="el" href="classgrpc_1_1_server_split_streamer.html">ServerSplitStreamer</a> </td>
  149. <td>(</td>
  150. <td class="paramtype"><a class="el" href="classgrpc_1_1_call.html">Call</a> *&#160;</td>
  151. <td class="paramname"><em>call</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  157. <td class="paramname"><em>ctx</em>&#160;</td>
  158. </tr>
  159. <tr>
  160. <td></td>
  161. <td>)</td>
  162. <td></td><td></td>
  163. </tr>
  164. </table>
  165. </td>
  166. <td class="mlabels-right">
  167. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. </div>
  172. </div>
  173. <h2 class="groupheader">Member Function Documentation</h2>
  174. <a class="anchor" id="afd992b3d73e9da01b4267b443fe39176"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <div class="memtemplate">
  178. template&lt;class RequestType , class ResponseType &gt; </div>
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>&lt; RequestType, ResponseType &gt;::NextMessageSize </td>
  185. <td>(</td>
  186. <td class="paramtype">uint32_t *&#160;</td>
  187. <td class="paramname"><em>sz</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Upper bound on the next message size available for reading on this stream. </p>
  198. <p>Implements <a class="el" href="classgrpc_1_1_reader_interface.html#a4ad823a3c32ec163fca5fc175dcb102f">grpc::ReaderInterface&lt; RequestType &gt;</a>.</p>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a0f408957f9071bb498b6f4a948ef6113"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <div class="memtemplate">
  205. template&lt;class RequestType , class ResponseType &gt; </div>
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>&lt; RequestType, ResponseType &gt;::Read </td>
  212. <td>(</td>
  213. <td class="paramtype">RequestType *&#160;</td>
  214. <td class="paramname"><em>msg</em></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Blocking read a message and parse to <em>msg</em>. </p>
  225. <p>Returns <em>true</em> on success. This is thread-safe with respect to <em>Write</em> or methods on the same stream. It should not be called concurrently with another <em>Read</em> on the same stream as the order of delivery will not be defined.</p>
  226. <dl class="params"><dt>Parameters</dt><dd>
  227. <table class="params">
  228. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>The read message.</td></tr>
  229. </table>
  230. </dd>
  231. </dl>
  232. <dl class="section return"><dt>Returns</dt><dd><em>false</em> when there will be no more incoming messages, either because the other side has called <em>WritesDone()</em> or the stream has failed (or been cancelled). </dd></dl>
  233. <p>Implements <a class="el" href="classgrpc_1_1_reader_interface.html#a04a1da8610d790ea86ecd5a14fe892b8">grpc::ReaderInterface&lt; RequestType &gt;</a>.</p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a291fd87fdf9306a75ad904120b0c59f1"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <div class="memtemplate">
  240. template&lt;class RequestType , class ResponseType &gt; </div>
  241. <table class="mlabels">
  242. <tr>
  243. <td class="mlabels-left">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">void <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>&lt; RequestType, ResponseType &gt;::SendInitialMetadata </td>
  247. <td>(</td>
  248. <td class="paramname"></td><td>)</td>
  249. <td></td>
  250. </tr>
  251. </table>
  252. </td>
  253. <td class="mlabels-right">
  254. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <p>Blocking send initial metadata to client. </p>
  259. <p>Implements <a class="el" href="classgrpc_1_1_server_streaming_interface.html#a1a73c0e46258c0ef9a5c1ecd3cbe429a">grpc::ServerStreamingInterface</a>.</p>
  260. </div>
  261. </div>
  262. <a class="anchor" id="a3dbab04817791c65c8222daee9f6f46f"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <div class="memtemplate">
  266. template&lt;class RequestType , class ResponseType &gt; </div>
  267. <table class="mlabels">
  268. <tr>
  269. <td class="mlabels-left">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>&lt; RequestType, ResponseType &gt;::Write </td>
  273. <td>(</td>
  274. <td class="paramtype">const ResponseType &amp;&#160;</td>
  275. <td class="paramname"><em>msg</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  281. <td class="paramname"><em>options</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Blocking 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>
  296. <p>This is thread-safe with respect to <em>Read</em> </p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>
  300. <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>
  301. </table>
  302. </dd>
  303. </dl>
  304. <dl class="section return"><dt>Returns</dt><dd><em>true</em> on success, <em>false</em> when the stream has been closed. </dd></dl>
  305. <p>Implements <a class="el" href="classgrpc_1_1_writer_interface.html#ae2ddda78f4e1deadf858a68b955e787d">grpc::WriterInterface&lt; ResponseType &gt;</a>.</p>
  306. </div>
  307. </div>
  308. <hr/>The documentation for this class was generated from the following file:<ul>
  309. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  310. </ul>
  311. </div><!-- contents -->
  312. <!-- start footer part -->
  313. <hr class="footer"/><address class="footer"><small>
  314. Generated on Thu Apr 27 2017 17:26:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  315. <img class="footer" src="doxygen.png" alt="doxygen"/>
  316. </a> 1.8.6
  317. </small></address>
  318. </body>
  319. </html>