structgrpc__op.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  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 Core: 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 Core
  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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  66. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-attribs">Data Fields</a> </div>
  86. <div class="headertitle">
  87. <div class="title">grpc_op Struct Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p>Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
  91. <a href="structgrpc__op.html#details">More...</a></p>
  92. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  95. Data Fields</h2></td></tr>
  96. <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>
  97. <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>
  98. <tr class="separator:a702bcecc2462646b6740ed7c05f42115"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <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>
  101. <tr class="separator:a5b6e034719e0ac3cd6bcf5efbc7cb019"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="memdesc:a7acd3f623bfe47799259036092b5d29c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future usage. <a href="#a7acd3f623bfe47799259036092b5d29c">More...</a><br /></td></tr>
  104. <tr class="separator:a7acd3f623bfe47799259036092b5d29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ae6714d192571c7c0b61a0f951c282cdd"><td class="memItemLeft" >union {</td></tr>
  106. <tr class="memitem:a4cb6b0841f3d2716a568b445f2d8443f"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  107. <tr class="memitem:ac2b4b2c38c4a6dc5305ac27430ea8d53"><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>
  108. <tr class="separator:ac2b4b2c38c4a6dc5305ac27430ea8d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a4cb6b0841f3d2716a568b445f2d8443f"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a61543eeae8fbb114dbb306dc0ea3db9d">reserved</a></td></tr>
  110. <tr class="memdesc:a4cb6b0841f3d2716a568b445f2d8443f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future usage. <a href="#a4cb6b0841f3d2716a568b445f2d8443f">More...</a><br /></td></tr>
  111. <tr class="separator:a4cb6b0841f3d2716a568b445f2d8443f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aeea49231e28d65dd6fecae88331e3905"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  113. <tr class="memitem:af05914014351ece020beb4a61ffb1164"><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>
  114. <tr class="separator:af05914014351ece020beb4a61ffb1164"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a7f31c7be2001689fab473b352899779c"><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>
  116. <tr class="separator:a7f31c7be2001689fab473b352899779c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a4889ec12e65d37ee7d6c30b85f181d49"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;struct {</td></tr>
  118. <tr class="memitem:a1c03eb48dc8b8e246f169bd77a284f10"><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>
  119. <tr class="separator:a1c03eb48dc8b8e246f169bd77a284f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a06e5e85325f528f021d0217fd75b6606"><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>
  121. <tr class="separator:a06e5e85325f528f021d0217fd75b6606"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a4889ec12e65d37ee7d6c30b85f181d49"><td class="memItemLeft" valign="top">&#160;&#160;&#160;&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#aaa3c88b6d998425c7b560d6dd70821f9">maybe_compression_level</a></td></tr>
  123. <tr class="memdesc:a4889ec12e65d37ee7d6c30b85f181d49"><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="#a4889ec12e65d37ee7d6c30b85f181d49">More...</a><br /></td></tr>
  124. <tr class="separator:a4889ec12e65d37ee7d6c30b85f181d49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:aeea49231e28d65dd6fecae88331e3905"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ac2e6c876e65f9adc5f18bc049224386d">send_initial_metadata</a></td></tr>
  126. <tr class="separator:aeea49231e28d65dd6fecae88331e3905"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a415b0e644d30792abaf4bcf089d57fe2"><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>
  128. <tr class="separator:a415b0e644d30792abaf4bcf089d57fe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a31fc7eb88d2d47551be9810f0446f368"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  130. <tr class="memitem:a6431b9a9a29fc156fc71386394afb29f"><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>
  131. <tr class="separator:a6431b9a9a29fc156fc71386394afb29f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a2aaf05e14f8188bdc260120f47e4853b"><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>
  133. <tr class="separator:a2aaf05e14f8188bdc260120f47e4853b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a473038a07e70dc786e5189841d702d4e"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a>&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#ae0d5a9db463391c0897914ef2d016b25">status</a></td></tr>
  135. <tr class="separator:a473038a07e70dc786e5189841d702d4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a1ece125b265bbcf9d6ef20002d5864fd"><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>
  137. <tr class="separator:a1ece125b265bbcf9d6ef20002d5864fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a31fc7eb88d2d47551be9810f0446f368"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a6be70f8bc41402284b06df80244b7f55">send_status_from_server</a></td></tr>
  139. <tr class="separator:a31fc7eb88d2d47551be9810f0446f368"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:add824e473a2acf27c0462d148679dfca"><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>
  141. <tr class="memdesc:add824e473a2acf27c0462d148679dfca"><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="#add824e473a2acf27c0462d148679dfca">More...</a><br /></td></tr>
  142. <tr class="separator:add824e473a2acf27c0462d148679dfca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a6677933d45e3cb396db77e3b28c31c1b"><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>
  144. <tr class="memdesc:a6677933d45e3cb396db77e3b28c31c1b"><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="#a6677933d45e3cb396db77e3b28c31c1b">More...</a><br /></td></tr>
  145. <tr class="separator:a6677933d45e3cb396db77e3b28c31c1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:aa135c9f6ec5601935c8d5e81a02b4513"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  147. <tr class="memitem:af16c43057b8957f08fb5dc945aa5b094"><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>
  148. <tr class="memdesc:af16c43057b8957f08fb5dc945aa5b094"><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="#af16c43057b8957f08fb5dc945aa5b094">More...</a><br /></td></tr>
  149. <tr class="separator:af16c43057b8957f08fb5dc945aa5b094"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a44363b29a228ee0346d45be64eb28878"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a70d62415f6768533c2190e53f1c5baf4">status</a></td></tr>
  151. <tr class="separator:a44363b29a228ee0346d45be64eb28878"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ac056d799eec8b633925b9a786386663e"><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>
  153. <tr class="memdesc:ac056d799eec8b633925b9a786386663e"><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="#ac056d799eec8b633925b9a786386663e">More...</a><br /></td></tr>
  154. <tr class="separator:ac056d799eec8b633925b9a786386663e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a814aea1f968279f2ff06ac4ea1ae0b9f"><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>
  156. <tr class="separator:a814aea1f968279f2ff06ac4ea1ae0b9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:aa135c9f6ec5601935c8d5e81a02b4513"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a318f49ead2f63805e859e2b910eeabf7">recv_status_on_client</a></td></tr>
  158. <tr class="separator:aa135c9f6ec5601935c8d5e81a02b4513"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:af6d81c7bfd058340e7a7151502f69f21"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  160. <tr class="memitem:a25bafe8fb0d69f36d709d3815d179281"><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>
  161. <tr class="memdesc:a25bafe8fb0d69f36d709d3815d179281"><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="#a25bafe8fb0d69f36d709d3815d179281">More...</a><br /></td></tr>
  162. <tr class="separator:a25bafe8fb0d69f36d709d3815d179281"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:af6d81c7bfd058340e7a7151502f69f21"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__op.html#a4dc5f65b7eb4b1fef5fb5421f217dd70">recv_close_on_server</a></td></tr>
  164. <tr class="separator:af6d81c7bfd058340e7a7151502f69f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ae6714d192571c7c0b61a0f951c282cdd"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__op.html#ae6714d192571c7c0b61a0f951c282cdd">data</a></td></tr>
  166. <tr class="separator:ae6714d192571c7c0b61a0f951c282cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  169. <div class="textblock"><p>Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) </p>
  170. </div><h2 class="groupheader">Field Documentation</h2>
  171. <a class="anchor" id="ae5a9717d4a69c46f343381596e223874"></a>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">int* grpc_op::cancelled</td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <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>
  181. </div>
  182. </div>
  183. <a class="anchor" id="ac5983d0a5d60c26ca2d1b37d31ba2e2a"></a>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">size_t grpc_op::count</td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. </div>
  193. </div>
  194. <a class="anchor" id="ae6714d192571c7c0b61a0f951c282cdd"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">union { ... } grpc_op::data</td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. </div>
  204. </div>
  205. <a class="anchor" id="a5b6e034719e0ac3cd6bcf5efbc7cb019"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">uint32_t grpc_op::flags</td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Write flags bitset for grpc_begin_messages. </p>
  215. </div>
  216. </div>
  217. <a class="anchor" id="aaf3faa71e11b8211bc6f1c25870fb80b"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">uint8_t grpc_op::is_set</td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. </div>
  227. </div>
  228. <a class="anchor" id="a430343df21e9eabb3ea11faef798eb5a"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc_op::level</td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a class="anchor" id="aaa3c88b6d998425c7b560d6dd70821f9"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">struct { ... } grpc_op::maybe_compression_level</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>If <em>is_set</em>, <em>compression_level</em> will be used for the call. </p>
  249. <p>Otherwise, <em>compression_level</em> won't be considered </p>
  250. </div>
  251. </div>
  252. <a class="anchor" id="a2e0f0c709658960593d5a36915c8d079"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname"><a class="el" href="structgrpc__metadata.html">grpc_metadata</a>* grpc_op::metadata</td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. </div>
  262. </div>
  263. <a class="anchor" id="a702bcecc2462646b6740ed7c05f42115"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname"><a class="el" href="grpc__types_8h.html#a41dc9abf9678decbfcef1a037e35939a">grpc_op_type</a> grpc_op::op</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Operation type, as defined by grpc_op_type. </p>
  273. </div>
  274. </div>
  275. <a class="anchor" id="a4dc5f65b7eb4b1fef5fb5421f217dd70"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">struct { ... } grpc_op::recv_close_on_server</td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. </div>
  285. </div>
  286. <a class="anchor" id="a81ebfcab8db61dd485b88cafc51f2749"></a>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a>* grpc_op::recv_initial_metadata</td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <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>
  296. <p>After the operation completes, call grpc_metadata_array_destroy on this value, or reuse it in a future op. </p>
  297. </div>
  298. </div>
  299. <a class="anchor" id="afca6c4cc5b0c2629bb559d2037907ac1"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>** grpc_op::recv_message</td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <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>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a318f49ead2f63805e859e2b910eeabf7"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">struct { ... } grpc_op::recv_status_on_client</td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. </div>
  321. </div>
  322. <a class="anchor" id="a7acd3f623bfe47799259036092b5d29c"></a>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">void* grpc_op::reserved[8]</td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Reserved for future usage. </p>
  332. </div>
  333. </div>
  334. <a class="anchor" id="a61543eeae8fbb114dbb306dc0ea3db9d"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">struct { ... } grpc_op::reserved</td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Reserved for future usage. </p>
  344. </div>
  345. </div>
  346. <a class="anchor" id="ac2e6c876e65f9adc5f18bc049224386d"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">struct { ... } grpc_op::send_initial_metadata</td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. </div>
  356. </div>
  357. <a class="anchor" id="a3b6c1b3456306a802f6eb0e3e8d0e434"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname"><a class="el" href="structgrpc__byte__buffer.html">grpc_byte_buffer</a>* grpc_op::send_message</td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. </div>
  367. </div>
  368. <a class="anchor" id="a6be70f8bc41402284b06df80244b7f55"></a>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">struct { ... } grpc_op::send_status_from_server</td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. </div>
  378. </div>
  379. <a class="anchor" id="ae0d5a9db463391c0897914ef2d016b25"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname"><a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> grpc_op::status</td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. </div>
  389. </div>
  390. <a class="anchor" id="a70d62415f6768533c2190e53f1c5baf4"></a>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname"><a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a>* grpc_op::status</td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. </div>
  400. </div>
  401. <a class="anchor" id="ae460836040d79eb2bd0a6d581b36c461"></a>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname">const char* grpc_op::status_details</td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. </div>
  411. </div>
  412. <a class="anchor" id="ab993dfc7b33c61f06f26a4efc0aefca6"></a>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="memname">
  416. <tr>
  417. <td class="memname">char** grpc_op::status_details</td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <p>status_details is a buffer owned by the application before the op completes and after the op has completed. </p>
  422. <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>
  423. <p>Pre-allocating space: size_t my_capacity = 8; char *my_details = gpr_malloc(my_capacity); x.status_details = x.status_details_capacity = </p>
  424. <p>Not pre-allocating space: size_t my_capacity = 0; char *my_details = NULL; x.status_details = x.status_details_capacity = </p>
  425. <p>After the call: gpr_free(my_details); </p>
  426. </div>
  427. </div>
  428. <a class="anchor" id="a6cacd1d5311683ee077931c94a9dd6e9"></a>
  429. <div class="memitem">
  430. <div class="memproto">
  431. <table class="memname">
  432. <tr>
  433. <td class="memname">size_t* grpc_op::status_details_capacity</td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. </div>
  438. </div>
  439. <a class="anchor" id="a521b48faec3b3f7646a877055f118d47"></a>
  440. <div class="memitem">
  441. <div class="memproto">
  442. <table class="memname">
  443. <tr>
  444. <td class="memname"><a class="el" href="structgrpc__metadata.html">grpc_metadata</a>* grpc_op::trailing_metadata</td>
  445. </tr>
  446. </table>
  447. </div><div class="memdoc">
  448. </div>
  449. </div>
  450. <a class="anchor" id="abb4d84434a0b74283c8b5d8d6501baf1"></a>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname"><a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a>* grpc_op::trailing_metadata</td>
  456. </tr>
  457. </table>
  458. </div><div class="memdoc">
  459. <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>
  460. <p>After the operation completes, call grpc_metadata_array_destroy on this value, or reuse it in a future op. </p>
  461. </div>
  462. </div>
  463. <a class="anchor" id="a4b9454278c105e08d54142adff37b5ab"></a>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="memname">
  467. <tr>
  468. <td class="memname">size_t grpc_op::trailing_metadata_count</td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. </div>
  473. </div>
  474. <hr/>The documentation for this struct was generated from the following file:<ul>
  475. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  476. </ul>
  477. </div><!-- contents -->
  478. <!-- start footer part -->
  479. <hr class="footer"/><address class="footer"><small>
  480. Generated on Thu Aug 18 2016 21:34:58 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  481. <img class="footer" src="doxygen.png" alt="doxygen"/>
  482. </a> 1.8.11
  483. </small></address>
  484. </body>
  485. </html>