compression_8h.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  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">5.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="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
  66. <li><a href="globals.html"><span>Globals</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="dir_8c22a72beb99e7fdfd27506cb533e734.html">include</a></li><li class="navelem"><a class="el" href="dir_3da487aded176e6fcacfa0e3f4e152fb.html">grpc</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#func-members">Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">compression.h File Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <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/>
  94. <code>#include &lt;stdlib.h&gt;</code><br/>
  95. <code>#include &lt;<a class="el" href="compression__types_8h_source.html">grpc/impl/codegen/compression_types.h</a>&gt;</code><br/>
  96. <code>#include &lt;<a class="el" href="slice_8h_source.html">grpc/slice.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="func-members"></a>
  101. Functions</h2></td></tr>
  102. <tr class="memitem:a5054ebec22cc256853a7ac2ed61fd654"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a5054ebec22cc256853a7ac2ed61fd654">grpc_compression_algorithm_parse</a> (<a class="el" href="structgrpc__slice.html">grpc_slice</a> value, <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> *algorithm)</td></tr>
  103. <tr class="memdesc:a5054ebec22cc256853a7ac2ed61fd654"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the <em>slice</em> as a grpc_compression_algorithm instance and updating <em>algorithm</em>. <a href="#a5054ebec22cc256853a7ac2ed61fd654">More...</a><br/></td></tr>
  104. <tr class="separator:a5054ebec22cc256853a7ac2ed61fd654"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a67faee49695eae970d85c047833d76f0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a67faee49695eae970d85c047833d76f0">grpc_stream_compression_algorithm_parse</a> (<a class="el" href="structgrpc__slice.html">grpc_slice</a> name, <a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a> *algorithm)</td></tr>
  106. <tr class="memdesc:a67faee49695eae970d85c047833d76f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the <em>slice</em> as a grpc_stream_compression_algorithm instance and updating <em>algorithm</em>. <a href="#a67faee49695eae970d85c047833d76f0">More...</a><br/></td></tr>
  107. <tr class="separator:a67faee49695eae970d85c047833d76f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a177f6d6330355d5ecaffb042ab1c2c8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a177f6d6330355d5ecaffb042ab1c2c8f">grpc_compression_algorithm_name</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm, const char **name)</td></tr>
  109. <tr class="memdesc:a177f6d6330355d5ecaffb042ab1c2c8f"><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="#a177f6d6330355d5ecaffb042ab1c2c8f">More...</a><br/></td></tr>
  110. <tr class="separator:a177f6d6330355d5ecaffb042ab1c2c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a51d280a2d18d8cc37a25d8b9286d9440"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a51d280a2d18d8cc37a25d8b9286d9440">grpc_stream_compression_algorithm_name</a> (<a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a> algorithm, const char **name)</td></tr>
  112. <tr class="memdesc:a51d280a2d18d8cc37a25d8b9286d9440"><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="#a51d280a2d18d8cc37a25d8b9286d9440">More...</a><br/></td></tr>
  113. <tr class="separator:a51d280a2d18d8cc37a25d8b9286d9440"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:adc2d1d89d880f67aacc4ce84cd72f8f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#adc2d1d89d880f67aacc4ce84cd72f8f3">grpc_compression_algorithm_for_level</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level, uint32_t accepted_encodings)</td></tr>
  115. <tr class="memdesc:adc2d1d89d880f67aacc4ce84cd72f8f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the compression algorithm corresponding to <em>level</em> for the compression algorithms encoded in the <em>accepted_encodings</em> bitset. <a href="#adc2d1d89d880f67aacc4ce84cd72f8f3">More...</a><br/></td></tr>
  116. <tr class="separator:adc2d1d89d880f67aacc4ce84cd72f8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a24dec74f48599ba12becb0ce78425e39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <br class="typebreak"/>
  118. <a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a24dec74f48599ba12becb0ce78425e39">grpc_stream_compression_algorithm_for_level</a> (<a class="el" href="compression__types_8h.html#a80e5bae1e06466c4b0a9ff0c8469b266">grpc_stream_compression_level</a> level, uint32_t accepted_stream_encodings)</td></tr>
  119. <tr class="memdesc:a24dec74f48599ba12becb0ce78425e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the stream compression algorithm corresponding to <em>level</em> for the compression algorithms encoded in the <em>accepted_stream_encodings</em> bitset. <a href="#a24dec74f48599ba12becb0ce78425e39">More...</a><br/></td></tr>
  120. <tr class="separator:a24dec74f48599ba12becb0ce78425e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a2eccdbe5a4d811a7c965d6d67e5cc7d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a2eccdbe5a4d811a7c965d6d67e5cc7d8">grpc_compression_options_init</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts)</td></tr>
  122. <tr class="separator:a2eccdbe5a4d811a7c965d6d67e5cc7d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a79e61d1ac1d226b3b54b73837f28f0ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a79e61d1ac1d226b3b54b73837f28f0ff">grpc_compression_options_enable_algorithm</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  124. <tr class="memdesc:a79e61d1ac1d226b3b54b73837f28f0ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark <em>algorithm</em> as enabled in <em>opts</em>. <a href="#a79e61d1ac1d226b3b54b73837f28f0ff">More...</a><br/></td></tr>
  125. <tr class="separator:a79e61d1ac1d226b3b54b73837f28f0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a1b58d314775a3651ee2f5f2d3ab4f6d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a1b58d314775a3651ee2f5f2d3ab4f6d9">grpc_compression_options_disable_algorithm</a> (<a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  127. <tr class="memdesc:a1b58d314775a3651ee2f5f2d3ab4f6d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark <em>algorithm</em> as disabled in <em>opts</em>. <a href="#a1b58d314775a3651ee2f5f2d3ab4f6d9">More...</a><br/></td></tr>
  128. <tr class="separator:a1b58d314775a3651ee2f5f2d3ab4f6d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:aba0dfe631311c3f49d1045694bc9b0df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#aba0dfe631311c3f49d1045694bc9b0df">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__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
  130. <tr class="memdesc:aba0dfe631311c3f49d1045694bc9b0df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. <a href="#aba0dfe631311c3f49d1045694bc9b0df">More...</a><br/></td></tr>
  131. <tr class="separator:aba0dfe631311c3f49d1045694bc9b0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a2bf848d4d1d0122f70dbe436aeb47d8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a2bf848d4d1d0122f70dbe436aeb47d8e">grpc_compression_options_is_stream_compression_algorithm_enabled</a> (const <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *opts, <a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a> algorithm)</td></tr>
  133. <tr class="memdesc:a2bf848d4d1d0122f70dbe436aeb47d8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. <a href="#a2bf848d4d1d0122f70dbe436aeb47d8e">More...</a><br/></td></tr>
  134. <tr class="separator:a2bf848d4d1d0122f70dbe436aeb47d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <h2 class="groupheader">Function Documentation</h2>
  137. <a class="anchor" id="adc2d1d89d880f67aacc4ce84cd72f8f3"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc_compression_algorithm_for_level </td>
  143. <td>(</td>
  144. <td class="paramtype"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;</td>
  145. <td class="paramname"><em>level</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">uint32_t&#160;</td>
  151. <td class="paramname"><em>accepted_encodings</em>&#160;</td>
  152. </tr>
  153. <tr>
  154. <td></td>
  155. <td>)</td>
  156. <td></td><td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Returns the compression algorithm corresponding to <em>level</em> for the compression algorithms encoded in the <em>accepted_encodings</em> bitset. </p>
  161. <p>It abort()s for unknown levels. </p>
  162. </div>
  163. </div>
  164. <a class="anchor" id="a177f6d6330355d5ecaffb042ab1c2c8f"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_compression_algorithm_name </td>
  170. <td>(</td>
  171. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  172. <td class="paramname"><em>algorithm</em>, </td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey"></td>
  176. <td></td>
  177. <td class="paramtype">const char **&#160;</td>
  178. <td class="paramname"><em>name</em>&#160;</td>
  179. </tr>
  180. <tr>
  181. <td></td>
  182. <td>)</td>
  183. <td></td><td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. </p>
  188. <p>Note that <em>name</em> is statically allocated and must <em>not</em> be freed. Returns 1 upon success, 0 otherwise. </p>
  189. </div>
  190. </div>
  191. <a class="anchor" id="a5054ebec22cc256853a7ac2ed61fd654"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_compression_algorithm_parse </td>
  197. <td>(</td>
  198. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a>&#160;</td>
  199. <td class="paramname"><em>value</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> *&#160;</td>
  205. <td class="paramname"><em>algorithm</em>&#160;</td>
  206. </tr>
  207. <tr>
  208. <td></td>
  209. <td>)</td>
  210. <td></td><td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Parses the <em>slice</em> as a grpc_compression_algorithm instance and updating <em>algorithm</em>. </p>
  215. <p>Returns 1 upon success, 0 otherwise. </p>
  216. </div>
  217. </div>
  218. <a class="anchor" id="a1b58d314775a3651ee2f5f2d3ab4f6d9"></a>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_compression_options_disable_algorithm </td>
  224. <td>(</td>
  225. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  226. <td class="paramname"><em>opts</em>, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  232. <td class="paramname"><em>algorithm</em>&#160;</td>
  233. </tr>
  234. <tr>
  235. <td></td>
  236. <td>)</td>
  237. <td></td><td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Mark <em>algorithm</em> as disabled in <em>opts</em>. </p>
  242. </div>
  243. </div>
  244. <a class="anchor" id="a79e61d1ac1d226b3b54b73837f28f0ff"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_compression_options_enable_algorithm </td>
  250. <td>(</td>
  251. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  252. <td class="paramname"><em>opts</em>, </td>
  253. </tr>
  254. <tr>
  255. <td class="paramkey"></td>
  256. <td></td>
  257. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  258. <td class="paramname"><em>algorithm</em>&#160;</td>
  259. </tr>
  260. <tr>
  261. <td></td>
  262. <td>)</td>
  263. <td></td><td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Mark <em>algorithm</em> as enabled in <em>opts</em>. </p>
  268. </div>
  269. </div>
  270. <a class="anchor" id="a2eccdbe5a4d811a7c965d6d67e5cc7d8"></a>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_compression_options_init </td>
  276. <td>(</td>
  277. <td class="paramtype"><a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  278. <td class="paramname"><em>opts</em></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. </div>
  284. </div>
  285. <a class="anchor" id="aba0dfe631311c3f49d1045694bc9b0df"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_compression_options_is_algorithm_enabled </td>
  291. <td>(</td>
  292. <td class="paramtype">const <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  293. <td class="paramname"><em>opts</em>, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  299. <td class="paramname"><em>algorithm</em>&#160;</td>
  300. </tr>
  301. <tr>
  302. <td></td>
  303. <td>)</td>
  304. <td></td><td></td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. </p>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a2bf848d4d1d0122f70dbe436aeb47d8e"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_compression_options_is_stream_compression_algorithm_enabled </td>
  317. <td>(</td>
  318. <td class="paramtype">const <a class="el" href="structgrpc__compression__options.html">grpc_compression_options</a> *&#160;</td>
  319. <td class="paramname"><em>opts</em>, </td>
  320. </tr>
  321. <tr>
  322. <td class="paramkey"></td>
  323. <td></td>
  324. <td class="paramtype"><a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a>&#160;</td>
  325. <td class="paramname"><em>algorithm</em>&#160;</td>
  326. </tr>
  327. <tr>
  328. <td></td>
  329. <td>)</td>
  330. <td></td><td></td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Returns true if <em>algorithm</em> is marked as enabled in <em>opts</em>. </p>
  335. </div>
  336. </div>
  337. <a class="anchor" id="a24dec74f48599ba12becb0ce78425e39"></a>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a> grpc_stream_compression_algorithm_for_level </td>
  343. <td>(</td>
  344. <td class="paramtype"><a class="el" href="compression__types_8h.html#a80e5bae1e06466c4b0a9ff0c8469b266">grpc_stream_compression_level</a>&#160;</td>
  345. <td class="paramname"><em>level</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">uint32_t&#160;</td>
  351. <td class="paramname"><em>accepted_stream_encodings</em>&#160;</td>
  352. </tr>
  353. <tr>
  354. <td></td>
  355. <td>)</td>
  356. <td></td><td></td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Returns the stream compression algorithm corresponding to <em>level</em> for the compression algorithms encoded in the <em>accepted_stream_encodings</em> bitset. </p>
  361. <p>It abort()s for unknown levels. </p>
  362. </div>
  363. </div>
  364. <a class="anchor" id="a51d280a2d18d8cc37a25d8b9286d9440"></a>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_stream_compression_algorithm_name </td>
  370. <td>(</td>
  371. <td class="paramtype"><a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a>&#160;</td>
  372. <td class="paramname"><em>algorithm</em>, </td>
  373. </tr>
  374. <tr>
  375. <td class="paramkey"></td>
  376. <td></td>
  377. <td class="paramtype">const char **&#160;</td>
  378. <td class="paramname"><em>name</em>&#160;</td>
  379. </tr>
  380. <tr>
  381. <td></td>
  382. <td>)</td>
  383. <td></td><td></td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <p>Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. </p>
  388. <p>Note that <em>name</em> is statically allocated and must <em>not</em> be freed. Returns 1 upon success, 0 otherwise. </p>
  389. </div>
  390. </div>
  391. <a class="anchor" id="a67faee49695eae970d85c047833d76f0"></a>
  392. <div class="memitem">
  393. <div class="memproto">
  394. <table class="memname">
  395. <tr>
  396. <td class="memname">int grpc_stream_compression_algorithm_parse </td>
  397. <td>(</td>
  398. <td class="paramtype"><a class="el" href="structgrpc__slice.html">grpc_slice</a>&#160;</td>
  399. <td class="paramname"><em>name</em>, </td>
  400. </tr>
  401. <tr>
  402. <td class="paramkey"></td>
  403. <td></td>
  404. <td class="paramtype"><a class="el" href="compression__types_8h.html#a5f02e953ca5bdabd545b3386ad242073">grpc_stream_compression_algorithm</a> *&#160;</td>
  405. <td class="paramname"><em>algorithm</em>&#160;</td>
  406. </tr>
  407. <tr>
  408. <td></td>
  409. <td>)</td>
  410. <td></td><td></td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <p>Parses the <em>slice</em> as a grpc_stream_compression_algorithm instance and updating <em>algorithm</em>. </p>
  415. <p>Returns 1 upon success, 0 otherwise. </p>
  416. </div>
  417. </div>
  418. </div><!-- contents -->
  419. <!-- start footer part -->
  420. <hr class="footer"/><address class="footer"><small>
  421. Generated on Fri Feb 2 2018 15:15:10 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  422. <img class="footer" src="doxygen.png" alt="doxygen"/>
  423. </a> 1.8.6
  424. </small></address>
  425. </body>
  426. </html>