structgrpc__compression__options.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  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 Core: grpc_compression_options Struct 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 Core
  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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
  66. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</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><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-attribs">Data Fields</a> </div>
  86. <div class="headertitle">
  87. <div class="title">grpc_compression_options Struct Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p><code>#include &lt;<a class="el" href="compression__types_8h_source.html">compression_types.h</a>&gt;</code></p>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  93. Data Fields</h2></td></tr>
  94. <tr class="memitem:a2b584aa8b7ee684f145c75a5035ed800"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html#a2b584aa8b7ee684f145c75a5035ed800">enabled_algorithms_bitset</a></td></tr>
  95. <tr class="memdesc:a2b584aa8b7ee684f145c75a5035ed800"><td class="mdescLeft">&#160;</td><td class="mdescRight">All algs are enabled by default. <a href="#a2b584aa8b7ee684f145c75a5035ed800">More...</a><br /></td></tr>
  96. <tr class="separator:a2b584aa8b7ee684f145c75a5035ed800"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a51539f51120a4aacbae75d5bc9ab62a7"><td class="memItemLeft" >struct {</td></tr>
  98. <tr class="memitem:af624843cb50db089384be32a9b94a9f2"><td class="memItemLeft" >&#160;&#160;&#160;bool&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a6549e90bb2bf4002f2b59c57841df278">is_set</a></td></tr>
  99. <tr class="separator:af624843cb50db089384be32a9b94a9f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ac3f1b8c02bc0254ce54679e6b1cf77b6"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a>&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a2c8a5692fbb7b1778bb34edc8d8c5cdb">level</a></td></tr>
  101. <tr class="separator:ac3f1b8c02bc0254ce54679e6b1cf77b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a51539f51120a4aacbae75d5bc9ab62a7"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html#a51539f51120a4aacbae75d5bc9ab62a7">default_level</a></td></tr>
  103. <tr class="memdesc:a51539f51120a4aacbae75d5bc9ab62a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default channel compression level. <a href="#a51539f51120a4aacbae75d5bc9ab62a7">More...</a><br /></td></tr>
  104. <tr class="separator:a51539f51120a4aacbae75d5bc9ab62a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a04a323bd83f6651f5d8cb798dae98a10"><td class="memItemLeft" >struct {</td></tr>
  106. <tr class="memitem:a609373f63a2fde9908d186113e6ee6cb"><td class="memItemLeft" >&#160;&#160;&#160;bool&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a6549e90bb2bf4002f2b59c57841df278">is_set</a></td></tr>
  107. <tr class="separator:a609373f63a2fde9908d186113e6ee6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a7ca2ed6422467861cfc205c653faaf57"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a030be28c632dea1b2fbfb4219fef8e10">algorithm</a></td></tr>
  109. <tr class="separator:a7ca2ed6422467861cfc205c653faaf57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a04a323bd83f6651f5d8cb798dae98a10"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html#a04a323bd83f6651f5d8cb798dae98a10">default_algorithm</a></td></tr>
  111. <tr class="memdesc:a04a323bd83f6651f5d8cb798dae98a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default channel compression algorithm. <a href="#a04a323bd83f6651f5d8cb798dae98a10">More...</a><br /></td></tr>
  112. <tr class="separator:a04a323bd83f6651f5d8cb798dae98a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table>
  114. <h2 class="groupheader">Field Documentation</h2>
  115. <a class="anchor" id="a030be28c632dea1b2fbfb4219fef8e10"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc_compression_options::algorithm</td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. </div>
  125. </div>
  126. <a class="anchor" id="a04a323bd83f6651f5d8cb798dae98a10"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">struct { ... } grpc_compression_options::default_algorithm</td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>The default channel compression algorithm. </p>
  136. <p>It'll be used in the absence of call specific settings. This option corresponds to the channel argument key behind <em>GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM</em>. </p>
  137. </div>
  138. </div>
  139. <a class="anchor" id="a51539f51120a4aacbae75d5bc9ab62a7"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">struct { ... } grpc_compression_options::default_level</td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>The default channel compression level. </p>
  149. <p>It'll be used in the absence of call specific settings. This option corresponds to the channel argument key behind <em>GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL</em>. If present, takes precedence over <em>default_algorithm</em>. TODO(dgq): currently only available for server channels. </p>
  150. </div>
  151. </div>
  152. <a class="anchor" id="a2b584aa8b7ee684f145c75a5035ed800"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">uint32_t grpc_compression_options::enabled_algorithms_bitset</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>All algs are enabled by default. </p>
  162. <p>This option corresponds to the channel argument key behind <em>GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET</em> </p>
  163. </div>
  164. </div>
  165. <a class="anchor" id="a6549e90bb2bf4002f2b59c57841df278"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">bool grpc_compression_options::is_set</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <a class="anchor" id="a2c8a5692fbb7b1778bb34edc8d8c5cdb"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc_compression_options::level</td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <hr/>The documentation for this struct was generated from the following file:<ul>
  188. <li>include/grpc/impl/codegen/<a class="el" href="compression__types_8h_source.html">compression_types.h</a></li>
  189. </ul>
  190. </div><!-- contents -->
  191. <!-- start footer part -->
  192. <hr class="footer"/><address class="footer"><small>
  193. Generated on Thu Aug 18 2016 21:34:58 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  194. <img class="footer" src="doxygen.png" alt="doxygen"/>
  195. </a> 1.8.11
  196. </small></address>
  197. </body>
  198. </html>