Grpc.Net.Compression.ICompressionProvider.html 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Interface ICompressionProvider
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface ICompressionProvider
  11. | gRPC for .NET ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Net.Compression.ICompressionProvider">
  73. <h1 id="Grpc_Net_Compression_ICompressionProvider" data-uid="Grpc.Net.Compression.ICompressionProvider" class="text-break">Interface ICompressionProvider
  74. </h1>
  75. <div class="markdown level0 summary"><p>Provides a specific compression implementation to compress gRPC messages.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Net.Compression.html">Grpc.Net.Compression</a></h6>
  79. <h6><strong>Assembly</strong>: Grpc.Net.Common.dll</h6>
  80. <h5 id="Grpc_Net_Compression_ICompressionProvider_syntax">Syntax</h5>
  81. <div class="codewrapper">
  82. <pre><code class="lang-csharp hljs">public interface ICompressionProvider</code></pre>
  83. </div>
  84. <h3 id="properties">Properties
  85. </h3>
  86. <a id="Grpc_Net_Compression_ICompressionProvider_EncodingName_" data-uid="Grpc.Net.Compression.ICompressionProvider.EncodingName*"></a>
  87. <h4 id="Grpc_Net_Compression_ICompressionProvider_EncodingName" data-uid="Grpc.Net.Compression.ICompressionProvider.EncodingName">EncodingName</h4>
  88. <div class="markdown level1 summary"><p>The encoding name used in the &apos;grpc-encoding&apos; and &apos;grpc-accept-encoding&apos; request and response headers.</p>
  89. </div>
  90. <div class="markdown level1 conceptual"></div>
  91. <h5 class="decalaration">Declaration</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">string EncodingName { get; }</code></pre>
  94. </div>
  95. <h5 class="propertyValue">Property Value</h5>
  96. <table class="table table-bordered table-striped table-condensed">
  97. <thead>
  98. <tr>
  99. <th>Type</th>
  100. <th>Description</th>
  101. </tr>
  102. </thead>
  103. <tbody>
  104. <tr>
  105. <td><span class="xref">System.String</span></td>
  106. <td></td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. <h3 id="methods">Methods
  111. </h3>
  112. <a id="Grpc_Net_Compression_ICompressionProvider_CreateCompressionStream_" data-uid="Grpc.Net.Compression.ICompressionProvider.CreateCompressionStream*"></a>
  113. <h4 id="Grpc_Net_Compression_ICompressionProvider_CreateCompressionStream_Stream_System_Nullable_CompressionLevel__" data-uid="Grpc.Net.Compression.ICompressionProvider.CreateCompressionStream(Stream,System.Nullable{CompressionLevel})">CreateCompressionStream(Stream, Nullable&lt;CompressionLevel&gt;)</h4>
  114. <div class="markdown level1 summary"><p>Create a new compression stream.</p>
  115. </div>
  116. <div class="markdown level1 conceptual"></div>
  117. <h5 class="decalaration">Declaration</h5>
  118. <div class="codewrapper">
  119. <pre><code class="lang-csharp hljs">Stream CreateCompressionStream(Stream stream, CompressionLevel? compressionLevel)</code></pre>
  120. </div>
  121. <h5 class="parameters">Parameters</h5>
  122. <table class="table table-bordered table-striped table-condensed">
  123. <thead>
  124. <tr>
  125. <th>Type</th>
  126. <th>Name</th>
  127. <th>Description</th>
  128. </tr>
  129. </thead>
  130. <tbody>
  131. <tr>
  132. <td><span class="xref">Stream</span></td>
  133. <td><span class="parametername">stream</span></td>
  134. <td><p>The stream that compressed data is written to.</p>
  135. </td>
  136. </tr>
  137. <tr>
  138. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">CompressionLevel</span>&gt;</td>
  139. <td><span class="parametername">compressionLevel</span></td>
  140. <td><p>The compression level.</p>
  141. </td>
  142. </tr>
  143. </tbody>
  144. </table>
  145. <h5 class="returns">Returns</h5>
  146. <table class="table table-bordered table-striped table-condensed">
  147. <thead>
  148. <tr>
  149. <th>Type</th>
  150. <th>Description</th>
  151. </tr>
  152. </thead>
  153. <tbody>
  154. <tr>
  155. <td><span class="xref">Stream</span></td>
  156. <td><p>A stream used to compress data.</p>
  157. </td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <a id="Grpc_Net_Compression_ICompressionProvider_CreateDecompressionStream_" data-uid="Grpc.Net.Compression.ICompressionProvider.CreateDecompressionStream*"></a>
  162. <h4 id="Grpc_Net_Compression_ICompressionProvider_CreateDecompressionStream_Stream_" data-uid="Grpc.Net.Compression.ICompressionProvider.CreateDecompressionStream(Stream)">CreateDecompressionStream(Stream)</h4>
  163. <div class="markdown level1 summary"><p>Create a new decompression stream.</p>
  164. </div>
  165. <div class="markdown level1 conceptual"></div>
  166. <h5 class="decalaration">Declaration</h5>
  167. <div class="codewrapper">
  168. <pre><code class="lang-csharp hljs">Stream CreateDecompressionStream(Stream stream)</code></pre>
  169. </div>
  170. <h5 class="parameters">Parameters</h5>
  171. <table class="table table-bordered table-striped table-condensed">
  172. <thead>
  173. <tr>
  174. <th>Type</th>
  175. <th>Name</th>
  176. <th>Description</th>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td><span class="xref">Stream</span></td>
  182. <td><span class="parametername">stream</span></td>
  183. <td><p>The stream that compressed data is copied from.</p>
  184. </td>
  185. </tr>
  186. </tbody>
  187. </table>
  188. <h5 class="returns">Returns</h5>
  189. <table class="table table-bordered table-striped table-condensed">
  190. <thead>
  191. <tr>
  192. <th>Type</th>
  193. <th>Description</th>
  194. </tr>
  195. </thead>
  196. <tbody>
  197. <tr>
  198. <td><span class="xref">Stream</span></td>
  199. <td><p>A stream used to decompress data.</p>
  200. </td>
  201. </tr>
  202. </tbody>
  203. </table>
  204. </article>
  205. </div>
  206. <div class="hidden-sm col-md-2" role="complementary">
  207. <div class="sideaffix">
  208. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  209. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  210. </nav>
  211. </div>
  212. </div>
  213. </div>
  214. </div>
  215. <footer>
  216. <div class="grad-bottom"></div>
  217. <div class="footer">
  218. <div class="container">
  219. <span class="pull-right">
  220. <a href="#top">Back to top</a>
  221. </span>
  222. <span>Generated by <strong>DocFX</strong></span>
  223. </div>
  224. </div>
  225. </footer>
  226. </div>
  227. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  228. <script type="text/javascript" src="../styles/docfx.js"></script>
  229. <script type="text/javascript" src="../styles/main.js"></script>
  230. </body>
  231. </html>