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

256 lines
20 KiB
HTML
Raw Blame History

<!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::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.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&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_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::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_1_1_server_completion_queue.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2completion__queue_8h_source.html">completion_queue.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:acdb6d4631a3e30737e3903986d69dc52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_completion_queue.html#acdb6d4631a3e30737e3903986d69dc52">IsFrequentlyPolled</a> ()</td></tr>
<tr class="separator:acdb6d4631a3e30737e3903986d69dc52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a></td></tr>
<tr class="memitem:aea987a15a475923e949934e481fe3566 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#aea987a15a475923e949934e481fe3566">CompletionQueue</a> ()</td></tr>
<tr class="memdesc:aea987a15a475923e949934e481fe3566 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="classgrpc_1_1_completion_queue.html#aea987a15a475923e949934e481fe3566">More...</a><br /></td></tr>
<tr class="separator:aea987a15a475923e949934e481fe3566 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a081a954044215a7ca8554da4220fb369 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a081a954044215a7ca8554da4220fb369">CompletionQueue</a> (<a class="el" href="grpc__types_8h.html#a895faab0e6035445750e43482651ba2f">grpc_completion_queue</a> *take)</td></tr>
<tr class="memdesc:a081a954044215a7ca8554da4220fb369 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap <em>take</em>, taking ownership of the instance. <a href="classgrpc_1_1_completion_queue.html#a081a954044215a7ca8554da4220fb369">More...</a><br /></td></tr>
<tr class="separator:a081a954044215a7ca8554da4220fb369 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776f9e04c58eaf26611d1d4360a055ed inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a776f9e04c58eaf26611d1d4360a055ed">~CompletionQueue</a> () override</td></tr>
<tr class="memdesc:a776f9e04c58eaf26611d1d4360a055ed inherit pub_methods_classgrpc_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. Destroys the owned wrapped completion queue / instance. <a href="classgrpc_1_1_completion_queue.html#a776f9e04c58eaf26611d1d4360a055ed">More...</a><br /></td></tr>
<tr class="separator:a776f9e04c58eaf26611d1d4360a055ed inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86d9810ced694e50f7987ac90b9f8c1a inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a86d9810ced694e50f7987ac90b9f8c1a">Next</a> (void **tag, bool *ok)</td></tr>
<tr class="memdesc:a86d9810ced694e50f7987ac90b9f8c1a inherit pub_methods_classgrpc_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_1_1_completion_queue.html#a86d9810ced694e50f7987ac90b9f8c1a">More...</a><br /></td></tr>
<tr class="separator:a86d9810ced694e50f7987ac90b9f8c1a inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a290ddf3d96e6d1d5886580e60b0602b4 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a290ddf3d96e6d1d5886580e60b0602b4 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572">NextStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a290ddf3d96e6d1d5886580e60b0602b4">AsyncNext</a> (void **tag, bool *ok, const T &amp;deadline)</td></tr>
<tr class="memdesc:a290ddf3d96e6d1d5886580e60b0602b4 inherit pub_methods_classgrpc_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_1_1_completion_queue.html#a290ddf3d96e6d1d5886580e60b0602b4">More...</a><br /></td></tr>
<tr class="separator:a290ddf3d96e6d1d5886580e60b0602b4 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af935df99ccd14bcfb674e89f0c077a8c inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memTemplParams" colspan="2">template&lt;typename T , typename F &gt; </td></tr>
<tr class="memitem:af935df99ccd14bcfb674e89f0c077a8c inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572">NextStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#af935df99ccd14bcfb674e89f0c077a8c">DoThenAsyncNext</a> (F &amp;&amp;f, void **tag, bool *ok, const T &amp;deadline)</td></tr>
<tr class="memdesc:af935df99ccd14bcfb674e89f0c077a8c inherit pub_methods_classgrpc_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_1_1_completion_queue.html#af935df99ccd14bcfb674e89f0c077a8c">More...</a><br /></td></tr>
<tr class="separator:af935df99ccd14bcfb674e89f0c077a8c inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40efddadd9073386fbcb4f46e8325670 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a40efddadd9073386fbcb4f46e8325670">Shutdown</a> ()</td></tr>
<tr class="memdesc:a40efddadd9073386fbcb4f46e8325670 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the shutdown of the queue. <a href="classgrpc_1_1_completion_queue.html#a40efddadd9073386fbcb4f46e8325670">More...</a><br /></td></tr>
<tr class="separator:a40efddadd9073386fbcb4f46e8325670 inherit pub_methods_classgrpc_1_1_completion_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999c317e716d1e74aca2eb050912302b inherit pub_methods_classgrpc_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_1_1_completion_queue.html#a999c317e716d1e74aca2eb050912302b">cq</a> ()</td></tr>
<tr class="memdesc:a999c317e716d1e74aca2eb050912302b inherit pub_methods_classgrpc_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_1_1_completion_queue.html#a999c317e716d1e74aca2eb050912302b">More...</a><br /></td></tr>
<tr class="separator:a999c317e716d1e74aca2eb050912302b inherit pub_methods_classgrpc_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:a1706983733b2a91c8df6712729cd6721"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_completion_queue.html#a1706983733b2a91c8df6712729cd6721">ServerCompletionQueue</a> ()</td></tr>
<tr class="memdesc:a1706983733b2a91c8df6712729cd6721"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="classgrpc_1_1_server_completion_queue.html#a1706983733b2a91c8df6712729cd6721">More...</a><br /></td></tr>
<tr class="separator:a1706983733b2a91c8df6712729cd6721"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classgrpc_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a></td></tr>
<tr class="memitem:abf1d4810de32ca2cc2c14c591b41d2cd inherit pro_methods_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#abf1d4810de32ca2cc2c14c591b41d2cd">CompletionQueue</a> (const <a class="el" href="structgrpc__completion__queue__attributes.html">grpc_completion_queue_attributes</a> &amp;attributes)</td></tr>
<tr class="memdesc:abf1d4810de32ca2cc2c14c591b41d2cd inherit pro_methods_classgrpc_1_1_completion_queue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Private constructor of <a class="el" href="classgrpc_1_1_completion_queue.html" title="A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....">CompletionQueue</a> only visible to friend classes. <a href="classgrpc_1_1_completion_queue.html#abf1d4810de32ca2cc2c14c591b41d2cd">More...</a><br /></td></tr>
<tr class="separator:abf1d4810de32ca2cc2c14c591b41d2cd inherit pro_methods_classgrpc_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:a78c3529c9a21103d71215aa56989cc89"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_completion_queue.html#a78c3529c9a21103d71215aa56989cc89">grpc::ServerBuilder</a></td></tr>
<tr class="separator:a78c3529c9a21103d71215aa56989cc89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9028997af40019c547a36227c988576f"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_completion_queue.html#a9028997af40019c547a36227c988576f">grpc::Server</a></td></tr>
<tr class="separator:a9028997af40019c547a36227c988576f"><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_1_1_completion_queue"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classgrpc_1_1_completion_queue')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a></td></tr>
<tr class="memitem:a6227657fb2f29291f80cd092f9baf572 inherit pub_types_classgrpc_1_1_completion_queue"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572">NextStatus</a> { <a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572a5d05c1c970154dad10e5f648890c215b">SHUTDOWN</a>,
<a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572a5d8344849fb99341b7edaa9da7b42c08">GOT_EVENT</a>,
<a class="el" href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572ae88eecb45f91413b425511ee973e2e04">TIMEOUT</a>
}</td></tr>
<tr class="memdesc:a6227657fb2f29291f80cd092f9baf572"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tri-state return for AsyncNext: SHUTDOWN, GOT_EVENT, TIMEOUT. <a href="classgrpc_1_1_completion_queue.html#a6227657fb2f29291f80cd092f9baf572">More...</a><br /></td></tr>
<tr class="separator:a6227657fb2f29291f80cd092f9baf572 inherit pub_types_classgrpc_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_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">ServerBuilder</a></em> or <a class="el" href="classgrpc_1_1_server.html" title="Represents a gRPC server.">Server</a> (for health checker). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1706983733b2a91c8df6712729cd6721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1706983733b2a91c8df6712729cd6721">&#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::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="acdb6d4631a3e30737e3903986d69dc52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdb6d4631a3e30737e3903986d69dc52">&#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::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="a9028997af40019c547a36227c988576f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9028997af40019c547a36227c988576f">&#9670;&nbsp;</a></span>grpc::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_1_1_server.html">grpc::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="a78c3529c9a21103d71215aa56989cc89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78c3529c9a21103d71215aa56989cc89">&#9670;&nbsp;</a></span>grpc::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_1_1_server_builder.html">grpc::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/<a class="el" href="grpcpp_2completion__queue_8h_source.html">completion_queue.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 &#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>
Reference in New Issue View Git Blame Copy Permalink