| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.13"/><meta name="viewport" content="width=device-width, initial-scale=1"/><title>GRPC C++: grpc::ServerSplitStreamer< RequestType, ResponseType > Class Template Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="search/search.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="search/searchdata.js"></script><script type="text/javascript" src="search/search.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /><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><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;">  <td id="projectalign" style="padding-left: 0.5em;">   <div id="projectname">GRPC C++    <span id="projectnumber">1.13.0-dev</span>   </div>  </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.13 --><script type="text/javascript">var searchBox = new SearchBox("searchBox", "search",false,'Search');</script><script type="text/javascript" src="menudata.js"></script><script type="text/javascript" src="menu.js"></script><script type="text/javascript">$(function() {  initMenu('',true,false,'search.php','Search');  $(document).ready(function() { init_search(); });});</script><div id="main-nav"></div><!-- window showing the filter options --><div id="MSearchSelectWindow"     onmouseover="return searchBox.OnSearchSelectShow()"     onmouseout="return searchBox.OnSearchSelectHide()"     onkeydown="return searchBox.OnSearchSelectKey(event)"></div><!-- iframe showing the search results (closed by default) --><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" frameborder="0"         name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath">  <ul><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></div></div><!-- top --><div class="header">  <div class="summary"><a href="#pub-methods">Public Member Functions</a> |<a href="#friends">Friends</a>  </div>  <div class="headertitle"><div class="title">grpc::ServerSplitStreamer< RequestType, ResponseType > Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div></div><!--header--><div class="contents"><p>A class to represent a flow-controlled server-side streaming call.   <a href="classgrpc_1_1_server_split_streamer.html#details">More...</a></p><p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a>></code></p><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr class="memitem:a291fd87fdf9306a75ad904120b0c59f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a291fd87fdf9306a75ad904120b0c59f1">SendInitialMetadata</a> () override</td></tr><tr class="memdesc:a291fd87fdf9306a75ad904120b0c59f1"><td class="mdescLeft"> </td><td class="mdescRight">Block to send initial metadata to client.  <a href="#a291fd87fdf9306a75ad904120b0c59f1">More...</a><br /></td></tr><tr class="separator:a291fd87fdf9306a75ad904120b0c59f1"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:afd992b3d73e9da01b4267b443fe39176"><td class="memItemLeft" align="right" valign="top">bool </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><tr class="memdesc:afd992b3d73e9da01b4267b443fe39176"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the request message size from the client.  <a href="#afd992b3d73e9da01b4267b443fe39176">More...</a><br /></td></tr><tr class="separator:afd992b3d73e9da01b4267b443fe39176"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a0f408957f9071bb498b6f4a948ef6113"><td class="memItemLeft" align="right" valign="top">bool </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><tr class="memdesc:a0f408957f9071bb498b6f4a948ef6113"><td class="mdescLeft"> </td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>.  <a href="#a0f408957f9071bb498b6f4a948ef6113">More...</a><br /></td></tr><tr class="separator:a0f408957f9071bb498b6f4a948ef6113"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a3dbab04817791c65c8222daee9f6f46f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#a3dbab04817791c65c8222daee9f6f46f">Write</a> (const ResponseType &response, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options) override</td></tr><tr class="memdesc:a3dbab04817791c65c8222daee9f6f46f"><td class="mdescLeft"> </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="#a3dbab04817791c65c8222daee9f6f46f">More...</a><br /></td></tr><tr class="separator:a3dbab04817791c65c8222daee9f6f46f"><td class="memSeparator" colspan="2"> </td></tr><tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_server_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_server_streaming_interface')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_streaming_interface.html">grpc::internal::ServerStreamingInterface</a></td></tr><tr class="memitem:a2eef7573013077505dd7e22b3672acc5 inherit pub_methods_classgrpc_1_1internal_1_1_server_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_streaming_interface.html#a2eef7573013077505dd7e22b3672acc5">~ServerStreamingInterface</a> ()</td></tr><tr class="separator:a2eef7573013077505dd7e22b3672acc5 inherit pub_methods_classgrpc_1_1internal_1_1_server_streaming_interface"><td class="memSeparator" colspan="2"> </td></tr><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="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html">grpc::internal::WriterInterface< ResponseType ></a></td></tr><tr class="memitem:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a0f3bb9c5625b43d600d33d2bf8c17b60">~WriterInterface</a> ()</td></tr><tr class="separator:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">Write</a> (const ResponseType &msg)</td></tr><tr class="memdesc:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft"> </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><tr class="separator:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">WriteLast</a> (const ResponseType &msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)</td></tr><tr class="memdesc:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft"> </td><td class="mdescRight">Write <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em>.  <a href="classgrpc_1_1internal_1_1_writer_interface.html#a3308bfe1558e317e5fa3530f74c63ce6">More...</a><br /></td></tr><tr class="separator:a3308bfe1558e317e5fa3530f74c63ce6 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2"> </td></tr><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="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface< RequestType ></a></td></tr><tr class="memitem:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad1d28c0720937a61b0f7952d3add7bba">~ReaderInterface</a> ()</td></tr><tr class="separator:ad1d28c0720937a61b0f7952d3add7bba inherit pub_methods_classgrpc_1_1internal_1_1_reader_interface"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>Friends</h2></td></tr><tr class="memitem:aa38c338c8f59396cf1f2f62f4e8cad3b"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_split_streamer.html#aa38c338c8f59396cf1f2f62f4e8cad3b">internal::TemplatedBidiStreamingHandler< ServerSplitStreamer< RequestType, ResponseType >, false ></a></td></tr><tr class="separator:aa38c338c8f59396cf1f2f62f4e8cad3b"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><h3>template<class RequestType, class ResponseType><br />class grpc::ServerSplitStreamer< RequestType, ResponseType ></h3><p>A class to represent a flow-controlled server-side streaming call. </p><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></div><h2 class="groupheader">Member Function Documentation</h2><a id="afd992b3d73e9da01b4267b443fe39176"></a><h2 class="memtitle"><span class="permalink"><a href="#afd992b3d73e9da01b4267b443fe39176">◆ </a></span>NextMessageSize()</h2><div class="memitem"><div class="memproto"><div class="memtemplate">template<class RequestType , class ResponseType > </div><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>< RequestType, ResponseType >::NextMessageSize </td>          <td>(</td>          <td class="paramtype">uint32_t * </td>          <td class="paramname"><em>sz</em></td><td>)</td>          <td></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Get an upper bound on the request message size from the client. </p><p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">grpc::internal::ReaderInterface< RequestType ></a>.</p></div></div><a id="a0f408957f9071bb498b6f4a948ef6113"></a><h2 class="memtitle"><span class="permalink"><a href="#a0f408957f9071bb498b6f4a948ef6113">◆ </a></span>Read()</h2><div class="memitem"><div class="memproto"><div class="memtemplate">template<class RequestType , class ResponseType > </div><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>< RequestType, ResponseType >::Read </td>          <td>(</td>          <td class="paramtype">RequestType * </td>          <td class="paramname"><em>request</em></td><td>)</td>          <td></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Read a message of type <em>R</em> into <em>msg</em>. </p><p>Completion will be notified by <em>tag</em> on the associated completion queue. This is thread-safe with respect to <em>Write</em> or <em>WritesDone</em> methods. It should not be called concurrently with other streaming APIs on the same stream. It is not meaningful to call it concurrently with another <em>ReaderInterface::Read</em> on the same stream since reads on the same stream are delivered in order.</p><dl class="params"><dt>Parameters</dt><dd>  <table class="params">    <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>  </table>  </dd></dl><p>Implements <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">grpc::internal::ReaderInterface< RequestType ></a>.</p></div></div><a id="a291fd87fdf9306a75ad904120b0c59f1"></a><h2 class="memtitle"><span class="permalink"><a href="#a291fd87fdf9306a75ad904120b0c59f1">◆ </a></span>SendInitialMetadata()</h2><div class="memitem"><div class="memproto"><div class="memtemplate">template<class RequestType , class ResponseType > </div><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">void <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>< RequestType, ResponseType >::SendInitialMetadata </td>          <td>(</td>          <td class="paramname"></td><td>)</td>          <td></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Block to send initial metadata to client. </p><p>Implicit input parameter:</p><ul><li>the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a></em> associated with this call will be used for sending initial metadata. </li></ul><p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_streaming_interface.html#a45ab1e968a08b6c905ffac9a41e894d4">grpc::internal::ServerStreamingInterface</a>.</p></div></div><a id="a3dbab04817791c65c8222daee9f6f46f"></a><h2 class="memtitle"><span class="permalink"><a href="#a3dbab04817791c65c8222daee9f6f46f">◆ </a></span>Write()</h2><div class="memitem"><div class="memproto"><div class="memtemplate">template<class RequestType , class ResponseType > </div><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">bool <a class="el" href="classgrpc_1_1_server_split_streamer.html">grpc::ServerSplitStreamer</a>< RequestType, ResponseType >::Write </td>          <td>(</td>          <td class="paramtype">const ResponseType & </td>          <td class="paramname"><em>msg</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> </td>          <td class="paramname"><em>options</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>  </tr></table></div><div class="memdoc"><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><p>This is thread-safe with respect to <em>ReaderInterface::Read</em> </p><dl class="params"><dt>Parameters</dt><dd>  <table class="params">    <tr><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>    <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>  </table>  </dd></dl><dl class="section return"><dt>Returns</dt><dd><em>true</em> on success, <em>false</em> when the stream has been closed. </dd></dl><p>Implements <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#add3e3940ba338ab08705ea69d017a80b">grpc::internal::WriterInterface< ResponseType ></a>.</p></div></div><h2 class="groupheader">Friends And Related Function Documentation</h2><a id="aa38c338c8f59396cf1f2f62f4e8cad3b"></a><h2 class="memtitle"><span class="permalink"><a href="#aa38c338c8f59396cf1f2f62f4e8cad3b">◆ </a></span>internal::TemplatedBidiStreamingHandler< ServerSplitStreamer< RequestType, ResponseType >, false ></h2><div class="memitem"><div class="memproto"><div class="memtemplate">template<class RequestType , class ResponseType > </div><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_templated_bidi_streaming_handler.html">internal::TemplatedBidiStreamingHandler</a>< <a class="el" href="classgrpc_1_1_server_split_streamer.html">ServerSplitStreamer</a>< RequestType, ResponseType >, false ></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">friend</span></span>  </td>  </tr></table></div><div class="memdoc"></div></div><hr/>The documentation for this class was generated from the following file:<ul><li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Tue May 15 2018 17:01:01 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13</small></address></body></html>
 |