1 /*
2 * Copyright 2012 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 import org.jboss.netty.buffer.ChannelBuffers;
20
21 /**
22 * A SPDY Protocol Data Frame
23 */
24 public interface SpdyDataFrame {
25
26 /**
27 * @deprecated Use {@link #getStreamId()} instead.
28 */
29 @Deprecated
30 int getStreamID();
31
32 /**
33 * Returns the Stream-ID of this frame.
34 */
35 int getStreamId();
36
37 /**
38 * @deprecated Use {@link #setStreamId(int)} instead.
39 */
40 @Deprecated
41 void setStreamID(int streamID);
42
43 /**
44 * Sets the Stream-ID of this frame. The Stream-ID must be positive.
45 */
46 void setStreamId(int streamID);
47
48 /**
49 * Returns {@code true} if this frame is the last frame to be transmitted
50 * on the stream.
51 */
52 boolean isLast();
53
54 /**
55 * Sets if this frame is the last frame to be transmitted on the stream.
56 */
57 void setLast(boolean last);
58
59 /**
60 * @deprecated Removed from SPDY specification.
61 */
62 @Deprecated
63 boolean isCompressed();
64
65 /**
66 * @deprecated Removed from SPDY specification.
67 */
68 @Deprecated
69 void setCompressed(boolean compressed);
70
71 /**
72 * Returns the data payload of this frame. If there is no data payload
73 * {@link ChannelBuffers#EMPTY_BUFFER} is returned.
74 */
75 ChannelBuffer getData();
76
77 /**
78 * Sets the data payload of this frame. If {@code null} is specified,
79 * the data payload will be set to {@link ChannelBuffers#EMPTY_BUFFER}.
80 * The data payload cannot exceed 16777215 bytes.
81 */
82 void setData(ChannelBuffer data);
83 }