structgrpc__event.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: grpc_event Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Core
  25. &#160;<span id="projectnumber">15.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">grpc_event Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>The result of an operation.
  70. <a href="structgrpc__event.html#details">More...</a></p>
  71. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Data Fields</h2></td></tr>
  75. <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>
  76. <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>
  77. <tr class="separator:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <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>
  80. <tr class="separator:a99d4215e5df50869af320b1cca5540db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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>
  82. <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>
  83. <tr class="separator:a883ab15e862db582116c72cdcdc4c201"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <div class="textblock"><p>The result of an operation. </p>
  87. <p>Returned by a completion queue when the operation started with tag. </p>
  88. </div><h2 class="groupheader">Field Documentation</h2>
  89. <a id="a99d4215e5df50869af320b1cca5540db"></a>
  90. <h2 class="memtitle"><span class="permalink"><a href="#a99d4215e5df50869af320b1cca5540db">&#9670;&nbsp;</a></span>success</h2>
  91. <div class="memitem">
  92. <div class="memproto">
  93. <table class="memname">
  94. <tr>
  95. <td class="memname">int grpc_event::success</td>
  96. </tr>
  97. </table>
  98. </div><div class="memdoc">
  99. <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>
  100. <p>If grpc_completion_type is GRPC_QUEUE_SHUTDOWN or GRPC_QUEUE_TIMEOUT, this field is guaranteed to be 0 </p>
  101. </div>
  102. </div>
  103. <a id="a883ab15e862db582116c72cdcdc4c201"></a>
  104. <h2 class="memtitle"><span class="permalink"><a href="#a883ab15e862db582116c72cdcdc4c201">&#9670;&nbsp;</a></span>tag</h2>
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">void* grpc_event::tag</td>
  110. </tr>
  111. </table>
  112. </div><div class="memdoc">
  113. <p>The tag passed to grpc_call_start_batch etc to start this operation. </p>
  114. <p>Only* GRPC_OP_COMPLETE has a tag. For all other grpc_completion_type values, tag is uninitialized. </p>
  115. </div>
  116. </div>
  117. <a id="a8e7f571b759f55db4f6bebc2a4f56ad7"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a8e7f571b759f55db4f6bebc2a4f56ad7">&#9670;&nbsp;</a></span>type</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname"><a class="el" href="grpc__types_8h.html#ab6454071421a36ebc25952ed448d5b87">grpc_completion_type</a> grpc_event::type</td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>The type of the completion. </p>
  128. </div>
  129. </div>
  130. <hr/>The documentation for this struct was generated from the following file:<ul>
  131. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  132. </ul>
  133. </div><!-- contents -->
  134. <!-- start footer part -->
  135. <hr class="footer"/><address class="footer"><small>
  136. Generated on Wed Mar 3 2021 19:17:11 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  137. <img class="footer" src="doxygen.png" alt="doxygen"/>
  138. </a> 1.8.17
  139. </small></address>
  140. </body>
  141. </html>