compression__types_8h.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  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++: include/grpc/impl/codegen/compression_types.h File 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><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
  67. <li><a href="globals.html"><span>Globals</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 id="nav-path" class="navpath">
  83. <ul>
  84. <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>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#nested-classes">Data Structures</a> &#124;
  90. <a href="#define-members">Macros</a> &#124;
  91. <a href="#typedef-members">Typedefs</a> &#124;
  92. <a href="#enum-members">Enumerations</a> </div>
  93. <div class="headertitle">
  94. <div class="title">compression_types.h File Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <div class="textblock"><code>#include &lt;<a class="el" href="port__platform_8h_source.html">grpc/impl/codegen/port_platform.h</a>&gt;</code><br />
  98. <code>#include &lt;stdbool.h&gt;</code><br />
  99. </div>
  100. <p><a href="compression__types_8h_source.html">Go to the source code of this file.</a></p>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  103. Data Structures</h2></td></tr>
  104. <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>
  105. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  108. Macros</h2></td></tr>
  109. <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>
  110. <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="#a862adef9b36180377a6db217dd5f52fe">More...</a><br /></td></tr>
  111. <tr class="separator:a862adef9b36180377a6db217dd5f52fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <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>
  114. <tr class="separator:ga33cd5668b4ebacb59b657f4674cc1cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <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>
  117. <tr class="separator:ga4ced90d07cc1e9a2c3f8a3d6b9171db3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <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>
  120. <tr class="separator:gaf8844eec49cd7281c77f4fb81deeffdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  123. Typedefs</h2></td></tr>
  124. <tr class="memitem:a074a1aa6fb56901a795fe53c2adeefde"><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#a074a1aa6fb56901a795fe53c2adeefde">grpc_compression_options</a></td></tr>
  125. <tr class="separator:a074a1aa6fb56901a795fe53c2adeefde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  128. Enumerations</h2></td></tr>
  129. <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> { <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8">GRPC_COMPRESS_NONE</a> = 0,
  130. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913">GRPC_COMPRESS_DEFLATE</a>,
  131. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e">GRPC_COMPRESS_GZIP</a>,
  132. <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d">GRPC_COMPRESS_ALGORITHMS_COUNT</a>
  133. }</td></tr>
  134. <tr class="separator:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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 />
  136. &#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c">GRPC_COMPRESS_LEVEL_NONE</a> = 0,
  137. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673">GRPC_COMPRESS_LEVEL_LOW</a>,
  138. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce">GRPC_COMPRESS_LEVEL_MED</a>,
  139. <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22">GRPC_COMPRESS_LEVEL_HIGH</a>,
  140. <br />
  141. &#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43">GRPC_COMPRESS_LEVEL_COUNT</a>
  142. <br />
  143. }<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>
  144. </td></tr>
  145. <tr class="separator:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <h2 class="groupheader">Macro Definition Documentation</h2>
  148. <a class="anchor" id="a862adef9b36180377a6db217dd5f52fe"></a>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">#define GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY&#160;&#160;&#160;&quot;grpc-internal-encoding-request&quot;</td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>To be used as initial metadata key for the request of a concrete compression algorithm. </p>
  158. </div>
  159. </div>
  160. <h2 class="groupheader">Typedef Documentation</h2>
  161. <a class="anchor" id="a074a1aa6fb56901a795fe53c2adeefde"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <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>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. </div>
  171. </div>
  172. <h2 class="groupheader">Enumeration Type Documentation</h2>
  173. <a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">enum <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <table class="fieldtable">
  183. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8"></a>GRPC_COMPRESS_NONE&#160;</td><td class="fielddoc">
  184. </td></tr>
  185. <tr><td class="fieldname"><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913"></a>GRPC_COMPRESS_DEFLATE&#160;</td><td class="fielddoc">
  186. </td></tr>
  187. <tr><td class="fieldname"><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e"></a>GRPC_COMPRESS_GZIP&#160;</td><td class="fielddoc">
  188. </td></tr>
  189. <tr><td class="fieldname"><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d"></a>GRPC_COMPRESS_ALGORITHMS_COUNT&#160;</td><td class="fielddoc">
  190. </td></tr>
  191. </table>
  192. </div>
  193. </div>
  194. <a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">enum <a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a></td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Compression levels allow a party with knowledge of its peer's accepted encodings to request compression in an abstract way. </p>
  204. <p>The level-algorithm mapping is performed internally and depends on the peer's supported compression algorithms. </p>
  205. <table class="fieldtable">
  206. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c"></a>GRPC_COMPRESS_LEVEL_NONE&#160;</td><td class="fielddoc">
  207. </td></tr>
  208. <tr><td class="fieldname"><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673"></a>GRPC_COMPRESS_LEVEL_LOW&#160;</td><td class="fielddoc">
  209. </td></tr>
  210. <tr><td class="fieldname"><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce"></a>GRPC_COMPRESS_LEVEL_MED&#160;</td><td class="fielddoc">
  211. </td></tr>
  212. <tr><td class="fieldname"><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22"></a>GRPC_COMPRESS_LEVEL_HIGH&#160;</td><td class="fielddoc">
  213. </td></tr>
  214. <tr><td class="fieldname"><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43"></a>GRPC_COMPRESS_LEVEL_COUNT&#160;</td><td class="fielddoc">
  215. </td></tr>
  216. </table>
  217. </div>
  218. </div>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  223. <img class="footer" src="doxygen.png" alt="doxygen"/>
  224. </a> 1.8.11
  225. </small></address>
  226. </body>
  227. </html>