compression__types_8h.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  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 C++: include/grpc/impl/codegen/compression_types.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#define-members">Macros</a> &#124;
  70. <a href="#typedef-members">Typedefs</a> &#124;
  71. <a href="#enum-members">Enumerations</a> </div>
  72. <div class="headertitle">
  73. <div class="title">compression_types.h File Reference</div> </div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <div class="textblock"><code>#include &lt;<a class="el" href="impl_2codegen_2port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>&gt;</code><br />
  77. </div>
  78. <p><a href="compression__types_8h_source.html">Go to the source code of this file.</a></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  81. Data Structures</h2></td></tr>
  82. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a></td></tr>
  83. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options_1_1grpc__compression__options__default__level.html">grpc_compression_options::grpc_compression_options_default_level</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default compression level. <a href="structgrpc__compression__options_1_1grpc__compression__options__default__level.html#details">More...</a><br /></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options_1_1grpc__compression__options__default__algorithm.html">grpc_compression_options::grpc_compression_options_default_algorithm</a></td></tr>
  88. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default message compression algorithm. <a href="structgrpc__compression__options_1_1grpc__compression__options__default__algorithm.html#details">More...</a><br /></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table><table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  92. Macros</h2></td></tr>
  93. <tr class="memitem:a862adef9b36180377a6db217dd5f52fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression__types_8h.html#a862adef9b36180377a6db217dd5f52fe">GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY</a>&#160;&#160;&#160;&quot;grpc-internal-encoding-request&quot;</td></tr>
  94. <tr class="memdesc:a862adef9b36180377a6db217dd5f52fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">To be used as initial metadata key for the request of a concrete compression algorithm. <a href="compression__types_8h.html#a862adef9b36180377a6db217dd5f52fe">More...</a><br /></td></tr>
  95. <tr class="separator:a862adef9b36180377a6db217dd5f52fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga33cd5668b4ebacb59b657f4674cc1cf5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__grpc__arg__keys.html#ga33cd5668b4ebacb59b657f4674cc1cf5">GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM</a>&#160;&#160;&#160;&quot;grpc.default_compression_algorithm&quot;</td></tr>
  97. <tr class="memdesc:ga33cd5668b4ebacb59b657f4674cc1cf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default compression algorithm for the channel. <a href="group__grpc__arg__keys.html#ga33cd5668b4ebacb59b657f4674cc1cf5">More...</a><br /></td></tr>
  98. <tr class="separator:ga33cd5668b4ebacb59b657f4674cc1cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ga4ced90d07cc1e9a2c3f8a3d6b9171db3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__grpc__arg__keys.html#ga4ced90d07cc1e9a2c3f8a3d6b9171db3">GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL</a>&#160;&#160;&#160;&quot;grpc.default_compression_level&quot;</td></tr>
  100. <tr class="memdesc:ga4ced90d07cc1e9a2c3f8a3d6b9171db3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default compression level for the channel. <a href="group__grpc__arg__keys.html#ga4ced90d07cc1e9a2c3f8a3d6b9171db3">More...</a><br /></td></tr>
  101. <tr class="separator:ga4ced90d07cc1e9a2c3f8a3d6b9171db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:gaf8844eec49cd7281c77f4fb81deeffdc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__grpc__arg__keys.html#gaf8844eec49cd7281c77f4fb81deeffdc">GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET</a>&#160;&#160;&#160;&quot;grpc.compression_enabled_algorithms_bitset&quot;</td></tr>
  103. <tr class="memdesc:gaf8844eec49cd7281c77f4fb81deeffdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression algorithms supported by the channel. <a href="group__grpc__arg__keys.html#gaf8844eec49cd7281c77f4fb81deeffdc">More...</a><br /></td></tr>
  104. <tr class="separator:gaf8844eec49cd7281c77f4fb81deeffdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table><table class="memberdecls">
  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  107. Typedefs</h2></td></tr>
  108. <tr class="memitem:a4ab6b68839902fa9bf792e8bc279e1d1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression__types_8h.html#a4ab6b68839902fa9bf792e8bc279e1d1">grpc_compression_options</a></td></tr>
  109. <tr class="separator:a4ab6b68839902fa9bf792e8bc279e1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  112. Enumerations</h2></td></tr>
  113. <tr class="memitem:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> { <br />
  114. &#160;&#160;<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8">GRPC_COMPRESS_NONE</a> = 0,
  115. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913">GRPC_COMPRESS_DEFLATE</a>,
  116. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e">GRPC_COMPRESS_GZIP</a>,
  117. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a362a7cdbb0fca8cb945be79685531e62">GRPC_COMPRESS_STREAM_GZIP</a>,
  118. <br />
  119. &#160;&#160;<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d">GRPC_COMPRESS_ALGORITHMS_COUNT</a>
  120. <br />
  121. }</td></tr>
  122. <tr class="memdesc:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The various compression algorithms supported by gRPC (not sorted by compression level) <a href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">More...</a><br /></td></tr>
  123. <tr class="separator:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> { <br />
  125. &#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c">GRPC_COMPRESS_LEVEL_NONE</a> = 0,
  126. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673">GRPC_COMPRESS_LEVEL_LOW</a>,
  127. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce">GRPC_COMPRESS_LEVEL_MED</a>,
  128. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22">GRPC_COMPRESS_LEVEL_HIGH</a>,
  129. <br />
  130. &#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43">GRPC_COMPRESS_LEVEL_COUNT</a>
  131. <br />
  132. }</td></tr>
  133. <tr class="memdesc:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression levels allow a party with knowledge of its peer's accepted encodings to request compression in an abstract way. <a href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">More...</a><br /></td></tr>
  134. <tr class="separator:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <h2 class="groupheader">Macro Definition Documentation</h2>
  137. <a id="a862adef9b36180377a6db217dd5f52fe"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#a862adef9b36180377a6db217dd5f52fe">&#9670;&nbsp;</a></span>GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">#define GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY&#160;&#160;&#160;&quot;grpc-internal-encoding-request&quot;</td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>To be used as initial metadata key for the request of a concrete compression algorithm. </p>
  148. </div>
  149. </div>
  150. <h2 class="groupheader">Typedef Documentation</h2>
  151. <a id="a4ab6b68839902fa9bf792e8bc279e1d1"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a4ab6b68839902fa9bf792e8bc279e1d1">&#9670;&nbsp;</a></span>grpc_compression_options</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">typedef struct <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. </div>
  162. </div>
  163. <h2 class="groupheader">Enumeration Type Documentation</h2>
  164. <a id="ab9de0f68bfb1ef8ed09bd00643db14c9"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#ab9de0f68bfb1ef8ed09bd00643db14c9">&#9670;&nbsp;</a></span>grpc_compression_algorithm</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">enum <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>The various compression algorithms supported by gRPC (not sorted by compression level) </p>
  175. <table class="fieldtable">
  176. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8"></a>GRPC_COMPRESS_NONE&#160;</td><td class="fielddoc"></td></tr>
  177. <tr><td class="fieldname"><a id="ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913"></a>GRPC_COMPRESS_DEFLATE&#160;</td><td class="fielddoc"></td></tr>
  178. <tr><td class="fieldname"><a id="ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e"></a>GRPC_COMPRESS_GZIP&#160;</td><td class="fielddoc"></td></tr>
  179. <tr><td class="fieldname"><a id="ab9de0f68bfb1ef8ed09bd00643db14c9a362a7cdbb0fca8cb945be79685531e62"></a>GRPC_COMPRESS_STREAM_GZIP&#160;</td><td class="fielddoc"></td></tr>
  180. <tr><td class="fieldname"><a id="ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d"></a>GRPC_COMPRESS_ALGORITHMS_COUNT&#160;</td><td class="fielddoc"></td></tr>
  181. </table>
  182. </div>
  183. </div>
  184. <a id="a14a79ed6b5ebd7e1dda7c2684f499cc7"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a14a79ed6b5ebd7e1dda7c2684f499cc7">&#9670;&nbsp;</a></span>grpc_compression_level</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">enum <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Compression levels allow a party with knowledge of its peer's accepted encodings to request compression in an abstract way. </p>
  195. <p>The level-algorithm mapping is performed internally and depends on the peer's supported compression algorithms. </p>
  196. <table class="fieldtable">
  197. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c"></a>GRPC_COMPRESS_LEVEL_NONE&#160;</td><td class="fielddoc"></td></tr>
  198. <tr><td class="fieldname"><a id="a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673"></a>GRPC_COMPRESS_LEVEL_LOW&#160;</td><td class="fielddoc"></td></tr>
  199. <tr><td class="fieldname"><a id="a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce"></a>GRPC_COMPRESS_LEVEL_MED&#160;</td><td class="fielddoc"></td></tr>
  200. <tr><td class="fieldname"><a id="a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22"></a>GRPC_COMPRESS_LEVEL_HIGH&#160;</td><td class="fielddoc"></td></tr>
  201. <tr><td class="fieldname"><a id="a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43"></a>GRPC_COMPRESS_LEVEL_COUNT&#160;</td><td class="fielddoc"></td></tr>
  202. </table>
  203. </div>
  204. </div>
  205. </div><!-- contents -->
  206. <!-- start footer part -->
  207. <hr class="footer"/><address class="footer"><small>
  208. Generated on Wed Mar 3 2021 19:17:22 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  209. <img class="footer" src="doxygen.png" alt="doxygen"/>
  210. </a> 1.8.17
  211. </small></address>
  212. </body>
  213. </html>