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    *   http://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 org.jboss.netty.handler.codec.spdy;
17  
18  import org.jboss.netty.buffer.ChannelBuffer;
19  
20  abstract class SpdyHeaderBlockDecoder {
21  
22      static SpdyHeaderBlockDecoder newInstance(SpdyVersion spdyVersion, int maxHeaderSize) {
23          return new SpdyHeaderBlockZlibDecoder(spdyVersion, maxHeaderSize);
24      }
25  
26      /**
27       * Decodes a SPDY Header Block, adding the Name/Value pairs to the given Headers frame.
28       * If the header block is malformed, the Headers frame will be marked as invalid.
29       * A stream error with status code PROTOCOL_ERROR must be issued in response to an invalid frame.
30       *
31       * @param headerBlock the HeaderBlock to decode
32       * @param frame the Headers frame that receives the Name/Value pairs
33       * @throws Exception If the header block is malformed in a way that prevents any future
34       *                   decoding of any other header blocks, an exception will be thrown.
35       *                   A session error with status code PROTOCOL_ERROR must be issued.
36       */
37      abstract void decode(ChannelBuffer headerBlock, SpdyHeadersFrame frame) throws Exception;
38  
39      abstract void endHeaderBlock(SpdyHeadersFrame frame) throws Exception;
40  
41      abstract void end();
42  }