1 /*
2 * Copyright 2014 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.handler.codec.http.websocketx.extensions.compression;
17
18 import io.netty.channel.ChannelHandler;
19 import io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtensionHandler;
20
21 /**
22 * Extends <tt>io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketClientExtensionHandler</tt>
23 * to handle the most common WebSocket Compression Extensions.
24 *
25 * See <tt>io.netty.example.http.websocketx.client.WebSocketClient</tt> for usage.
26 */
27 @ChannelHandler.Sharable
28 public final class WebSocketClientCompressionHandler extends WebSocketClientExtensionHandler {
29
30 /**
31 * @deprecated Use {@link WebSocketClientCompressionHandler#WebSocketClientCompressionHandler(int)}
32 */
33 @Deprecated
34 public static final WebSocketClientCompressionHandler INSTANCE = new WebSocketClientCompressionHandler();
35
36 private WebSocketClientCompressionHandler() {
37 this(0);
38 }
39
40 /**
41 * Constructor with default configuration.
42 * @param maxAllocation
43 * Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.
44 */
45 public WebSocketClientCompressionHandler(int maxAllocation) {
46 super(new PerMessageDeflateClientExtensionHandshaker(maxAllocation),
47 new DeflateFrameClientExtensionHandshaker(false, maxAllocation),
48 new DeflateFrameClientExtensionHandshaker(true, maxAllocation));
49 }
50
51 }