| <!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::ServerReadReactor< Request > 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++ |
|  <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&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&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_read_reactor.html">ServerReadReactor</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Data Structures</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> </div> |
| <div class="headertitle"> |
| <div class="title">grpc::ServerReadReactor< Request > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><em><a class="el" href="classgrpc_1_1_server_read_reactor.html" title="ServerReadReactor is the interface for a client-streaming RPC.">ServerReadReactor</a></em> is the interface for a client-streaming RPC. |
| <a href="classgrpc_1_1_server_read_reactor.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="support_2server__callback_8h_source.html">server_callback.h</a>></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:afba3ccd66657bad3551408bf4ea347f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#afba3ccd66657bad3551408bf4ea347f9">ServerReadReactor</a> ()</td></tr> |
| <tr class="separator:afba3ccd66657bad3551408bf4ea347f9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7f4cc893ade9930366ef0e514b16016"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#af7f4cc893ade9930366ef0e514b16016">~ServerReadReactor</a> () override=default</td></tr> |
| <tr class="separator:af7f4cc893ade9930366ef0e514b16016"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f766571244828db27c670ae5f28d068"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#a4f766571244828db27c670ae5f28d068">StartSendInitialMetadata</a> () ABSL_LOCKS_EXCLUDED(reader_mu_)</td></tr> |
| <tr class="memdesc:a4f766571244828db27c670ae5f28d068"><td class="mdescLeft"> </td><td class="mdescRight">The following operation initiations are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. <a href="classgrpc_1_1_server_read_reactor.html#a4f766571244828db27c670ae5f28d068">More...</a><br /></td></tr> |
| <tr class="separator:a4f766571244828db27c670ae5f28d068"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aebf68c8d6cdd9a92c4741fb43d05d128"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#aebf68c8d6cdd9a92c4741fb43d05d128">StartRead</a> (Request *req) ABSL_LOCKS_EXCLUDED(reader_mu_)</td></tr> |
| <tr class="separator:aebf68c8d6cdd9a92c4741fb43d05d128"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b482b70e68641a854543c46869c88ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#a1b482b70e68641a854543c46869c88ee">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s) ABSL_LOCKS_EXCLUDED(reader_mu_)</td></tr> |
| <tr class="separator:a1b482b70e68641a854543c46869c88ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5732a605279da840b23579124ab44e2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#af5732a605279da840b23579124ab44e2">OnSendInitialMetadataDone</a> (bool)</td></tr> |
| <tr class="memdesc:af5732a605279da840b23579124ab44e2"><td class="mdescLeft"> </td><td class="mdescRight">The following notifications are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. <a href="classgrpc_1_1_server_read_reactor.html#af5732a605279da840b23579124ab44e2">More...</a><br /></td></tr> |
| <tr class="separator:af5732a605279da840b23579124ab44e2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed1d61d92971c0b49a80c8cedcfb959e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#aed1d61d92971c0b49a80c8cedcfb959e">OnReadDone</a> (bool)</td></tr> |
| <tr class="separator:aed1d61d92971c0b49a80c8cedcfb959e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ada848e5dacf093b879a1e5d853f68d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#a7ada848e5dacf093b879a1e5d853f68d">OnDone</a> () override=0</td></tr> |
| <tr class="separator:a7ada848e5dacf093b879a1e5d853f68d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7e18dcff721d570bada258cef530b05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#ad7e18dcff721d570bada258cef530b05">OnCancel</a> () override</td></tr> |
| <tr class="separator:ad7e18dcff721d570bada258cef530b05"><td class="memSeparator" colspan="2"> </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:a07a17206f02027eb9b10cfc3174e0476"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_read_reactor.html#a07a17206f02027eb9b10cfc3174e0476">ServerCallbackReader< Request ></a></td></tr> |
| <tr class="separator:a07a17206f02027eb9b10cfc3174e0476"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class Request><br /> |
| class grpc::ServerReadReactor< Request ></h3> |
| |
| <p><em><a class="el" href="classgrpc_1_1_server_read_reactor.html" title="ServerReadReactor is the interface for a client-streaming RPC.">ServerReadReactor</a></em> is the interface for a client-streaming RPC. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="afba3ccd66657bad3551408bf4ea347f9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afba3ccd66657bad3551408bf4ea347f9">◆ </a></span>ServerReadReactor()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classgrpc_1_1_server_read_reactor.html">grpc::ServerReadReactor</a>< Request >::<a class="el" href="classgrpc_1_1_server_read_reactor.html">ServerReadReactor</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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="af7f4cc893ade9930366ef0e514b16016"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7f4cc893ade9930366ef0e514b16016">◆ </a></span>~ServerReadReactor()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classgrpc_1_1_server_read_reactor.html">grpc::ServerReadReactor</a>< Request >::~<a class="el" href="classgrpc_1_1_server_read_reactor.html">ServerReadReactor</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">override</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a1b482b70e68641a854543c46869c88ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1b482b70e68641a854543c46869c88ee">◆ </a></span>Finish()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::Finish </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ad7e18dcff721d570bada258cef530b05"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad7e18dcff721d570bada258cef530b05">◆ </a></span>OnCancel()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::OnCancel </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> |
| <a id="a7ada848e5dacf093b879a1e5d853f68d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7ada848e5dacf093b879a1e5d853f68d">◆ </a></span>OnDone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::OnDone </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aed1d61d92971c0b49a80c8cedcfb959e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed1d61d92971c0b49a80c8cedcfb959e">◆ </a></span>OnReadDone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::OnReadDone </td> |
| <td>(</td> |
| <td class="paramtype">bool </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> |
| <a id="af5732a605279da840b23579124ab44e2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af5732a605279da840b23579124ab44e2">◆ </a></span>OnSendInitialMetadataDone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::OnSendInitialMetadataDone </td> |
| <td>(</td> |
| <td class="paramtype">bool </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"> |
| |
| <p>The following notifications are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. </p> |
| |
| </div> |
| </div> |
| <a id="aebf68c8d6cdd9a92c4741fb43d05d128"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aebf68c8d6cdd9a92c4741fb43d05d128">◆ </a></span>StartRead()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::StartRead </td> |
| <td>(</td> |
| <td class="paramtype">Request * </td> |
| <td class="paramname"><em>req</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"> |
| |
| </div> |
| </div> |
| <a id="a4f766571244828db27c670ae5f28d068"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4f766571244828db27c670ae5f28d068">◆ </a></span>StartSendInitialMetadata()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_read_reactor.html">grpc::ServerReadReactor</a>< Request >::StartSendInitialMetadata </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The following operation initiations are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="a07a17206f02027eb9b10cfc3174e0476"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a07a17206f02027eb9b10cfc3174e0476">◆ </a></span>ServerCallbackReader< Request ></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class Request > </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_callback_reader.html">ServerCallbackReader</a>< Request ></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 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 Fri May 17 2024 01:17:16 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |