View Javadoc

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  /**
19   * A SPDY Protocol SYN_STREAM Control Frame
20   */
21  public interface SpdySynStreamFrame extends SpdyHeaderBlock {
22  
23      /**
24       * @deprecated Use {@link #getStreamId()} instead.
25       */
26      @Deprecated
27      int getStreamID();
28  
29      /**
30       * Returns the Stream-ID of this frame.
31       */
32      int getStreamId();
33  
34      /**
35       * @deprecated Use {@link #setStreamId(int)} instead.
36       */
37      @Deprecated
38      void setStreamID(int streamID);
39  
40      /**
41       * Sets the Stream-ID of this frame.  The Stream-ID must be positive.
42       */
43      void setStreamId(int streamId);
44  
45      /**
46       * @deprecated Use {@link #getAssociatedToStreamId()} instead.
47       */
48      @Deprecated
49      int getAssociatedToStreamID();
50  
51      /**
52       * Returns the Associated-To-Stream-ID of this frame.
53       */
54      int getAssociatedToStreamId();
55  
56      /**
57       * @deprecated Use {@link #setAssociatedToStreamId(int)} instead.
58       */
59      @Deprecated
60      void setAssociatedToStreamID(int associatedToStreamId);
61  
62      /**
63       * Sets the Associated-To-Stream-ID of this frame.
64       * The Associated-To-Stream-ID cannot be negative.
65       */
66      void setAssociatedToStreamId(int associatedToStreamId);
67  
68      /**
69       * Returns the priority of the stream.
70       */
71      byte getPriority();
72  
73      /**
74       * Sets the priority of the stream.
75       * The priority must be between 0 and 7 inclusive.
76       */
77      void setPriority(byte priority);
78  
79      /**
80       * Returns {@code true} if this frame is the last frame to be transmitted
81       * on the stream.
82       */
83      boolean isLast();
84  
85      /**
86       * Sets if this frame is the last frame to be transmitted on the stream.
87       */
88      void setLast(boolean last);
89  
90      /**
91       * Returns {@code true} if the stream created with this frame is to be
92       * considered half-closed to the receiver.
93       */
94      boolean isUnidirectional();
95  
96      /**
97       * Sets if the stream created with this frame is to be considered
98       * half-closed to the receiver.
99       */
100     void setUnidirectional(boolean unidirectional);
101 }