natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/cpp/classgrpc__impl_1_1_server_...

253 lines
20 KiB
HTML
Raw Blame History

<!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_impl::ServerCompletionQueue 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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html">ServerCompletionQueue</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> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">grpc_impl::ServerCompletionQueue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A specific type of completion queue used by the processing of notifications by servers.
<a href="classgrpc__impl_1_1_server_completion_queue.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="completion__queue__impl_8h_source.html">completion_queue_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:aab40c635d653b9d9c57a17e88b776c0d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html#aab40c635d653b9d9c57a17e88b776c0d">IsFrequentlyPolled</a> ()</td></tr>
<tr class="separator:aab40c635d653b9d9c57a17e88b776c0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1_completion_queue.html">grpc_impl::CompletionQueue</a></td></tr>
<tr class="memitem:a0a72d9b5d2cd4715e469176d0a5f892b inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a0a72d9b5d2cd4715e469176d0a5f892b">CompletionQueue</a> ()</td></tr>
<tr class="memdesc:a0a72d9b5d2cd4715e469176d0a5f892b inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="classgrpc__impl_1_1_completion_queue.html#a0a72d9b5d2cd4715e469176d0a5f892b">More...</a><br /></td></tr>
<tr class="separator:a0a72d9b5d2cd4715e469176d0a5f892b inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae13d556ceec897318f90f4b44330b8f8 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#ae13d556ceec897318f90f4b44330b8f8">CompletionQueue</a> (<a class="el" href="grpc__types_8h.html#a895faab0e6035445750e43482651ba2f">grpc_completion_queue</a> *take)</td></tr>
<tr class="memdesc:ae13d556ceec897318f90f4b44330b8f8 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap <em>take</em>, taking ownership of the instance. <a href="classgrpc__impl_1_1_completion_queue.html#ae13d556ceec897318f90f4b44330b8f8">More...</a><br /></td></tr>
<tr class="separator:ae13d556ceec897318f90f4b44330b8f8 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8db87c5da5b8c332f51eede1ef4ad4fa inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a8db87c5da5b8c332f51eede1ef4ad4fa">~CompletionQueue</a> ()</td></tr>
<tr class="memdesc:a8db87c5da5b8c332f51eede1ef4ad4fa inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. Destroys the owned wrapped completion queue / instance. <a href="classgrpc__impl_1_1_completion_queue.html#a8db87c5da5b8c332f51eede1ef4ad4fa">More...</a><br /></td></tr>
<tr class="separator:a8db87c5da5b8c332f51eede1ef4ad4fa inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed4c03e1d101c102ef289c2c472aa933 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#aed4c03e1d101c102ef289c2c472aa933">Next</a> (void **tag, bool *ok)</td></tr>
<tr class="memdesc:aed4c03e1d101c102ef289c2c472aa933 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read from the queue, blocking until an event is available or the queue is shutting down. <a href="classgrpc__impl_1_1_completion_queue.html#aed4c03e1d101c102ef289c2c472aa933">More...</a><br /></td></tr>
<tr class="separator:aed4c03e1d101c102ef289c2c472aa933 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24cf4713366562fd4a1ff90434e23829 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a24cf4713366562fd4a1ff90434e23829 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6">NextStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a24cf4713366562fd4a1ff90434e23829">AsyncNext</a> (void **tag, bool *ok, const T &amp;deadline)</td></tr>
<tr class="memdesc:a24cf4713366562fd4a1ff90434e23829 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read from the queue, blocking up to <em>deadline</em> (or the queue's shutdown). <a href="classgrpc__impl_1_1_completion_queue.html#a24cf4713366562fd4a1ff90434e23829">More...</a><br /></td></tr>
<tr class="separator:a24cf4713366562fd4a1ff90434e23829 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89d42b8652d1502709f3ea37f0b872c5 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memTemplParams" colspan="2">template&lt;typename T , typename F &gt; </td></tr>
<tr class="memitem:a89d42b8652d1502709f3ea37f0b872c5 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6">NextStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a89d42b8652d1502709f3ea37f0b872c5">DoThenAsyncNext</a> (F &amp;&amp;f, void **tag, bool *ok, const T &amp;deadline)</td></tr>
<tr class="memdesc:a89d42b8652d1502709f3ea37f0b872c5 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL First executes <em>F</em>, then reads from the queue, blocking up to <em>deadline</em> (or the queue's shutdown). <a href="classgrpc__impl_1_1_completion_queue.html#a89d42b8652d1502709f3ea37f0b872c5">More...</a><br /></td></tr>
<tr class="separator:a89d42b8652d1502709f3ea37f0b872c5 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cabb9bf86168f3869682b485d903b45 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a5cabb9bf86168f3869682b485d903b45">Shutdown</a> ()</td></tr>
<tr class="memdesc:a5cabb9bf86168f3869682b485d903b45 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the shutdown of the queue. <a href="classgrpc__impl_1_1_completion_queue.html#a5cabb9bf86168f3869682b485d903b45">More...</a><br /></td></tr>
<tr class="separator:a5cabb9bf86168f3869682b485d903b45 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0de0d3e77b8e360a97feb53adc126d1 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a895faab0e6035445750e43482651ba2f">grpc_completion_queue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#ae0de0d3e77b8e360a97feb53adc126d1">cq</a> ()</td></tr>
<tr class="memdesc:ae0de0d3e77b8e360a97feb53adc126d1 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <em>raw</em> pointer to the underlying <em>grpc_completion_queue</em> instance. <a href="classgrpc__impl_1_1_completion_queue.html#ae0de0d3e77b8e360a97feb53adc126d1">More...</a><br /></td></tr>
<tr class="separator:ae0de0d3e77b8e360a97feb53adc126d1 inherit pub_methods_classgrpc__impl_1_1_completion_queue"><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:aa4266c1993b80999958bbedc872ba8fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html#aa4266c1993b80999958bbedc872ba8fd">ServerCompletionQueue</a> ()</td></tr>
<tr class="memdesc:aa4266c1993b80999958bbedc872ba8fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#aa4266c1993b80999958bbedc872ba8fd">More...</a><br /></td></tr>
<tr class="separator:aa4266c1993b80999958bbedc872ba8fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classgrpc__impl_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc__impl_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc__impl_1_1_completion_queue.html">grpc_impl::CompletionQueue</a></td></tr>
<tr class="memitem:a3c5a2d34e349a9133f7c4448b3e25e13 inherit pro_methods_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a3c5a2d34e349a9133f7c4448b3e25e13">CompletionQueue</a> (const <a class="el" href="structgrpc__completion__queue__attributes.html">grpc_completion_queue_attributes</a> &amp;attributes)</td></tr>
<tr class="memdesc:a3c5a2d34e349a9133f7c4448b3e25e13 inherit pro_methods_classgrpc__impl_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Private constructor of <a class="el" href="classgrpc__impl_1_1_completion_queue.html" title="A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue.h). ">CompletionQueue</a> only visible to friend classes. <a href="classgrpc__impl_1_1_completion_queue.html#a3c5a2d34e349a9133f7c4448b3e25e13">More...</a><br /></td></tr>
<tr class="separator:a3c5a2d34e349a9133f7c4448b3e25e13 inherit pro_methods_classgrpc__impl_1_1_completion_queue"><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:a81a5af0a3598381081010c789a284854"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html#a81a5af0a3598381081010c789a284854">::grpc_impl::ServerBuilder</a></td></tr>
<tr class="separator:a81a5af0a3598381081010c789a284854"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e6ceb26728f815024f4e836b9ffd56f"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html#a3e6ceb26728f815024f4e836b9ffd56f">::grpc_impl::Server</a></td></tr>
<tr class="separator:a3e6ceb26728f815024f4e836b9ffd56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classgrpc__impl_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classgrpc__impl_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classgrpc__impl_1_1_completion_queue.html">grpc_impl::CompletionQueue</a></td></tr>
<tr class="memitem:a09994ef9bb9a1166dc00277a41038eb6 inherit pub_types_classgrpc__impl_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6">NextStatus</a> { <a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6accd8fa78d5b7e43bbf0aaa84c585aa8c">SHUTDOWN</a>,
<a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6a3fde44665c846f88c2be67cebd9c767f">GOT_EVENT</a>,
<a class="el" href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6abb4a68c4685a155a2baf9565de7821b5">TIMEOUT</a>
}<tr class="memdesc:a09994ef9bb9a1166dc00277a41038eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tri-state return for AsyncNext: SHUTDOWN, GOT_EVENT, TIMEOUT. <a href="classgrpc__impl_1_1_completion_queue.html#a09994ef9bb9a1166dc00277a41038eb6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a09994ef9bb9a1166dc00277a41038eb6 inherit pub_types_classgrpc__impl_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A specific type of completion queue used by the processing of notifications by servers. </p>
<p>Instantiated by <em><a class="el" href="classgrpc__impl_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances. ">ServerBuilder</a></em>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa4266c1993b80999958bbedc872ba8fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4266c1993b80999958bbedc872ba8fd">&#9670;&nbsp;</a></span>ServerCompletionQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">grpc_impl::ServerCompletionQueue::ServerCompletionQueue </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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aab40c635d653b9d9c57a17e88b776c0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab40c635d653b9d9c57a17e88b776c0d">&#9670;&nbsp;</a></span>IsFrequentlyPolled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool grpc_impl::ServerCompletionQueue::IsFrequentlyPolled </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>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a3e6ceb26728f815024f4e836b9ffd56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e6ceb26728f815024f4e836b9ffd56f">&#9670;&nbsp;</a></span>::grpc_impl::Server</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class ::<a class="el" href="classgrpc__impl_1_1_server.html">grpc_impl::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>
<a id="a81a5af0a3598381081010c789a284854"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81a5af0a3598381081010c789a284854">&#9670;&nbsp;</a></span>::grpc_impl::ServerBuilder</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class ::<a class="el" href="classgrpc__impl_1_1_server_builder.html">grpc_impl::ServerBuilder</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 file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="completion__queue__impl_8h_source.html">completion_queue_impl.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>
Reference in New Issue View Git Blame Copy Permalink