grpc/cpp/classgrpc__impl_1_1_server_...

318 lines
18 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_impl::ServerCallbackWriter&lt; 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.31.1</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="classgrpc__impl_1_1_server_callback_writer.html">ServerCallbackWriter</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_impl::ServerCallbackWriter&lt; 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="impl_2codegen_2server__callback__impl_8h_source.html">server_callback_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:ab5552491e0aac8925f4dc0145a237516"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#ab5552491e0aac8925f4dc0145a237516">~ServerCallbackWriter</a> ()</td></tr>
<tr class="separator:ab5552491e0aac8925f4dc0145a237516"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe471666c3044cd03b2e48dfb0397049"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#abe471666c3044cd03b2e48dfb0397049">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)=0</td></tr>
<tr class="separator:abe471666c3044cd03b2e48dfb0397049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabe144c8b8c193211b3129a64364ac2b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#aabe144c8b8c193211b3129a64364ac2b">SendInitialMetadata</a> ()=0</td></tr>
<tr class="separator:aabe144c8b8c193211b3129a64364ac2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa8d1a20b676ac00ff21cd6b8c6b88a2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#afa8d1a20b676ac00ff21cd6b8c6b88a2">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:afa8d1a20b676ac00ff21cd6b8c6b88a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fc3b55cae21542874e3ebad100e7fee"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#a8fc3b55cae21542874e3ebad100e7fee">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:a8fc3b55cae21542874e3ebad100e7fee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_server_callback_call.html">grpc_impl::internal::ServerCallbackCall</a></td></tr>
<tr class="memitem:aad9edfddafcb9c94008f13f075803277 inherit pub_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#aad9edfddafcb9c94008f13f075803277">~ServerCallbackCall</a> ()</td></tr>
<tr class="separator:aad9edfddafcb9c94008f13f075803277 inherit pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6661f82c964fff96e760fec750ded93 inherit pub_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#ab6661f82c964fff96e760fec750ded93">MaybeDone</a> ()</td></tr>
<tr class="separator:ab6661f82c964fff96e760fec750ded93 inherit pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad56f7039c14b2671b383a4bc1a030cd7 inherit pub_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#ad56f7039c14b2671b383a4bc1a030cd7">MaybeDone</a> (bool inline_ondone)</td></tr>
<tr class="separator:ad56f7039c14b2671b383a4bc1a030cd7 inherit pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97a39853917ae10cef4ac92b3e2fa0b9 inherit pub_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#a97a39853917ae10cef4ac92b3e2fa0b9">MaybeCallOnCancel</a> (<a class="el" href="classgrpc__impl_1_1internal_1_1_server_reactor.html">ServerReactor</a> *reactor)</td></tr>
<tr class="separator:a97a39853917ae10cef4ac92b3e2fa0b9 inherit pub_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf31e9423fd316c02245a4fb68740ab9 inherit pub_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#acf31e9423fd316c02245a4fb68740ab9">MaybeCallOnCancel</a> ()</td></tr>
<tr class="separator:acf31e9423fd316c02245a4fb68740ab9 inherit pub_methods_classgrpc__impl_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:a77d7add5bfce9798fcb98a32ecbbb9f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_callback_writer.html#a77d7add5bfce9798fcb98a32ecbbb9f5">BindReactor</a> (<a class="el" href="classgrpc__impl_1_1_server_write_reactor.html">ServerWriteReactor</a>&lt; Response &gt; *reactor)</td></tr>
<tr class="separator:a77d7add5bfce9798fcb98a32ecbbb9f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc__impl_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_server_callback_call.html">grpc_impl::internal::ServerCallbackCall</a></td></tr>
<tr class="memitem:aa1093ddb04be88a3bd4cc21e2ecae15d inherit pro_methods_classgrpc__impl_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__impl_1_1internal_1_1_server_callback_call.html#aa1093ddb04be88a3bd4cc21e2ecae15d">Ref</a> ()</td></tr>
<tr class="memdesc:aa1093ddb04be88a3bd4cc21e2ecae15d inherit pro_methods_classgrpc__impl_1_1internal_1_1_server_callback_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases the reference count. <a href="classgrpc__impl_1_1internal_1_1_server_callback_call.html#aa1093ddb04be88a3bd4cc21e2ecae15d">More...</a><br /></td></tr>
<tr class="separator:aa1093ddb04be88a3bd4cc21e2ecae15d inherit pro_methods_classgrpc__impl_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="ab5552491e0aac8925f4dc0145a237516"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5552491e0aac8925f4dc0145a237516">&#9670;&nbsp;</a></span>~ServerCallbackWriter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Response &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_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; Response &gt;::~<a class="el" href="classgrpc__impl_1_1_server_callback_writer.html">ServerCallbackWriter</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="a77d7add5bfce9798fcb98a32ecbbb9f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77d7add5bfce9798fcb98a32ecbbb9f5">&#9670;&nbsp;</a></span>BindReactor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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__impl_1_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; Response &gt;::BindReactor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgrpc__impl_1_1_server_write_reactor.html">ServerWriteReactor</a>&lt; 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="abe471666c3044cd03b2e48dfb0397049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe471666c3044cd03b2e48dfb0397049">&#9670;&nbsp;</a></span>Finish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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__impl_1_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; 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="aabe144c8b8c193211b3129a64364ac2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabe144c8b8c193211b3129a64364ac2b">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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__impl_1_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; 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="afa8d1a20b676ac00ff21cd6b8c6b88a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa8d1a20b676ac00ff21cd6b8c6b88a2">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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__impl_1_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; 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="a8fc3b55cae21542874e3ebad100e7fee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc3b55cae21542874e3ebad100e7fee">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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__impl_1_1_server_callback_writer.html">grpc_impl::ServerCallbackWriter</a>&lt; 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/impl/codegen/<a class="el" href="impl_2codegen_2server__callback__impl_8h_source.html">server_callback_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 18 2020 16:24:48 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>