structgrpc__op.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  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_op 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_op Struct Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
  93. <a href="structgrpc__op.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:a702bcecc2462646b6740ed7c05f42115"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a41dc9abf9678decbfcef1a037e35939a">grpc_op_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__op.html#a702bcecc2462646b6740ed7c05f42115">op</a></td></tr>
  99. <tr class="memdesc:a702bcecc2462646b6740ed7c05f42115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation type, as defined by grpc_op_type. <a href="#a702bcecc2462646b6740ed7c05f42115">More...</a><br /></td></tr>
  100. <tr class="separator:a702bcecc2462646b6740ed7c05f42115"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a5b6e034719e0ac3cd6bcf5efbc7cb019"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__op.html#a5b6e034719e0ac3cd6bcf5efbc7cb019">flags</a></td></tr>
  102. <tr class="memdesc:a5b6e034719e0ac3cd6bcf5efbc7cb019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write flags bitset for grpc_begin_messages. <a href="#a5b6e034719e0ac3cd6bcf5efbc7cb019">More...</a><br /></td></tr>
  103. <tr class="separator:a5b6e034719e0ac3cd6bcf5efbc7cb019"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a7acd3f623bfe47799259036092b5d29c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__op.html#a7acd3f623bfe47799259036092b5d29c">reserved</a></td></tr>
  105. <tr class="memdesc:a7acd3f623bfe47799259036092b5d29c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future usage. <a href="#a7acd3f623bfe47799259036092b5d29c">More...</a><br /></td></tr>
  106. <tr class="separator:a7acd3f623bfe47799259036092b5d29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a8f1a9b36620cc482a796adfae815af1d"><td class="memItemLeft" >union {</td></tr>
  108. <tr class="memitem:a823e514102842461fd8ad2864a555c4d"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  109. <tr class="memitem:ab9515d7faf2f2f8062837092e82994c6"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;void *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a7acd3f623bfe47799259036092b5d29c">reserved</a> [8]</td></tr>
  110. <tr class="separator:ab9515d7faf2f2f8062837092e82994c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a823e514102842461fd8ad2864a555c4d"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a17f9f7b98a6959908e5ce7596bcfab1f">reserved</a></td></tr>
  112. <tr class="memdesc:a823e514102842461fd8ad2864a555c4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future usage. <a href="#a823e514102842461fd8ad2864a555c4d">More...</a><br /></td></tr>
  113. <tr class="separator:a823e514102842461fd8ad2864a555c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:af7515471a879191c16b9a3b7d5c385f0"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  115. <tr class="memitem:abfb9bd9430a2b7a97d8213b1b7b74744"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ac5983d0a5d60c26ca2d1b37d31ba2e2a">count</a></td></tr>
  116. <tr class="separator:abfb9bd9430a2b7a97d8213b1b7b74744"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:aba477df5b596a747a261a310d8363580"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a2e0f0c709658960593d5a36915c8d079">metadata</a></td></tr>
  118. <tr class="separator:aba477df5b596a747a261a310d8363580"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ac58fd146513edde5f2a3404da27dd62a"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;struct {</td></tr>
  120. <tr class="memitem:aa4c0db1f413445b4bdf2eeeac17f6f67"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#aaf3faa71e11b8211bc6f1c25870fb80b">is_set</a></td></tr>
  121. <tr class="separator:aa4c0db1f413445b4bdf2eeeac17f6f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ac7f8a51d2a521c8c2c842ef34e7937a9"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a430343df21e9eabb3ea11faef798eb5a">level</a></td></tr>
  123. <tr class="separator:ac7f8a51d2a521c8c2c842ef34e7937a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ac58fd146513edde5f2a3404da27dd62a"><td class="memItemLeft" valign="top">&#160;&#160;&#160;&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a5660970e302de83d3749461d3f403a67">maybe_compression_level</a></td></tr>
  125. <tr class="memdesc:ac58fd146513edde5f2a3404da27dd62a"><td class="mdescLeft">&#160;</td><td class="mdescRight">If <em>is_set</em>, <em>compression_level</em> will be used for the call. <a href="#ac58fd146513edde5f2a3404da27dd62a">More...</a><br /></td></tr>
  126. <tr class="separator:ac58fd146513edde5f2a3404da27dd62a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:af7515471a879191c16b9a3b7d5c385f0"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#acd6ae090880510d9f394ad0f15d8ca91">send_initial_metadata</a></td></tr>
  128. <tr class="separator:af7515471a879191c16b9a3b7d5c385f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a18cdd66cc260b9929199397ef5139aa8"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a3b6c1b3456306a802f6eb0e3e8d0e434">send_message</a></td></tr>
  130. <tr class="separator:a18cdd66cc260b9929199397ef5139aa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:add327afaf0e8264894594d69c5428b77"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  132. <tr class="memitem:a3e3444cbb30d5a0ea14ec1180cb26bb2"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a4b9454278c105e08d54142adff37b5ab">trailing_metadata_count</a></td></tr>
  133. <tr class="separator:a3e3444cbb30d5a0ea14ec1180cb26bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7cf4cef3f348822343e3dc99950bf1d7"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a521b48faec3b3f7646a877055f118d47">trailing_metadata</a></td></tr>
  135. <tr class="separator:a7cf4cef3f348822343e3dc99950bf1d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a9fe80414812ad96386542f4650504ec1"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a>&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ae0d5a9db463391c0897914ef2d016b25">status</a></td></tr>
  137. <tr class="separator:a9fe80414812ad96386542f4650504ec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a334029e754e9f5264ebaf4a9fd39890b"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;const char *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ae460836040d79eb2bd0a6d581b36c461">status_details</a></td></tr>
  139. <tr class="separator:a334029e754e9f5264ebaf4a9fd39890b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:add327afaf0e8264894594d69c5428b77"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ab909730e0a2588f3cf25ebbfcbb0c016">send_status_from_server</a></td></tr>
  141. <tr class="separator:add327afaf0e8264894594d69c5428b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:ad78f827ccb17fcac4e1d197f72d512df"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a81ebfcab8db61dd485b88cafc51f2749">recv_initial_metadata</a></td></tr>
  143. <tr class="memdesc:ad78f827ccb17fcac4e1d197f72d512df"><td class="mdescLeft">&#160;</td><td class="mdescRight">ownership of the array is with the caller, but ownership of the elements stays with the call object (ie key, value members are owned by the call object, recv_initial_metadata-&gt;array is owned by the caller). <a href="#ad78f827ccb17fcac4e1d197f72d512df">More...</a><br /></td></tr>
  144. <tr class="separator:ad78f827ccb17fcac4e1d197f72d512df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a08e836be499785b660544f1caf67d052"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a> **&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#afca6c4cc5b0c2629bb559d2037907ac1">recv_message</a></td></tr>
  146. <tr class="memdesc:a08e836be499785b660544f1caf67d052"><td class="mdescLeft">&#160;</td><td class="mdescRight">ownership of the byte buffer is moved to the caller; the caller must call grpc_byte_buffer_destroy on this value, or reuse it in a future op. <a href="#a08e836be499785b660544f1caf67d052">More...</a><br /></td></tr>
  147. <tr class="separator:a08e836be499785b660544f1caf67d052"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:aaa1b50787a97a5162bfa76341a5e0ed8"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  149. <tr class="memitem:a771bd8c18dc690d1dbb8ad6f92d64bee"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#abb4d84434a0b74283c8b5d8d6501baf1">trailing_metadata</a></td></tr>
  150. <tr class="memdesc:a771bd8c18dc690d1dbb8ad6f92d64bee"><td class="mdescLeft">&#160;</td><td class="mdescRight">ownership of the array is with the caller, but ownership of the elements stays with the call object (ie key, value members are owned by the call object, trailing_metadata-&gt;array is owned by the caller). <a href="#a771bd8c18dc690d1dbb8ad6f92d64bee">More...</a><br /></td></tr>
  151. <tr class="separator:a771bd8c18dc690d1dbb8ad6f92d64bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ae291b5e5a7f53559e605f53dd6ca7150"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a70d62415f6768533c2190e53f1c5baf4">status</a></td></tr>
  153. <tr class="separator:ae291b5e5a7f53559e605f53dd6ca7150"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a1f877e0243e6bfc647a240452b10e3ab"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;char **&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ab993dfc7b33c61f06f26a4efc0aefca6">status_details</a></td></tr>
  155. <tr class="memdesc:a1f877e0243e6bfc647a240452b10e3ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">status_details is a buffer owned by the application before the op completes and after the op has completed. <a href="#a1f877e0243e6bfc647a240452b10e3ab">More...</a><br /></td></tr>
  156. <tr class="separator:a1f877e0243e6bfc647a240452b10e3ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a7458ad60278be71e0e92026fcf29f8aa"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a6cacd1d5311683ee077931c94a9dd6e9">status_details_capacity</a></td></tr>
  158. <tr class="separator:a7458ad60278be71e0e92026fcf29f8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:aaa1b50787a97a5162bfa76341a5e0ed8"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a2c028c67b8c91288465ee7f86a12fdff">recv_status_on_client</a></td></tr>
  160. <tr class="separator:aaa1b50787a97a5162bfa76341a5e0ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ae4cec6dcae6a1e93293a88508e7c0b9d"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  162. <tr class="memitem:a5a791303cfec50b250d1f5a543369285"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;int *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ae5a9717d4a69c46f343381596e223874">cancelled</a></td></tr>
  163. <tr class="memdesc:a5a791303cfec50b250d1f5a543369285"><td class="mdescLeft">&#160;</td><td class="mdescRight">out argument, set to 1 if the call failed in any way (seen as a cancellation on the server), or 0 if the call succeeded <a href="#a5a791303cfec50b250d1f5a543369285">More...</a><br /></td></tr>
  164. <tr class="separator:a5a791303cfec50b250d1f5a543369285"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ae4cec6dcae6a1e93293a88508e7c0b9d"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a85a90bd3e7da9eafdae33d1757a0a029">recv_close_on_server</a></td></tr>
  166. <tr class="separator:ae4cec6dcae6a1e93293a88508e7c0b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a8f1a9b36620cc482a796adfae815af1d"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__op.html#a8f1a9b36620cc482a796adfae815af1d">data</a></td></tr>
  168. <tr class="separator:a8f1a9b36620cc482a796adfae815af1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. </table>
  170. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  171. <div class="textblock"><p>Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) </p>
  172. </div><h2 class="groupheader">Field Documentation</h2>
  173. <a class="anchor" id="ae5a9717d4a69c46f343381596e223874"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">int* grpc_op::cancelled</td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>out argument, set to 1 if the call failed in any way (seen as a cancellation on the server), or 0 if the call succeeded </p>
  183. </div>
  184. </div>
  185. <a class="anchor" id="ac5983d0a5d60c26ca2d1b37d31ba2e2a"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">size_t grpc_op::count</td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. </div>
  195. </div>
  196. <a class="anchor" id="a8f1a9b36620cc482a796adfae815af1d"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">union { ... } grpc_op::data</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. </div>
  206. </div>
  207. <a class="anchor" id="a5b6e034719e0ac3cd6bcf5efbc7cb019"></a>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">uint32_t grpc_op::flags</td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Write flags bitset for grpc_begin_messages. </p>
  217. </div>
  218. </div>
  219. <a class="anchor" id="aaf3faa71e11b8211bc6f1c25870fb80b"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">uint8_t grpc_op::is_set</td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. </div>
  229. </div>
  230. <a class="anchor" id="a430343df21e9eabb3ea11faef798eb5a"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc_op::level</td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. </div>
  240. </div>
  241. <a class="anchor" id="a5660970e302de83d3749461d3f403a67"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">struct { ... } grpc_op::maybe_compression_level</td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>If <em>is_set</em>, <em>compression_level</em> will be used for the call. </p>
  251. <p>Otherwise, <em>compression_level</em> won't be considered </p>
  252. </div>
  253. </div>
  254. <a class="anchor" id="a2e0f0c709658960593d5a36915c8d079"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname"><a class="el" href="structgrpc__metadata.html">grpc_metadata</a>* grpc_op::metadata</td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. </div>
  264. </div>
  265. <a class="anchor" id="a702bcecc2462646b6740ed7c05f42115"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname"><a class="el" href="grpc__types_8h.html#a41dc9abf9678decbfcef1a037e35939a">grpc_op_type</a> grpc_op::op</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Operation type, as defined by grpc_op_type. </p>
  275. </div>
  276. </div>
  277. <a class="anchor" id="a85a90bd3e7da9eafdae33d1757a0a029"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">struct { ... } grpc_op::recv_close_on_server</td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. </div>
  287. </div>
  288. <a class="anchor" id="a81ebfcab8db61dd485b88cafc51f2749"></a>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname"><a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a>* grpc_op::recv_initial_metadata</td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>ownership of the array is with the caller, but ownership of the elements stays with the call object (ie key, value members are owned by the call object, recv_initial_metadata-&gt;array is owned by the caller). </p>
  298. <p>After the operation completes, call grpc_metadata_array_destroy on this value, or reuse it in a future op. </p>
  299. </div>
  300. </div>
  301. <a class="anchor" id="afca6c4cc5b0c2629bb559d2037907ac1"></a>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>** grpc_op::recv_message</td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>ownership of the byte buffer is moved to the caller; the caller must call grpc_byte_buffer_destroy on this value, or reuse it in a future op. </p>
  311. </div>
  312. </div>
  313. <a class="anchor" id="a2c028c67b8c91288465ee7f86a12fdff"></a>
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="memname">
  317. <tr>
  318. <td class="memname">struct { ... } grpc_op::recv_status_on_client</td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. </div>
  323. </div>
  324. <a class="anchor" id="a7acd3f623bfe47799259036092b5d29c"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">void* grpc_op::reserved[8]</td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Reserved for future usage. </p>
  334. </div>
  335. </div>
  336. <a class="anchor" id="a17f9f7b98a6959908e5ce7596bcfab1f"></a>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">struct { ... } grpc_op::reserved</td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Reserved for future usage. </p>
  346. </div>
  347. </div>
  348. <a class="anchor" id="acd6ae090880510d9f394ad0f15d8ca91"></a>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">struct { ... } grpc_op::send_initial_metadata</td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. </div>
  358. </div>
  359. <a class="anchor" id="a3b6c1b3456306a802f6eb0e3e8d0e434"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_op::send_message</td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. </div>
  369. </div>
  370. <a class="anchor" id="ab909730e0a2588f3cf25ebbfcbb0c016"></a>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">struct { ... } grpc_op::send_status_from_server</td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. </div>
  380. </div>
  381. <a class="anchor" id="ae0d5a9db463391c0897914ef2d016b25"></a>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname"><a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> grpc_op::status</td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. </div>
  391. </div>
  392. <a class="anchor" id="a70d62415f6768533c2190e53f1c5baf4"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname"><a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a>* grpc_op::status</td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. </div>
  402. </div>
  403. <a class="anchor" id="ae460836040d79eb2bd0a6d581b36c461"></a>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">const char* grpc_op::status_details</td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. </div>
  413. </div>
  414. <a class="anchor" id="ab993dfc7b33c61f06f26a4efc0aefca6"></a>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <table class="memname">
  418. <tr>
  419. <td class="memname">char** grpc_op::status_details</td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>status_details is a buffer owned by the application before the op completes and after the op has completed. </p>
  424. <p>During the operation status_details may be reallocated to a size larger than status_details_capacity, in which case *status_details_capacity will be updated with the new array capacity.</p>
  425. <p>Pre-allocating space: size_t my_capacity = 8; char *my_details = gpr_malloc(my_capacity); x.status_details = x.status_details_capacity = </p>
  426. <p>Not pre-allocating space: size_t my_capacity = 0; char *my_details = NULL; x.status_details = x.status_details_capacity = </p>
  427. <p>After the call: gpr_free(my_details); </p>
  428. </div>
  429. </div>
  430. <a class="anchor" id="a6cacd1d5311683ee077931c94a9dd6e9"></a>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">size_t* grpc_op::status_details_capacity</td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. </div>
  440. </div>
  441. <a class="anchor" id="a521b48faec3b3f7646a877055f118d47"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname"><a class="el" href="structgrpc__metadata.html">grpc_metadata</a>* grpc_op::trailing_metadata</td>
  447. </tr>
  448. </table>
  449. </div><div class="memdoc">
  450. </div>
  451. </div>
  452. <a class="anchor" id="abb4d84434a0b74283c8b5d8d6501baf1"></a>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname"><a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a>* grpc_op::trailing_metadata</td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>ownership of the array is with the caller, but ownership of the elements stays with the call object (ie key, value members are owned by the call object, trailing_metadata-&gt;array is owned by the caller). </p>
  462. <p>After the operation completes, call grpc_metadata_array_destroy on this value, or reuse it in a future op. </p>
  463. </div>
  464. </div>
  465. <a class="anchor" id="a4b9454278c105e08d54142adff37b5ab"></a>
  466. <div class="memitem">
  467. <div class="memproto">
  468. <table class="memname">
  469. <tr>
  470. <td class="memname">size_t grpc_op::trailing_metadata_count</td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. </div>
  475. </div>
  476. <hr/>The documentation for this struct was generated from the following file:<ul>
  477. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  478. </ul>
  479. </div><!-- contents -->
  480. <!-- start footer part -->
  481. <hr class="footer"/><address class="footer"><small>
  482. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  483. <img class="footer" src="doxygen.png" alt="doxygen"/>
  484. </a> 1.8.11
  485. </small></address>
  486. </body>
  487. </html>