grpc/cpp/classgrpc_1_1_server_async_...

439 lines
22 KiB
HTML

<!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::ServerAsyncReaderWriter&lt; W, R &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.64.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.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html">ServerAsyncReaderWriter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">grpc::ServerAsyncReaderWriter&lt; W, R &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream coming from the client has messages of type <em>R</em>, and the outgoing message stream coming from the server has messages of type <em>W</em>.
<a href="classgrpc_1_1_server_async_reader_writer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2server__context_8h_source.html">server_context.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:a617d8aa6fc75504a2a6dadd93549b6d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a617d8aa6fc75504a2a6dadd93549b6d9">ServerAsyncReaderWriter</a> (<a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> *ctx)</td></tr>
<tr class="separator:a617d8aa6fc75504a2a6dadd93549b6d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c8e237a99a177ef68c37ad0de100499"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a1c8e237a99a177ef68c37ad0de100499">SendInitialMetadata</a> (void *tag) override</td></tr>
<tr class="memdesc:a1c8e237a99a177ef68c37ad0de100499"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. <a href="classgrpc_1_1_server_async_reader_writer.html#a1c8e237a99a177ef68c37ad0de100499">More...</a><br /></td></tr>
<tr class="separator:a1c8e237a99a177ef68c37ad0de100499"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a911d41783f644e170c017bb3032ca5c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a911d41783f644e170c017bb3032ca5c8">Read</a> (R *msg, void *tag) override</td></tr>
<tr class="separator:a911d41783f644e170c017bb3032ca5c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a816fd9065473a24d4ab613ee2ecb19e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a816fd9065473a24d4ab613ee2ecb19e1">Write</a> (const W &amp;msg, void *tag) override</td></tr>
<tr class="separator:a816fd9065473a24d4ab613ee2ecb19e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed023e1acec29eadcc44c83f28e6dd72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#aed023e1acec29eadcc44c83f28e6dd72">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag) override</td></tr>
<tr class="separator:aed023e1acec29eadcc44c83f28e6dd72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fb95e4a199481fbe8ede8bb5ab0e63a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a2fb95e4a199481fbe8ede8bb5ab0e63a">WriteAndFinish</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, const <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;status, void *tag) override</td></tr>
<tr class="memdesc:a2fb95e4a199481fbe8ede8bb5ab0e63a"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a174e5314d443a9282438badf9bb21244" title="Request the writing of msg and coalesce it with trailing metadata which contains status,...">ServerAsyncReaderWriterInterface.WriteAndFinish</a></em> method for semantics. <a href="classgrpc_1_1_server_async_reader_writer.html#a2fb95e4a199481fbe8ede8bb5ab0e63a">More...</a><br /></td></tr>
<tr class="separator:a2fb95e4a199481fbe8ede8bb5ab0e63a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59b558feb5a47c7869843ec031692394"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a59b558feb5a47c7869843ec031692394">Finish</a> (const <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;status, void *tag) override</td></tr>
<tr class="memdesc:a59b558feb5a47c7869843ec031692394"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae63d347d413c401b1e976f165efde50b" title="Indicate that the stream is to be finished with a certain status code.">ServerAsyncReaderWriterInterface.Finish</a></em> method for semantics. <a href="classgrpc_1_1_server_async_reader_writer.html#a59b558feb5a47c7869843ec031692394">More...</a><br /></td></tr>
<tr class="separator:a59b558feb5a47c7869843ec031692394"><td class="memSeparator" colspan="2">&#160;</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:a9028997af40019c547a36227c988576f"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a9028997af40019c547a36227c988576f">grpc::Server</a></td></tr>
<tr class="separator:a9028997af40019c547a36227c988576f"><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, class R&gt;<br />
class grpc::ServerAsyncReaderWriter&lt; W, R &gt;</h3>
<p>Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream coming from the client has messages of type <em>R</em>, and the outgoing message stream coming from the server has messages of type <em>W</em>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a617d8aa6fc75504a2a6dadd93549b6d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a617d8aa6fc75504a2a6dadd93549b6d9">&#9670;&nbsp;</a></span>ServerAsyncReaderWriter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::<a class="el" href="classgrpc_1_1_server_async_reader_writer.html">ServerAsyncReaderWriter</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a59b558feb5a47c7869843ec031692394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59b558feb5a47c7869843ec031692394">&#9670;&nbsp;</a></span>Finish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Finish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;&#160;</td>
<td class="paramname"><em>status</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 class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae63d347d413c401b1e976f165efde50b" title="Indicate that the stream is to be finished with a certain status code.">ServerAsyncReaderWriterInterface.Finish</a></em> method for semantics. </p>
<p>Implicit input parameter:</p><ul>
<li>the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a></em> associated with this call is used for sending trailing (and initial if not already sent) metadata to the client.</li>
</ul>
<p>Note: there are no restrictions are the code of <em>status</em>, it may be non-OK gRPC doesn't take ownership or a reference to <em>status</em>, so it is safe to to deallocate once Finish returns. </p>
</div>
</div>
<a id="a911d41783f644e170c017bb3032ca5c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a911d41783f644e170c017bb3032ca5c8">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Read </td>
<td>(</td>
<td class="paramtype">R *&#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">inline</span><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1c8e237a99a177ef68c37ad0de100499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c8e237a99a177ef68c37ad0de100499">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::SendInitialMetadata </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. </p>
<p>Implicit input parameter:</p><ul>
<li>The initial metadata that will be sent to the client from this op will be taken from the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a></em> associated with the call.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aed023e1acec29eadcc44c83f28e6dd72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed023e1acec29eadcc44c83f28e6dd72">&#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 , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &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">inline</span><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a816fd9065473a24d4ab613ee2ecb19e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a816fd9065473a24d4ab613ee2ecb19e1">&#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 , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &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">inline</span><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2fb95e4a199481fbe8ede8bb5ab0e63a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fb95e4a199481fbe8ede8bb5ab0e63a">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </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_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::WriteAndFinish </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">const <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;&#160;</td>
<td class="paramname"><em>status</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 class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a174e5314d443a9282438badf9bb21244" title="Request the writing of msg and coalesce it with trailing metadata which contains status,...">ServerAsyncReaderWriterInterface.WriteAndFinish</a></em> method for semantics. </p>
<p>Implicit input parameter:</p><ul>
<li>the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a></em> associated with this call is used for sending trailing (and initial) metadata to the client.</li>
</ul>
<p>Note: <em>status</em> must have an OK code. gRPC doesn't take ownership or a reference to <em>msg</em> and <em>status</em>, so it is safe to deallocate once WriteAndFinish returns. </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a9028997af40019c547a36227c988576f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9028997af40019c547a36227c988576f">&#9670;&nbsp;</a></span>grpc::Server</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgrpc_1_1_server.html">grpc::Server</a></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 files:<ul>
<li>include/grpcpp/<a class="el" href="grpcpp_2server__context_8h_source.html">server_context.h</a></li>
<li>include/grpcpp/support/<a class="el" href="grpcpp_2support_2async__stream_8h_source.html">async_stream.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:16 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>