View Javadoc
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.handler.codec.http.websocketx.BinaryWebSocketFrame;
19  import io.netty.handler.codec.http.websocketx.ContinuationWebSocketFrame;
20  import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
21  import io.netty.handler.codec.http.websocketx.WebSocketFrame;
22  import io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension;
23  import io.netty.handler.codec.http.websocketx.extensions.WebSocketExtensionFilter;
24  
25  /**
26   * Per-frame implementation of deflate decompressor.
27   */
28  class PerFrameDeflateDecoder extends DeflateDecoder {
29  
30      /**
31       * Constructor
32       *
33       * @param noContext true to disable context takeover.
34       * @param maxAllocation
35       *          maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.
36       */
37      PerFrameDeflateDecoder(boolean noContext, int maxAllocation) {
38          super(noContext, WebSocketExtensionFilter.NEVER_SKIP, maxAllocation);
39      }
40  
41      /**
42       * Constructor
43       *
44       * @param noContext true to disable context takeover.
45       * @param extensionDecoderFilter extension decoder filter for per frame deflate decoder.
46       * @param maxAllocation
47       *            maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.
48       */
49      PerFrameDeflateDecoder(boolean noContext, WebSocketExtensionFilter extensionDecoderFilter, int maxAllocation) {
50          super(noContext, extensionDecoderFilter, maxAllocation);
51      }
52  
53      @Override
54      public boolean acceptInboundMessage(Object msg) throws Exception {
55          if (!super.acceptInboundMessage(msg)) {
56              return false;
57          }
58  
59          WebSocketFrame wsFrame = (WebSocketFrame) msg;
60          if (extensionDecoderFilter().mustSkip(wsFrame)) {
61              return false;
62          }
63  
64          return (msg instanceof TextWebSocketFrame || msg instanceof BinaryWebSocketFrame ||
65                  msg instanceof ContinuationWebSocketFrame) &&
66                 (wsFrame.rsv() & WebSocketExtension.RSV1) > 0;
67      }
68  
69      @Override
70      protected int newRsv(WebSocketFrame msg) {
71          return msg.rsv() ^ WebSocketExtension.RSV1;
72      }
73  
74      @Override
75      protected boolean appendFrameTail(WebSocketFrame msg) {
76          return true;
77      }
78  
79  }