structgrpc__compression__options.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  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++: 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 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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-attribs">Data Fields</a> </div>
  88. <div class="headertitle">
  89. <div class="title">grpc_compression_options Struct Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p><code>#include &lt;<a class="el" href="compression__types_8h_source.html">compression_types.h</a>&gt;</code></p>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  95. Data Fields</h2></td></tr>
  96. <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>
  97. <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>
  98. <tr class="separator:a2b584aa8b7ee684f145c75a5035ed800"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a0a0efcf195a0d59a2dc5f442394a185d"><td class="memItemLeft" >struct {</td></tr>
  100. <tr class="memitem:ac3d591fe8b6d92fb85adfd61a434a5fc"><td class="memItemLeft" >&#160;&#160;&#160;bool&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a6549e90bb2bf4002f2b59c57841df278">is_set</a></td></tr>
  101. <tr class="separator:ac3d591fe8b6d92fb85adfd61a434a5fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a2fd59d0c4ac5c5295e4b967fd76da1f9"><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>
  103. <tr class="separator:a2fd59d0c4ac5c5295e4b967fd76da1f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a0a0efcf195a0d59a2dc5f442394a185d"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html#a0a0efcf195a0d59a2dc5f442394a185d">default_level</a></td></tr>
  105. <tr class="memdesc:a0a0efcf195a0d59a2dc5f442394a185d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default channel compression level. <a href="#a0a0efcf195a0d59a2dc5f442394a185d">More...</a><br /></td></tr>
  106. <tr class="separator:a0a0efcf195a0d59a2dc5f442394a185d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ac4407e6a6240e9f29736c4edb058f262"><td class="memItemLeft" >struct {</td></tr>
  108. <tr class="memitem:a06da537be23c76ff859b9647651a9a6d"><td class="memItemLeft" >&#160;&#160;&#160;bool&#160;&#160;&#160;<a class="el" href="structgrpc__compression__options.html#a6549e90bb2bf4002f2b59c57841df278">is_set</a></td></tr>
  109. <tr class="separator:a06da537be23c76ff859b9647651a9a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a374889d155aab8467982efa557762eaa"><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>
  111. <tr class="separator:a374889d155aab8467982efa557762eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ac4407e6a6240e9f29736c4edb058f262"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__compression__options.html#ac4407e6a6240e9f29736c4edb058f262">default_algorithm</a></td></tr>
  113. <tr class="memdesc:ac4407e6a6240e9f29736c4edb058f262"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default channel compression algorithm. <a href="#ac4407e6a6240e9f29736c4edb058f262">More...</a><br /></td></tr>
  114. <tr class="separator:ac4407e6a6240e9f29736c4edb058f262"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table>
  116. <h2 class="groupheader">Field Documentation</h2>
  117. <a class="anchor" id="a030be28c632dea1b2fbfb4219fef8e10"></a>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc_compression_options::algorithm</td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <a class="anchor" id="ac4407e6a6240e9f29736c4edb058f262"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">struct { ... } grpc_compression_options::default_algorithm</td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>The default channel compression algorithm. </p>
  138. <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>
  139. </div>
  140. </div>
  141. <a class="anchor" id="a0a0efcf195a0d59a2dc5f442394a185d"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">struct { ... } grpc_compression_options::default_level</td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>The default channel compression level. </p>
  151. <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>
  152. </div>
  153. </div>
  154. <a class="anchor" id="a2b584aa8b7ee684f145c75a5035ed800"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">uint32_t grpc_compression_options::enabled_algorithms_bitset</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>All algs are enabled by default. </p>
  164. <p>This option corresponds to the channel argument key behind <em>GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET</em> </p>
  165. </div>
  166. </div>
  167. <a class="anchor" id="a6549e90bb2bf4002f2b59c57841df278"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">bool grpc_compression_options::is_set</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. </div>
  177. </div>
  178. <a class="anchor" id="a2c8a5692fbb7b1778bb34edc8d8c5cdb"></a>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc_compression_options::level</td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. </div>
  188. </div>
  189. <hr/>The documentation for this struct was generated from the following file:<ul>
  190. <li>include/grpc/impl/codegen/<a class="el" href="compression__types_8h_source.html">compression_types.h</a></li>
  191. </ul>
  192. </div><!-- contents -->
  193. <!-- start footer part -->
  194. <hr class="footer"/><address class="footer"><small>
  195. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  196. <img class="footer" src="doxygen.png" alt="doxygen"/>
  197. </a> 1.8.11
  198. </small></address>
  199. </body>
  200. </html>