grpc/cpp/structgrpc__event.html

155 lines
7.5 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_event 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.58.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_event Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The result of an operation.
<a href="structgrpc__event.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:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#ab6454071421a36ebc25952ed448d5b87">grpc_completion_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__event.html#a8e7f571b759f55db4f6bebc2a4f56ad7">type</a></td></tr>
<tr class="memdesc:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of the completion. <a href="structgrpc__event.html#a8e7f571b759f55db4f6bebc2a4f56ad7">More...</a><br /></td></tr>
<tr class="separator:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99d4215e5df50869af320b1cca5540db"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__event.html#a99d4215e5df50869af320b1cca5540db">success</a></td></tr>
<tr class="memdesc:a99d4215e5df50869af320b1cca5540db"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates whether the operation was successful or not; 0 in case of failure and non-zero in case of success. <a href="structgrpc__event.html#a99d4215e5df50869af320b1cca5540db">More...</a><br /></td></tr>
<tr class="separator:a99d4215e5df50869af320b1cca5540db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a883ab15e862db582116c72cdcdc4c201"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__event.html#a883ab15e862db582116c72cdcdc4c201">tag</a></td></tr>
<tr class="memdesc:a883ab15e862db582116c72cdcdc4c201"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag passed to grpc_call_start_batch etc to start this operation. <a href="structgrpc__event.html#a883ab15e862db582116c72cdcdc4c201">More...</a><br /></td></tr>
<tr class="separator:a883ab15e862db582116c72cdcdc4c201"><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>The result of an operation. </p>
<p>Returned by a completion queue when the operation started with tag. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a99d4215e5df50869af320b1cca5540db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99d4215e5df50869af320b1cca5540db">&#9670;&nbsp;</a></span>success</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_event::success</td>
</tr>
</table>
</div><div class="memdoc">
<p>If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates whether the operation was successful or not; 0 in case of failure and non-zero in case of success. </p>
<p>If grpc_completion_type is GRPC_QUEUE_SHUTDOWN or GRPC_QUEUE_TIMEOUT, this field is guaranteed to be 0 </p>
</div>
</div>
<a id="a883ab15e862db582116c72cdcdc4c201"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883ab15e862db582116c72cdcdc4c201">&#9670;&nbsp;</a></span>tag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* grpc_event::tag</td>
</tr>
</table>
</div><div class="memdoc">
<p>The tag passed to grpc_call_start_batch etc to start this operation. </p>
<p>Only* GRPC_OP_COMPLETE has a tag. For all other grpc_completion_type values, tag is uninitialized. </p>
</div>
</div>
<a id="a8e7f571b759f55db4f6bebc2a4f56ad7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e7f571b759f55db4f6bebc2a4f56ad7">&#9670;&nbsp;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="grpc__types_8h.html#ab6454071421a36ebc25952ed448d5b87">grpc_completion_type</a> grpc_event::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of the completion. </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 Wed Sep 6 2023 16:09: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>