View Javadoc
1   /*
2    * Copyright 2016 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 io.netty.handler.codec.http2;
17  
18  import io.netty.util.internal.UnstableApi;
19  
20  /**
21   * A frame whose meaning <em>may</em> apply to a particular stream, instead of the entire connection. It is still
22   * possible for this frame type to apply to the entire connection. In such cases, the {@link #stream()} must return
23   * {@code null}. If the frame applies to a stream, the {@link Http2FrameStream#id()} must be greater than zero.
24   */
25  @UnstableApi
26  public interface Http2StreamFrame extends Http2Frame {
27  
28      /**
29       * Set the {@link Http2FrameStream} object for this frame.
30       */
31      Http2StreamFrame stream(Http2FrameStream stream);
32  
33      /**
34       * Returns the {@link Http2FrameStream} object for this frame, or {@code null} if the frame has yet to be associated
35       * with a stream.
36       */
37      Http2FrameStream stream();
38  }