carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc_impl::internal::WriterInterface&lt; W &gt; 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" />
</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++
   &#160;<span id="projectnumber">1.32.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="namespacegrpc__impl_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">WriterInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc_impl::internal::WriterInterface&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>An interface that can be fed a sequence of messages of type <em>W</em>.  
 <a href="classgrpc__impl_1_1internal_1_1_writer_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2sync__stream__impl_8h_source.html">sync_stream_impl.h</a>&gt;</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:af986fc5eeb12384945172d9711867889"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html#af986fc5eeb12384945172d9711867889">~WriterInterface</a> ()</td></tr>
<tr class="separator:af986fc5eeb12384945172d9711867889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a289bb880cfc060c6105fe8ca84198a5c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html#a289bb880cfc060c6105fe8ca84198a5c">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)=0</td></tr>
<tr class="memdesc:a289bb880cfc060c6105fe8ca84198a5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with WriteOptions <em>options</em>.  <a href="classgrpc__impl_1_1internal_1_1_writer_interface.html#a289bb880cfc060c6105fe8ca84198a5c">More...</a><br /></td></tr>
<tr class="separator:a289bb880cfc060c6105fe8ca84198a5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cd2f943f38815b25c71275f96a5c742"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html#a8cd2f943f38815b25c71275f96a5c742">Write</a> (const W &amp;msg)</td></tr>
<tr class="memdesc:a8cd2f943f38815b25c71275f96a5c742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with default write options.  <a href="classgrpc__impl_1_1internal_1_1_writer_interface.html#a8cd2f943f38815b25c71275f96a5c742">More...</a><br /></td></tr>
<tr class="separator:a8cd2f943f38815b25c71275f96a5c742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dcc2c52401f3bfc7f87072954ec6808"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html#a6dcc2c52401f3bfc7f87072954ec6808">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
<tr class="memdesc:a6dcc2c52401f3bfc7f87072954ec6808"><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="classgrpc__impl_1_1internal_1_1_writer_interface.html#a6dcc2c52401f3bfc7f87072954ec6808">More...</a><br /></td></tr>
<tr class="separator:a6dcc2c52401f3bfc7f87072954ec6808"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class W&gt;<br />
class grpc_impl::internal::WriterInterface&lt; W &gt;</h3>

<p>An interface that can be fed a sequence of messages of type <em>W</em>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af986fc5eeb12384945172d9711867889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af986fc5eeb12384945172d9711867889">&#9670;&nbsp;</a></span>~WriterInterface()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">grpc_impl::internal::WriterInterface</a>&lt; W &gt;::~<a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">WriterInterface</a> </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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8cd2f943f38815b25c71275f96a5c742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd2f943f38815b25c71275f96a5c742">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">grpc_impl::internal::WriterInterface</a>&lt; W &gt;::Write </td>
          <td>(</td>
          <td class="paramtype">const W &amp;&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Block to write <em>msg</em> to the stream with default write options. </p>
<p>This is thread-safe with respect to <em><a class="el" href="classgrpc__impl_1_1internal_1_1_reader_interface.html#a005a2778e6005e25555dd0fdeb2db1a7" title="Block to read a message and parse to msg.">ReaderInterface::Read</a></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>
  </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>

</div>
</div>
<a id="a289bb880cfc060c6105fe8ca84198a5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a289bb880cfc060c6105fe8ca84198a5c">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">grpc_impl::internal::WriterInterface</a>&lt; W &gt;::Write </td>
          <td>(</td>
          <td class="paramtype">const W &amp;&#160;</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">grpc::WriteOptions</a>&#160;</td>
          <td class="paramname"><em>options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Block to write <em>msg</em> to the stream with WriteOptions <em>options</em>. </p>
<p>This is thread-safe with respect to <em><a class="el" href="classgrpc__impl_1_1internal_1_1_reader_interface.html#a005a2778e6005e25555dd0fdeb2db1a7" title="Block to read a message and parse to msg.">ReaderInterface::Read</a></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 WriteOptions 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>Implemented in <a class="el" href="classgrpc__impl_1_1_server_reader_writer.html#af440a2bd3b1ff7e2e2c1b6e4aa14a66a">grpc_impl::ServerReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc__impl_1_1_server_split_streamer.html#a4f99f9a385235c82762edff8fbe55d1c">grpc_impl::ServerSplitStreamer&lt; RequestType, ResponseType &gt;</a>, and <a class="el" href="classgrpc__impl_1_1_server_unary_streamer.html#a3dc42505cd224f5599e88638b1aaba53">grpc_impl::ServerUnaryStreamer&lt; RequestType, ResponseType &gt;</a>.</p>

</div>
</div>
<a id="a6dcc2c52401f3bfc7f87072954ec6808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dcc2c52401f3bfc7f87072954ec6808">&#9670;&nbsp;</a></span>WriteLast()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc__impl_1_1internal_1_1_writer_interface.html">grpc_impl::internal::WriterInterface</a>&lt; W &gt;::WriteLast </td>
          <td>(</td>
          <td class="paramtype">const W &amp;&#160;</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">grpc::WriteOptions</a>&#160;</td>
          <td class="paramname"><em>options</em>&#160;</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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Write <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em>. </p>
<p>For client, WriteLast is equivalent of performing Write and WritesDone in a single step. <em>msg</em> and trailing metadata are coalesced and sent on wire by calling this function. For server, WriteLast buffers the <em>msg</em>. The writing of <em>msg</em> is held until the service handler returns, where <em>msg</em> and trailing metadata are coalesced and sent on wire. Note that WriteLast can only buffer <em>msg</em> up to the flow control window size. If <em>msg</em> size is larger than the window size, it will be sent on wire without buffering.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written to the stream. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The WriteOptions to be used to write this message. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2sync__stream__impl_8h_source.html">sync_stream_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 12 2020 00:53:57 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>