structgrpc__event.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
  7. <title>GRPC C++: grpc_event Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-attribs">Data Fields</a> </div>
  88. <div class="headertitle">
  89. <div class="title">grpc_event Struct Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>The result of an operation.
  93. <a href="structgrpc__event.html#details">More...</a></p>
  94. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  97. Data Fields</h2></td></tr>
  98. <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>
  99. <tr class="memdesc:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of the completion. <a href="#a8e7f571b759f55db4f6bebc2a4f56ad7">More...</a><br /></td></tr>
  100. <tr class="separator:a8e7f571b759f55db4f6bebc2a4f56ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="memdesc:a99d4215e5df50869af320b1cca5540db"><td class="mdescLeft">&#160;</td><td class="mdescRight">non-zero if the operation was successful, 0 upon failure. <a href="#a99d4215e5df50869af320b1cca5540db">More...</a><br /></td></tr>
  103. <tr class="separator:a99d4215e5df50869af320b1cca5540db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <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="#a883ab15e862db582116c72cdcdc4c201">More...</a><br /></td></tr>
  106. <tr class="separator:a883ab15e862db582116c72cdcdc4c201"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>The result of an operation. </p>
  110. <p>Returned by a completion queue when the operation started with tag. </p>
  111. </div><h2 class="groupheader">Field Documentation</h2>
  112. <a class="anchor" id="a99d4215e5df50869af320b1cca5540db"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">int grpc_event::success</td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>non-zero if the operation was successful, 0 upon failure. </p>
  122. <p>Only GRPC_OP_COMPLETE can succeed or fail. </p>
  123. </div>
  124. </div>
  125. <a class="anchor" id="a883ab15e862db582116c72cdcdc4c201"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">void* grpc_event::tag</td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>The tag passed to grpc_call_start_batch etc to start this operation. </p>
  135. <p>Only GRPC_OP_COMPLETE has a tag. </p>
  136. </div>
  137. </div>
  138. <a class="anchor" id="a8e7f571b759f55db4f6bebc2a4f56ad7"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="grpc__types_8h.html#ab6454071421a36ebc25952ed448d5b87">grpc_completion_type</a> grpc_event::type</td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>The type of the completion. </p>
  148. </div>
  149. </div>
  150. <hr/>The documentation for this struct was generated from the following file:<ul>
  151. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  152. </ul>
  153. </div><!-- contents -->
  154. <!-- start footer part -->
  155. <hr class="footer"/><address class="footer"><small>
  156. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  157. <img class="footer" src="doxygen.png" alt="doxygen"/>
  158. </a> 1.8.11
  159. </small></address>
  160. </body>
  161. </html>