compression_8h.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  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.6"/>
  7. <title>GRPC Core: include/grpc/compression.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/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC Core
  26. &#160;<span id="projectnumber">0.12.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  42. <li class="current"><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="files.html"><span>File&#160;List</span></a></li>
  64. <li><a href="globals.html"><span>Globals</span></a></li>
  65. </ul>
  66. </div>
  67. <!-- window showing the filter options -->
  68. <div id="MSearchSelectWindow"
  69. onmouseover="return searchBox.OnSearchSelectShow()"
  70. onmouseout="return searchBox.OnSearchSelectHide()"
  71. onkeydown="return searchBox.OnSearchSelectKey(event)">
  72. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  73. <!-- iframe showing the search results (closed by default) -->
  74. <div id="MSearchResultsWindow">
  75. <iframe src="javascript:void(0)" frameborder="0"
  76. name="MSearchResults" id="MSearchResults">
  77. </iframe>
  78. </div>
  79. <div id="nav-path" class="navpath">
  80. <ul>
  81. <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> </ul>
  82. </div>
  83. </div><!-- top -->
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#nested-classes">Data Structures</a> &#124;
  87. <a href="#define-members">Macros</a> &#124;
  88. <a href="#typedef-members">Typedefs</a> &#124;
  89. <a href="#enum-members">Enumerations</a> &#124;
  90. <a href="#func-members">Functions</a> </div>
  91. <div class="headertitle">
  92. <div class="title">compression.h File Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br/>
  96. <code>#include &lt;<a class="el" href="port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br/>
  97. </div>
  98. <p><a href="compression_8h_source.html">Go to the source code of this file.</a></p>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  101. Data Structures</h2></td></tr>
  102. <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>
  103. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  106. Macros</h2></td></tr>
  107. <tr class="memitem:a9340488e193921e62bb1f240f9016a9b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a9340488e193921e62bb1f240f9016a9b">GRPC_COMPRESSION_ALGORITHM_ARG</a>&#160;&#160;&#160;&quot;grpc.compression_algorithm&quot;</td></tr>
  108. <tr class="memdesc:a9340488e193921e62bb1f240f9016a9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">To be used in channel arguments. <a href="#a9340488e193921e62bb1f240f9016a9b">More...</a><br/></td></tr>
  109. <tr class="separator:a9340488e193921e62bb1f240f9016a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ad5c78531e2ddf025a9fd3e74f30330d3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#ad5c78531e2ddf025a9fd3e74f30330d3">GRPC_COMPRESSION_ALGORITHM_STATE_ARG</a>&#160;&#160;&#160;&quot;grpc.compression_algorithm_state&quot;</td></tr>
  111. <tr class="separator:ad5c78531e2ddf025a9fd3e74f30330d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  114. Typedefs</h2></td></tr>
  115. <tr class="memitem:a074a1aa6fb56901a795fe53c2adeefde"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  116. <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a074a1aa6fb56901a795fe53c2adeefde">grpc_compression_options</a></td></tr>
  117. <tr class="separator:a074a1aa6fb56901a795fe53c2adeefde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  120. Enumerations</h2></td></tr>
  121. <tr class="memitem:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> { <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8">GRPC_COMPRESS_NONE</a> = 0,
  122. <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913">GRPC_COMPRESS_DEFLATE</a>,
  123. <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e">GRPC_COMPRESS_GZIP</a>,
  124. <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d">GRPC_COMPRESS_ALGORITHMS_COUNT</a>
  125. }</td></tr>
  126. <tr class="separator:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> { <br/>
  128. &#160;&#160;<a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c">GRPC_COMPRESS_LEVEL_NONE</a> = 0,
  129. <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673">GRPC_COMPRESS_LEVEL_LOW</a>,
  130. <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce">GRPC_COMPRESS_LEVEL_MED</a>,
  131. <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22">GRPC_COMPRESS_LEVEL_HIGH</a>,
  132. <br/>
  133. &#160;&#160;<a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43">GRPC_COMPRESS_LEVEL_COUNT</a>
  134. <br/>
  135. }</td></tr>
  136. <tr class="separator:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table><table class="memberdecls">
  138. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  139. Functions</h2></td></tr>
  140. <tr class="memitem:a48df44a3ccd7035103e824da2fd474ac"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a48df44a3ccd7035103e824da2fd474ac">grpc_compression_algorithm_parse</a> (const char *name, size_t name_length, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> *algorithm)</td></tr>
  141. <tr class="memdesc:a48df44a3ccd7035103e824da2fd474ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the first <em>name_length</em> bytes of <em>name</em> as a grpc_compression_algorithm instance, updating <em>algorithm</em>. <a href="#a48df44a3ccd7035103e824da2fd474ac">More...</a><br/></td></tr>
  142. <tr class="separator:a48df44a3ccd7035103e824da2fd474ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:adce0341ab8fd560dc39e9e96daf7cb14"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#adce0341ab8fd560dc39e9e96daf7cb14">grpc_compression_algorithm_name</a> (<a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm, char **name)</td></tr>
  144. <tr class="memdesc:adce0341ab8fd560dc39e9e96daf7cb14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. <a href="#adce0341ab8fd560dc39e9e96daf7cb14">More...</a><br/></td></tr>
  145. <tr class="separator:adce0341ab8fd560dc39e9e96daf7cb14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a382cce802b53a6f85deb706caf1dccd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a382cce802b53a6f85deb706caf1dccd6">grpc_compression_algorithm_for_level</a> (<a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr>
  147. <tr class="memdesc:a382cce802b53a6f85deb706caf1dccd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the compression algorithm corresponding to <em>level</em>. <a href="#a382cce802b53a6f85deb706caf1dccd6">More...</a><br/></td></tr>
  148. <tr class="separator:a382cce802b53a6f85deb706caf1dccd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ad8a9895538c2352a9a0067f87c651c07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#ad8a9895538c2352a9a0067f87c651c07">grpc_compression_options_init</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts)</td></tr>
  150. <tr class="separator:ad8a9895538c2352a9a0067f87c651c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a045af026403d638b397749de2e15bedd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a045af026403d638b397749de2e15bedd">grpc_compression_options_enable_algorithm</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  152. <tr class="memdesc:a045af026403d638b397749de2e15bedd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark <em>algorithm</em> as enabled in <em>opts</em>. <a href="#a045af026403d638b397749de2e15bedd">More...</a><br/></td></tr>
  153. <tr class="separator:a045af026403d638b397749de2e15bedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:abc2ff820072cb6021e6a59190b35d754"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#abc2ff820072cb6021e6a59190b35d754">grpc_compression_options_disable_algorithm</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  155. <tr class="memdesc:abc2ff820072cb6021e6a59190b35d754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark <em>algorithm</em> as disabled in <em>opts</em>. <a href="#abc2ff820072cb6021e6a59190b35d754">More...</a><br/></td></tr>
  156. <tr class="separator:abc2ff820072cb6021e6a59190b35d754"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:abc6e77f12fa3efa896260144ae6b859f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#abc6e77f12fa3efa896260144ae6b859f">grpc_compression_options_is_algorithm_enabled</a> (const <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  158. <tr class="memdesc:abc6e77f12fa3efa896260144ae6b859f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. <a href="#abc6e77f12fa3efa896260144ae6b859f">More...</a><br/></td></tr>
  159. <tr class="separator:abc6e77f12fa3efa896260144ae6b859f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table>
  161. <h2 class="groupheader">Macro Definition Documentation</h2>
  162. <a class="anchor" id="a9340488e193921e62bb1f240f9016a9b"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">#define GRPC_COMPRESSION_ALGORITHM_ARG&#160;&#160;&#160;&quot;grpc.compression_algorithm&quot;</td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>To be used in channel arguments. </p>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ad5c78531e2ddf025a9fd3e74f30330d3"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">#define GRPC_COMPRESSION_ALGORITHM_STATE_ARG&#160;&#160;&#160;&quot;grpc.compression_algorithm_state&quot;</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. <h2 class="groupheader">Typedef Documentation</h2>
  186. <a class="anchor" id="a074a1aa6fb56901a795fe53c2adeefde"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <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>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. </div>
  196. </div>
  197. <h2 class="groupheader">Enumeration Type Documentation</h2>
  198. <a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">enum <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <table class="fieldtable">
  208. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8"></a>GRPC_COMPRESS_NONE</em>&#160;</td><td class="fielddoc">
  209. </td></tr>
  210. <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913"></a>GRPC_COMPRESS_DEFLATE</em>&#160;</td><td class="fielddoc">
  211. </td></tr>
  212. <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e"></a>GRPC_COMPRESS_GZIP</em>&#160;</td><td class="fielddoc">
  213. </td></tr>
  214. <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d"></a>GRPC_COMPRESS_ALGORITHMS_COUNT</em>&#160;</td><td class="fielddoc">
  215. </td></tr>
  216. </table>
  217. </div>
  218. </div>
  219. <a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">enum <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a></td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <table class="fieldtable">
  229. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c"></a>GRPC_COMPRESS_LEVEL_NONE</em>&#160;</td><td class="fielddoc">
  230. </td></tr>
  231. <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673"></a>GRPC_COMPRESS_LEVEL_LOW</em>&#160;</td><td class="fielddoc">
  232. </td></tr>
  233. <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce"></a>GRPC_COMPRESS_LEVEL_MED</em>&#160;</td><td class="fielddoc">
  234. </td></tr>
  235. <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22"></a>GRPC_COMPRESS_LEVEL_HIGH</em>&#160;</td><td class="fielddoc">
  236. </td></tr>
  237. <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43"></a>GRPC_COMPRESS_LEVEL_COUNT</em>&#160;</td><td class="fielddoc">
  238. </td></tr>
  239. </table>
  240. </div>
  241. </div>
  242. <h2 class="groupheader">Function Documentation</h2>
  243. <a class="anchor" id="a382cce802b53a6f85deb706caf1dccd6"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc_compression_algorithm_for_level </td>
  249. <td>(</td>
  250. <td class="paramtype"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;</td>
  251. <td class="paramname"><em>level</em></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Returns the compression algorithm corresponding to <em>level</em>. </p>
  257. <p>It abort()s for unknown levels . </p>
  258. </div>
  259. </div>
  260. <a class="anchor" id="adce0341ab8fd560dc39e9e96daf7cb14"></a>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">int grpc_compression_algorithm_name </td>
  266. <td>(</td>
  267. <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  268. <td class="paramname"><em>algorithm</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">char **&#160;</td>
  274. <td class="paramname"><em>name</em>&#160;</td>
  275. </tr>
  276. <tr>
  277. <td></td>
  278. <td>)</td>
  279. <td></td><td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. </p>
  284. <p>Returns 1 upon success, 0 otherwise. </p>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a48df44a3ccd7035103e824da2fd474ac"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">int grpc_compression_algorithm_parse </td>
  293. <td>(</td>
  294. <td class="paramtype">const char *&#160;</td>
  295. <td class="paramname"><em>name</em>, </td>
  296. </tr>
  297. <tr>
  298. <td class="paramkey"></td>
  299. <td></td>
  300. <td class="paramtype">size_t&#160;</td>
  301. <td class="paramname"><em>name_length</em>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> *&#160;</td>
  307. <td class="paramname"><em>algorithm</em>&#160;</td>
  308. </tr>
  309. <tr>
  310. <td></td>
  311. <td>)</td>
  312. <td></td><td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Parses the first <em>name_length</em> bytes of <em>name</em> as a grpc_compression_algorithm instance, updating <em>algorithm</em>. </p>
  317. <p>Returns 1 upon success, 0 otherwise. </p>
  318. </div>
  319. </div>
  320. <a class="anchor" id="abc2ff820072cb6021e6a59190b35d754"></a>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">void grpc_compression_options_disable_algorithm </td>
  326. <td>(</td>
  327. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  328. <td class="paramname"><em>opts</em>, </td>
  329. </tr>
  330. <tr>
  331. <td class="paramkey"></td>
  332. <td></td>
  333. <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  334. <td class="paramname"><em>algorithm</em>&#160;</td>
  335. </tr>
  336. <tr>
  337. <td></td>
  338. <td>)</td>
  339. <td></td><td></td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Mark <em>algorithm</em> as disabled in <em>opts</em>. </p>
  344. </div>
  345. </div>
  346. <a class="anchor" id="a045af026403d638b397749de2e15bedd"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">void grpc_compression_options_enable_algorithm </td>
  352. <td>(</td>
  353. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  354. <td class="paramname"><em>opts</em>, </td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey"></td>
  358. <td></td>
  359. <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  360. <td class="paramname"><em>algorithm</em>&#160;</td>
  361. </tr>
  362. <tr>
  363. <td></td>
  364. <td>)</td>
  365. <td></td><td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Mark <em>algorithm</em> as enabled in <em>opts</em>. </p>
  370. </div>
  371. </div>
  372. <a class="anchor" id="ad8a9895538c2352a9a0067f87c651c07"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname">void grpc_compression_options_init </td>
  378. <td>(</td>
  379. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  380. <td class="paramname"><em>opts</em></td><td>)</td>
  381. <td></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. </div>
  386. </div>
  387. <a class="anchor" id="abc6e77f12fa3efa896260144ae6b859f"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">int grpc_compression_options_is_algorithm_enabled </td>
  393. <td>(</td>
  394. <td class="paramtype">const <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  395. <td class="paramname"><em>opts</em>, </td>
  396. </tr>
  397. <tr>
  398. <td class="paramkey"></td>
  399. <td></td>
  400. <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  401. <td class="paramname"><em>algorithm</em>&#160;</td>
  402. </tr>
  403. <tr>
  404. <td></td>
  405. <td>)</td>
  406. <td></td><td></td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. <p>Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. </p>
  411. </div>
  412. </div>
  413. </div><!-- contents -->
  414. <!-- start footer part -->
  415. <hr class="footer"/><address class="footer"><small>
  416. Generated on Fri Jan 15 2016 00:21:22 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  417. <img class="footer" src="doxygen.png" alt="doxygen"/>
  418. </a> 1.8.6
  419. </small></address>
  420. </body>
  421. </html>