annotated.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  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: Data Structures</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. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="headertitle">
  64. <div class="title">Data Structures</div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
  68. <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
  69. <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgpr__event.html" target="_self">gpr_event</a></td><td class="desc"></td></tr>
  70. <tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgpr__log__func__args.html" target="_self">gpr_log_func_args</a></td><td class="desc">Log overrides: applications can use this API to intercept logging calls and use their own implementations </td></tr>
  71. <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgpr__refcount.html" target="_self">gpr_refcount</a></td><td class="desc"></td></tr>
  72. <tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgpr__stats__counter.html" target="_self">gpr_stats_counter</a></td><td class="desc"></td></tr>
  73. <tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgpr__timespec.html" target="_self">gpr_timespec</a></td><td class="desc">Analogous to struct timespec </td></tr>
  74. <tr id="row_5_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__arg.html" target="_self">grpc_arg</a></td><td class="desc">A single argument.. </td></tr>
  75. <tr id="row_5_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_5_0_" class="arrow" onclick="toggleFolder('5_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="uniongrpc__arg_1_1grpc__arg__value.html" target="_self">grpc_arg_value</a></td><td class="desc"></td></tr>
  76. <tr id="row_5_0_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__arg_1_1grpc__arg__value_1_1grpc__arg__pointer.html" target="_self">grpc_arg_pointer</a></td><td class="desc"></td></tr>
  77. <tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__arg__pointer__vtable.html" target="_self">grpc_arg_pointer_vtable</a></td><td class="desc"></td></tr>
  78. <tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__auth__metadata__context.html" target="_self">grpc_auth_metadata_context</a></td><td class="desc">Context that can be used by metadata credentials plugin in order to create auth related metadata </td></tr>
  79. <tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__auth__metadata__processor.html" target="_self">grpc_auth_metadata_processor</a></td><td class="desc">Pluggable server-side metadata processor object </td></tr>
  80. <tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__auth__property.html" target="_self">grpc_auth_property</a></td><td class="desc">Value, if not NULL, is guaranteed to be NULL terminated </td></tr>
  81. <tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__auth__property__iterator.html" target="_self">grpc_auth_property_iterator</a></td><td class="desc"></td></tr>
  82. <tr id="row_11_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_11_" class="arrow" onclick="toggleFolder('11_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__byte__buffer.html" target="_self">grpc_byte_buffer</a></td><td class="desc"></td></tr>
  83. <tr id="row_11_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_11_0_" class="arrow" onclick="toggleFolder('11_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="uniongrpc__byte__buffer_1_1grpc__byte__buffer__data.html" target="_self">grpc_byte_buffer_data</a></td><td class="desc"></td></tr>
  84. <tr id="row_11_0_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__byte__buffer_1_1grpc__byte__buffer__data_1_1grpc__compressed__buffer.html" target="_self">grpc_compressed_buffer</a></td><td class="desc"></td></tr>
  85. <tr id="row_12_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_12_" class="arrow" onclick="toggleFolder('12_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__byte__buffer__reader.html" target="_self">grpc_byte_buffer_reader</a></td><td class="desc"></td></tr>
  86. <tr id="row_12_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="uniongrpc__byte__buffer__reader_1_1grpc__byte__buffer__reader__current.html" target="_self">grpc_byte_buffer_reader_current</a></td><td class="desc">Different current objects correspond to different types of byte buffers </td></tr>
  87. <tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__call__details.html" target="_self">grpc_call_details</a></td><td class="desc"></td></tr>
  88. <tr id="row_14_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__channel__args.html" target="_self">grpc_channel_args</a></td><td class="desc">An array of arguments that can be passed around </td></tr>
  89. <tr id="row_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__channel__info.html" target="_self">grpc_channel_info</a></td><td class="desc">Information requested from the channel </td></tr>
  90. <tr id="row_16_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__completion__queue__attributes.html" target="_self">grpc_completion_queue_attributes</a></td><td class="desc"></td></tr>
  91. <tr id="row_17_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_17_" class="arrow" onclick="toggleFolder('17_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__compression__options.html" target="_self">grpc_compression_options</a></td><td class="desc"></td></tr>
  92. <tr id="row_17_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__compression__options_1_1grpc__compression__options__default__algorithm.html" target="_self">grpc_compression_options_default_algorithm</a></td><td class="desc">The default message compression algorithm </td></tr>
  93. <tr id="row_17_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__compression__options_1_1grpc__compression__options__default__level.html" target="_self">grpc_compression_options_default_level</a></td><td class="desc">The default compression level </td></tr>
  94. <tr id="row_18_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__event.html" target="_self">grpc_event</a></td><td class="desc">The result of an operation </td></tr>
  95. <tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__experimental__completion__queue__functor.html" target="_self">grpc_experimental_completion_queue_functor</a></td><td class="desc">EXPERIMENTAL: Specifies an interface class to be used as a tag for callback-based completion queues </td></tr>
  96. <tr id="row_20_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__metadata.html" target="_self">grpc_metadata</a></td><td class="desc">A single metadata element </td></tr>
  97. <tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__metadata__array.html" target="_self">grpc_metadata_array</a></td><td class="desc"></td></tr>
  98. <tr id="row_22_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__metadata__credentials__plugin.html" target="_self">grpc_metadata_credentials_plugin</a></td><td class="desc">Grpc_metadata_credentials plugin is an API user provided structure used to create grpc_credentials objects that can be set on a channel (composed) or a call </td></tr>
  99. <tr id="row_23_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_23_" class="arrow" onclick="toggleFolder('23_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op.html" target="_self">grpc_op</a></td><td class="desc">Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments) </td></tr>
  100. <tr id="row_23_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_23_0_" class="arrow" onclick="toggleFolder('23_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="uniongrpc__op_1_1grpc__op__data.html" target="_self">grpc_op_data</a></td><td class="desc"></td></tr>
  101. <tr id="row_23_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__recv__close__on__server.html" target="_self">grpc_op_recv_close_on_server</a></td><td class="desc"></td></tr>
  102. <tr id="row_23_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__recv__initial__metadata.html" target="_self">grpc_op_recv_initial_metadata</a></td><td class="desc">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) </td></tr>
  103. <tr id="row_23_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__recv__message.html" target="_self">grpc_op_recv_message</a></td><td class="desc">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 </td></tr>
  104. <tr id="row_23_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__recv__status__on__client.html" target="_self">grpc_op_recv_status_on_client</a></td><td class="desc"></td></tr>
  105. <tr id="row_23_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_23_0_4_" class="arrow" onclick="toggleFolder('23_0_4_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__send__initial__metadata.html" target="_self">grpc_op_send_initial_metadata</a></td><td class="desc"></td></tr>
  106. <tr id="row_23_0_4_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__send__initial__metadata_1_1grpc__op__send__initialaea3b3a42c7d59f33d8b29d9f8d06219.html" target="_self">grpc_op_send_initial_metadata_maybe_compression_level</a></td><td class="desc">If <em>is_set</em>, <em>compression_level</em> will be used for the call </td></tr>
  107. <tr id="row_23_0_5_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__send__message.html" target="_self">grpc_op_send_message</a></td><td class="desc"></td></tr>
  108. <tr id="row_23_0_6_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__op_1_1grpc__op__data_1_1grpc__op__send__status__from__server.html" target="_self">grpc_op_send_status_from_server</a></td><td class="desc"></td></tr>
  109. <tr id="row_24_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_24_" class="arrow" onclick="toggleFolder('24_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__slice.html" target="_self">grpc_slice</a></td><td class="desc">A <a class="el" href="structgrpc__slice.html" title="A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].">grpc_slice</a> s, if initialized, represents the byte range s.bytes[0..s.length-1] </td></tr>
  110. <tr id="row_24_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_24_0_" class="arrow" onclick="toggleFolder('24_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="uniongrpc__slice_1_1grpc__slice__data.html" target="_self">grpc_slice_data</a></td><td class="desc"></td></tr>
  111. <tr id="row_24_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__slice_1_1grpc__slice__data_1_1grpc__slice__inlined.html" target="_self">grpc_slice_inlined</a></td><td class="desc"></td></tr>
  112. <tr id="row_24_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__slice_1_1grpc__slice__data_1_1grpc__slice__refcounted.html" target="_self">grpc_slice_refcounted</a></td><td class="desc"></td></tr>
  113. <tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__slice__buffer.html" target="_self">grpc_slice_buffer</a></td><td class="desc">Represents an expandable array of slices, to be interpreted as a single item </td></tr>
  114. <tr id="row_26_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html" target="_self">grpc_ssl_pem_key_cert_pair</a></td><td class="desc">Object that holds a private key / certificate chain pair in PEM format </td></tr>
  115. <tr id="row_27_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__ssl__verify__peer__options.html" target="_self">grpc_ssl_verify_peer_options</a></td><td class="desc">Object that holds additional peer-verification options on a secure channel </td></tr>
  116. <tr id="row_28_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__sts__credentials__options.html" target="_self">grpc_sts_credentials_options</a></td><td class="desc">Options for creating STS Oauth Token Exchange credentials following the IETF draft <a href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16</a> </td></tr>
  117. <tr id="row_29_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgrpc__tls__server__authorization__check__arg.html" target="_self">grpc_tls_server_authorization_check_arg</a></td><td class="desc">A struct containing all information necessary to schedule/cancel a server authorization check request </td></tr>
  118. <tr id="row_30_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structverify__peer__options.html" target="_self">verify_peer_options</a></td><td class="desc">Deprecated in favor of <a class="el" href="structgrpc__ssl__verify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel.">grpc_ssl_verify_peer_options</a> </td></tr>
  119. </table>
  120. </div><!-- directory -->
  121. </div><!-- contents -->
  122. <!-- start footer part -->
  123. <hr class="footer"/><address class="footer"><small>
  124. Generated on Wed Mar 3 2021 19:17:12 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  125. <img class="footer" src="doxygen.png" alt="doxygen"/>
  126. </a> 1.8.17
  127. </small></address>
  128. </body>
  129. </html>