carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
							<!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::experimental::ServerCallbackRpcController Class 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.22.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.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html">ServerCallbackRpcController</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::experimental::ServerCallbackRpcController Class 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_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:a54d215fbfdcc98abf4a871bdb5262e2c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#a54d215fbfdcc98abf4a871bdb5262e2c">~ServerCallbackRpcController</a> ()=default</td></tr>
<tr class="separator:a54d215fbfdcc98abf4a871bdb5262e2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9babb0b7e6943ea6477d684cd1261ddc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#a9babb0b7e6943ea6477d684cd1261ddc">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> s)=0</td></tr>
<tr class="separator:a9babb0b7e6943ea6477d684cd1261ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae47dc9b51d25654f3bc5bf36e91c91d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#aae47dc9b51d25654f3bc5bf36e91c91d">SendInitialMetadata</a> (std::function&lt; void(bool)&gt;)=0</td></tr>
<tr class="separator:aae47dc9b51d25654f3bc5bf36e91c91d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9940a869da7f30cdae6dbe47bcbad53d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#a9940a869da7f30cdae6dbe47bcbad53d">SetCancelCallback</a> (std::function&lt; void()&gt; callback)=0</td></tr>
<tr class="memdesc:a9940a869da7f30cdae6dbe47bcbad53d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SetCancelCallback passes in a callback to be called when the RPC is canceled for whatever reason (streaming calls have OnCancel instead).  <a href="#a9940a869da7f30cdae6dbe47bcbad53d">More...</a><br /></td></tr>
<tr class="separator:a9940a869da7f30cdae6dbe47bcbad53d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89949141e05b78997dc86c4e33962621"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#a89949141e05b78997dc86c4e33962621">ClearCancelCallback</a> ()=0</td></tr>
<tr class="separator:a89949141e05b78997dc86c4e33962621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc084be1aeee4efa3641cd0bcadc061"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1experimental_1_1_rpc_allocator_state.html">RpcAllocatorState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_rpc_controller.html#a4bc084be1aeee4efa3641cd0bcadc061">GetRpcAllocatorState</a> ()=0</td></tr>
<tr class="separator:a4bc084be1aeee4efa3641cd0bcadc061"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a54d215fbfdcc98abf4a871bdb5262e2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54d215fbfdcc98abf4a871bdb5262e2c">&#9670;&nbsp;</a></span>~ServerCallbackRpcController()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual grpc::experimental::ServerCallbackRpcController::~ServerCallbackRpcController </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</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="a89949141e05b78997dc86c4e33962621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89949141e05b78997dc86c4e33962621">&#9670;&nbsp;</a></span>ClearCancelCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::experimental::ServerCallbackRpcController::ClearCancelCallback </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="a9babb0b7e6943ea6477d684cd1261ddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9babb0b7e6943ea6477d684cd1261ddc">&#9670;&nbsp;</a></span>Finish()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::experimental::ServerCallbackRpcController::Finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">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="a4bc084be1aeee4efa3641cd0bcadc061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc084be1aeee4efa3641cd0bcadc061">&#9670;&nbsp;</a></span>GetRpcAllocatorState()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classgrpc_1_1experimental_1_1_rpc_allocator_state.html">RpcAllocatorState</a>* grpc::experimental::ServerCallbackRpcController::GetRpcAllocatorState </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="aae47dc9b51d25654f3bc5bf36e91c91d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae47dc9b51d25654f3bc5bf36e91c91d">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::experimental::ServerCallbackRpcController::SendInitialMetadata </td>
          <td>(</td>
          <td class="paramtype">std::function&lt; void(bool)&gt;&#160;</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="a9940a869da7f30cdae6dbe47bcbad53d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9940a869da7f30cdae6dbe47bcbad53d">&#9670;&nbsp;</a></span>SetCancelCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::experimental::ServerCallbackRpcController::SetCancelCallback </td>
          <td>(</td>
          <td class="paramtype">std::function&lt; void()&gt;&#160;</td>
          <td class="paramname"><em>callback</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">

<p>SetCancelCallback passes in a callback to be called when the RPC is canceled for whatever reason (streaming calls have OnCancel instead). </p>
<p>This is an advanced and uncommon use with several important restrictions. This function may not be called more than once on the same RPC.</p>
<p>If code calls SetCancelCallback on an RPC, it must also call ClearCancelCallback before calling Finish on the RPC controller. That method makes sure that no cancellation callback is executed for this RPC beyond the point of its return. ClearCancelCallback may be called even if SetCancelCallback was not called for this RPC, and it may be called multiple times. It <em>must</em> be called if SetCancelCallback was called for this RPC.</p>
<p>The callback should generally be lightweight and nonblocking and primarily concerned with clearing application state related to the RPC or causing operations (such as cancellations) to happen on dependent RPCs.</p>
<p>If the RPC is already canceled at the time that SetCancelCallback is called, the callback is invoked immediately.</p>
<p>The cancellation callback may be executed concurrently with the method handler that invokes it but will certainly not issue or execute after the return of ClearCancelCallback. If ClearCancelCallback is invoked while the callback is already executing, the callback will complete its execution before ClearCancelCallback takes effect.</p>
<p>To preserve the orderings described above, the callback may be called under a lock that is also used for ClearCancelCallback and <a class="el" href="classgrpc__impl_1_1_server_context.html#ac0fe2a9425b18b724f910adbe0e3c17a" title="IsCancelled is always safe to call when using sync or callback API. ">ServerContext::IsCancelled</a>, so the callback CANNOT call either of those operations on this RPC or any other function that causes those operations to be called before the callback completes. </p>

</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_8h_source.html">server_callback.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 3 2019 14:51:27 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>