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.spdy;
17
18 import io.netty.buffer.ByteBuf;
19 import io.netty.buffer.ByteBufAllocator;
20
21 /**
22 * Super-class for SPDY header-block decoders.
23 *
24 * @see SpdyHeaderBlockRawDecoder
25 * @see SpdyHeaderBlockZlibDecoder
26 */
27 public abstract class SpdyHeaderBlockDecoder {
28
29 static SpdyHeaderBlockDecoder newInstance(SpdyVersion spdyVersion, int maxHeaderSize) {
30 return new SpdyHeaderBlockZlibDecoder(spdyVersion, maxHeaderSize);
31 }
32
33 /**
34 * Decodes a SPDY Header Block, adding the Name/Value pairs to the given Headers frame.
35 * If the header block is malformed, the Headers frame will be marked as invalid.
36 * A stream error with status code PROTOCOL_ERROR must be issued in response to an invalid frame.
37 *
38 * @param alloc the {@link ByteBufAllocator} which can be used to allocate new {@link ByteBuf}s
39 * @param headerBlock the HeaderBlock to decode
40 * @param frame the Headers frame that receives the Name/Value pairs
41 * @throws Exception If the header block is malformed in a way that prevents any future
42 * decoding of any other header blocks, an exception will be thrown.
43 * A session error with status code PROTOCOL_ERROR must be issued.
44 */
45 abstract void decode(ByteBufAllocator alloc, ByteBuf headerBlock, SpdyHeadersFrame frame) throws Exception;
46
47 abstract void endHeaderBlock(SpdyHeadersFrame frame) throws Exception;
48
49 abstract void end();
50 }