grpc/cpp/classgrpc_1_1_server_callba...

348 lines
20 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::ServerCallbackReaderWriter&lt; Request, Response &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.58.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_callback_reader_writer.html">ServerCallbackReaderWriter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">grpc::ServerCallbackReaderWriter&lt; Request, Response &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="support_2server__callback_8h_source.html">server_callback.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:afc60f14edd7ea8ce0d4bb3410e05783d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#afc60f14edd7ea8ce0d4bb3410e05783d">~ServerCallbackReaderWriter</a> () override</td></tr>
<tr class="separator:afc60f14edd7ea8ce0d4bb3410e05783d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cc301b90204307f41a409a5efdcaf98"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#a1cc301b90204307f41a409a5efdcaf98">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)=0</td></tr>
<tr class="separator:a1cc301b90204307f41a409a5efdcaf98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af04fc504f776c5dd73670c489fd2d324"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#af04fc504f776c5dd73670c489fd2d324">SendInitialMetadata</a> ()=0</td></tr>
<tr class="separator:af04fc504f776c5dd73670c489fd2d324"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a357fac7fe4cfe406b0d77f1646245027"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#a357fac7fe4cfe406b0d77f1646245027">Read</a> (Request *msg)=0</td></tr>
<tr class="separator:a357fac7fe4cfe406b0d77f1646245027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59f372e7b2900dab03b410ab0ed63091"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#a59f372e7b2900dab03b410ab0ed63091">Write</a> (const Response *msg, <a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)=0</td></tr>
<tr class="separator:a59f372e7b2900dab03b410ab0ed63091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa83a9063ccce698c7cbf2537adc5a82d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#aa83a9063ccce698c7cbf2537adc5a82d">WriteAndFinish</a> (const Response *msg, <a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, <a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)=0</td></tr>
<tr class="separator:aa83a9063ccce698c7cbf2537adc5a82d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html">grpc::internal::ServerCallbackCall</a></td></tr>
<tr class="memitem:afd1da77659ae44af4e4984ce4c615538 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#afd1da77659ae44af4e4984ce4c615538">~ServerCallbackCall</a> ()</td></tr>
<tr class="separator:afd1da77659ae44af4e4984ce4c615538 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f5d1ec7fefd1a27aa5928c31f7e38df inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a8f5d1ec7fefd1a27aa5928c31f7e38df">MaybeDone</a> ()</td></tr>
<tr class="separator:a8f5d1ec7fefd1a27aa5928c31f7e38df inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91963708bf926cc62582440c7fedd051 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a91963708bf926cc62582440c7fedd051">MaybeDone</a> (bool inline_ondone)</td></tr>
<tr class="separator:a91963708bf926cc62582440c7fedd051 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e8341db8a1636364a8a4205114a3fe inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a81e8341db8a1636364a8a4205114a3fe">MaybeCallOnCancel</a> (<a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html">ServerReactor</a> *reactor)</td></tr>
<tr class="separator:a81e8341db8a1636364a8a4205114a3fe inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab23641e1ee96f910f325992c514101 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a1ab23641e1ee96f910f325992c514101">MaybeCallOnCancel</a> ()</td></tr>
<tr class="separator:a1ab23641e1ee96f910f325992c514101 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a1bc2639c5be5a04268270acb25456257"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader_writer.html#a1bc2639c5be5a04268270acb25456257">BindReactor</a> (<a class="el" href="classgrpc_1_1_server_bidi_reactor.html">ServerBidiReactor</a>&lt; Request, Response &gt; *reactor)</td></tr>
<tr class="separator:a1bc2639c5be5a04268270acb25456257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html">grpc::internal::ServerCallbackCall</a></td></tr>
<tr class="memitem:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#abf7d5b632ff79a688b342b235275be72">Ref</a> ()</td></tr>
<tr class="memdesc:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases the reference count. <a href="classgrpc_1_1internal_1_1_server_callback_call.html#abf7d5b632ff79a688b342b235275be72">More...</a><br /></td></tr>
<tr class="separator:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afc60f14edd7ea8ce0d4bb3410e05783d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc60f14edd7ea8ce0d4bb3410e05783d">&#9670;&nbsp;</a></span>~ServerCallbackReaderWriter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &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_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::~<a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</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">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1bc2639c5be5a04268270acb25456257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bc2639c5be5a04268270acb25456257">&#9670;&nbsp;</a></span>BindReactor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &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_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::BindReactor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html">ServerBidiReactor</a>&lt; Request, Response &gt; *&#160;</td>
<td class="paramname"><em>reactor</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1cc301b90204307f41a409a5efdcaf98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cc301b90204307f41a409a5efdcaf98">&#9670;&nbsp;</a></span>Finish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
<td class="paramname"><em>s</em></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">
</div>
</div>
<a id="a357fac7fe4cfe406b0d77f1646245027"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a357fac7fe4cfe406b0d77f1646245027">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Read </td>
<td>(</td>
<td class="paramtype">Request *&#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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af04fc504f776c5dd73670c489fd2d324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af04fc504f776c5dd73670c489fd2d324">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a59f372e7b2900dab03b410ab0ed63091"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59f372e7b2900dab03b410ab0ed63091">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Write </td>
<td>(</td>
<td class="paramtype">const Response *&#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">
</div>
</div>
<a id="aa83a9063ccce698c7cbf2537adc5a82d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa83a9063ccce698c7cbf2537adc5a82d">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">grpc::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::WriteAndFinish </td>
<td>(</td>
<td class="paramtype">const Response *&#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"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
<td class="paramname"><em>s</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">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/support/<a class="el" href="support_2server__callback_8h_source.html">server_callback.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 6 2023 16:09: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>