grpc/cpp/structgrpc__completion__que...

172 lines
9.0 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_completion_queue_functor Struct 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">grpc_completion_queue_functor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Specifies an interface class to be used as a tag for callback-based completion queues.
<a href="structgrpc__completion__queue__functor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a9227cc362f840e890aa5f8de09c80c7a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue__functor.html#a9227cc362f840e890aa5f8de09c80c7a">functor_run</a> )(struct <a class="el" href="structgrpc__completion__queue__functor.html">grpc_completion_queue_functor</a> *, int)</td></tr>
<tr class="memdesc:a9227cc362f840e890aa5f8de09c80c7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The run member specifies a function that will be called when this tag is extracted from the completion queue. <a href="structgrpc__completion__queue__functor.html#a9227cc362f840e890aa5f8de09c80c7a">More...</a><br /></td></tr>
<tr class="separator:a9227cc362f840e890aa5f8de09c80c7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08a170b853327b9ac3332728c403620f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue__functor.html#a08a170b853327b9ac3332728c403620f">inlineable</a></td></tr>
<tr class="memdesc:a08a170b853327b9ac3332728c403620f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The inlineable member specifies whether this functor can be run inline. <a href="structgrpc__completion__queue__functor.html#a08a170b853327b9ac3332728c403620f">More...</a><br /></td></tr>
<tr class="separator:a08a170b853327b9ac3332728c403620f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e6043f4c49430a0d6c6d7252b20fc4e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue__functor.html#a3e6043f4c49430a0d6c6d7252b20fc4e">internal_success</a></td></tr>
<tr class="memdesc:a3e6043f4c49430a0d6c6d7252b20fc4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following fields are not API. <a href="structgrpc__completion__queue__functor.html#a3e6043f4c49430a0d6c6d7252b20fc4e">More...</a><br /></td></tr>
<tr class="separator:a3e6043f4c49430a0d6c6d7252b20fc4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97653dd53430a222751480ff767279f8"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structgrpc__completion__queue__functor.html">grpc_completion_queue_functor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue__functor.html#a97653dd53430a222751480ff767279f8">internal_next</a></td></tr>
<tr class="separator:a97653dd53430a222751480ff767279f8"><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>Specifies an interface class to be used as a tag for callback-based completion queues. </p>
<p>This can be used directly, as the first element of a struct in C, or as a base class in C++. Its "run" value should be assigned to some non-member function, such as a static method. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a9227cc362f840e890aa5f8de09c80c7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9227cc362f840e890aa5f8de09c80c7a">&#9670;&nbsp;</a></span>functor_run</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_completion_queue_functor::functor_run) (struct <a class="el" href="structgrpc__completion__queue__functor.html">grpc_completion_queue_functor</a> *, int)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The run member specifies a function that will be called when this tag is extracted from the completion queue. </p>
<p>Its arguments will be a pointer to this functor and a boolean that indicates whether the operation succeeded (non-zero) or failed (zero) </p>
</div>
</div>
<a id="a08a170b853327b9ac3332728c403620f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08a170b853327b9ac3332728c403620f">&#9670;&nbsp;</a></span>inlineable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_completion_queue_functor::inlineable</td>
</tr>
</table>
</div><div class="memdoc">
<p>The inlineable member specifies whether this functor can be run inline. </p>
<p>This should only be used for trivial internally-defined functors. </p>
</div>
</div>
<a id="a97653dd53430a222751480ff767279f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97653dd53430a222751480ff767279f8">&#9670;&nbsp;</a></span>internal_next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structgrpc__completion__queue__functor.html">grpc_completion_queue_functor</a>* grpc_completion_queue_functor::internal_next</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3e6043f4c49430a0d6c6d7252b20fc4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e6043f4c49430a0d6c6d7252b20fc4e">&#9670;&nbsp;</a></span>internal_success</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_completion_queue_functor::internal_success</td>
</tr>
</table>
</div><div class="memdoc">
<p>The following fields are not API. </p>
<p>They are meant for internal use. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpc/impl/<a class="el" href="grpc__types_8h_source.html">grpc_types.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>