carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
							<!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_impl::internal::AsyncWriterInterface&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.23.0</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__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_async_writer_interface.html">AsyncWriterInterface</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::AsyncWriterInterface&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_async_writer_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_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:abb8fa894b94e09e9a2b6ca261a20ec8b"><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_async_writer_interface.html#abb8fa894b94e09e9a2b6ca261a20ec8b">~AsyncWriterInterface</a> ()</td></tr>
<tr class="separator:abb8fa894b94e09e9a2b6ca261a20ec8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c4e4ce91569478b6656992a35c5ece1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a9c4e4ce91569478b6656992a35c5ece1">Write</a> (const W &amp;msg, void *tag)=0</td></tr>
<tr class="memdesc:a9c4e4ce91569478b6656992a35c5ece1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>.  <a href="#a9c4e4ce91569478b6656992a35c5ece1">More...</a><br /></td></tr>
<tr class="separator:a9c4e4ce91569478b6656992a35c5ece1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b008c0685622ae659f8a57fb508bb5b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a8b008c0685622ae659f8a57fb508bb5b">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)=0</td></tr>
<tr class="memdesc:a8b008c0685622ae659f8a57fb508bb5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>.  <a href="#a8b008c0685622ae659f8a57fb508bb5b">More...</a><br /></td></tr>
<tr class="separator:a8b008c0685622ae659f8a57fb508bb5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05ab1b1965def7cec0324fe27b0fa67f"><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_async_writer_interface.html#a05ab1b1965def7cec0324fe27b0fa67f">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)</td></tr>
<tr class="memdesc:a05ab1b1965def7cec0324fe27b0fa67f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em> with identifying tag <em>tag</em>.  <a href="#a05ab1b1965def7cec0324fe27b0fa67f">More...</a><br /></td></tr>
<tr class="separator:a05ab1b1965def7cec0324fe27b0fa67f"><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::AsyncWriterInterface&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="abb8fa894b94e09e9a2b6ca261a20ec8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb8fa894b94e09e9a2b6ca261a20ec8b">&#9670;&nbsp;</a></span>~AsyncWriterInterface()</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_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface</a>&lt; W &gt;::~<a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html">AsyncWriterInterface</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="a9c4e4ce91569478b6656992a35c5ece1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c4e4ce91569478b6656992a35c5ece1">&#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">virtual void <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface</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">void *&#160;</td>
          <td class="paramname"><em>tag</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>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
<p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. This is thread-safe with respect to <em><a class="el" href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html#a02645c77e024a39abbd922650cfed5fd" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> </p>
<p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</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. </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>Implemented in <a class="el" href="classgrpc__impl_1_1_server_async_reader_writer.html#a1f6ce8f029b65160bbf26937257547c5">grpc_impl::ServerAsyncReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc__impl_1_1_server_async_writer.html#a05daf326ddaeee486dcd771b69329b98">grpc_impl::ServerAsyncWriter&lt; W &gt;</a>, <a class="el" href="classgrpc__impl_1_1_client_async_reader_writer.html#a14cef3c5d9d057e8c672700869cfc7a3">grpc_impl::ClientAsyncReaderWriter&lt; W, R &gt;</a>, and <a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a5a91f21f3a4023afc737bebfc14e7b54">grpc_impl::ClientAsyncWriter&lt; W &gt;</a>.</p>

</div>
</div>
<a id="a8b008c0685622ae659f8a57fb508bb5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b008c0685622ae659f8a57fb508bb5b">&#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 void <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface</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>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</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>Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>. </p>
<p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. WriteOptions <em>options</em> is used to set the write options of this message. This is thread-safe with respect to <em><a class="el" href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html#a02645c77e024a39abbd922650cfed5fd" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> </p>
<p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</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. </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>
    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgrpc__impl_1_1_server_async_reader_writer.html#af0a845cd6a0f1405d42c74f0faff08ae">grpc_impl::ServerAsyncReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc__impl_1_1_server_async_writer.html#afbd407cad4ebfbfe199fad243e130c9e">grpc_impl::ServerAsyncWriter&lt; W &gt;</a>, <a class="el" href="classgrpc__impl_1_1_client_async_reader_writer.html#ad70d82540b30f39a119306c0e7ba3b2c">grpc_impl::ClientAsyncReaderWriter&lt; W, R &gt;</a>, and <a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a2d4f04e9e37879524463f9c5e3c88365">grpc_impl::ClientAsyncWriter&lt; W &gt;</a>.</p>

</div>
</div>
<a id="a05ab1b1965def7cec0324fe27b0fa67f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05ab1b1965def7cec0324fe27b0fa67f">&#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_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface</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>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</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>Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em> with identifying tag <em>tag</em>. </p>
<p>For client, WriteLast is equivalent of performing Write and WritesDone in a single step. For server, WriteLast buffers the <em>msg</em>. The writing of <em>msg</em> is held until Finish is called, where <em>msg</em> and trailing metadata are coalesced and write is initiated. 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>
<p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</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. </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>
    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </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_2async__stream__impl_8h_source.html">async_stream_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>