21 |
22 |
30 |
31 | The default compression used is deflate, then gzip, as deflate should be faster.
32 | Brotli is supported only in .NET Standard 2.1 or higher (e.g., .NET 8.0, .NET 6.0), using ASP.NET Core's built-in BrotliStream support.
33 | This also supports streaming responses. The config allows you to disable deflate and streaming if you prefer.
34 |
35 |
36 | eTag-caching
37 | ----------
38 |
39 | 1. When the server reads the content before compression, it calculates a hash-code over it.
40 | 2. The hash-code is sent as ETag response header to the client with the response
41 | 3. The next time the client asks for the same resource, it sends an If-None-Match header in the request with the same value.
42 | 4. After the server reads the content before the compression, it calculates a hash-code over it. If it matches the If-None-Match of the request, the server can skip the compression and skip the sending and just send http status code 304 to the client which means "use what you have, it's not modified since".
43 |
44 |
45 | Example #1
46 | ----------
47 |
48 | This example demonstrates using MapCompressionModule-function defined in this sample library.
49 |
50 | ```csharp
51 | using System;
52 | using Owin;
53 | [assembly: Microsoft.Owin.OwinStartup(typeof(MyServer.MyWebStartup))]
54 | namespace MyServer
55 | {
56 | class MyWebStartup
57 | {
58 | public void Configuration(Owin.IAppBuilder app)
59 | {
60 | // This will compress the whole request, if you want to use e.g. Microsoft.Owin.StaticFiles server:
61 | // app.UseCompressionModule()
62 |
63 | var settings = OwinCompression.DefaultCompressionSettingsWithPath("c:\\temp\\"); //" server path
64 | //or var settings = new CompressionSettings( ... )
65 | app.MapCompressionModule("/zipped", settings);
66 | }
67 | }
68 |
69 | class Program
70 | {
71 | static void Main(string[] args)
72 | {
73 | Microsoft.Owin.Hosting.WebApp.Start
23 |
28 |
29 |
24 | The Owin.Compression library can be installed from NuGet:
25 |
27 | PM> Install-Package Owin.Compression26 |
84 |
85 | Even though the browser sees everything as plain text, the traffic is actually transferred in compressed format.
86 | You can monitor the traffic with e.g. Fiddler.
87 |
88 | Example #2
89 | ----------
90 |
91 | Running on OWIN Self-Host (Microsoft.Owin.Hosting) with static files server (Microsoft.Owin.StaticFiles)
92 | and compressing only the ".json"-responses (and files) on-the-fly, with only gzip and not deflate:
93 |
94 | ```csharp
95 | using System;
96 | using Owin;
97 | [assembly: Microsoft.Owin.OwinStartup(typeof(MyServer.MyWebStartup))]
98 | namespace MyServer
99 | {
100 | class MyWebStartup
101 | {
102 | public void Configuration(Owin.IAppBuilder app)
103 | {
104 | var settings = new CompressionSettings(
105 | serverPath: "",
106 | allowUnknonwnFiletypes: false,
107 | allowRootDirectories: false,
108 | cacheExpireTime: Microsoft.FSharp.Core.FSharpOption