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  
17  package io.netty.handler.codec.http2;
18  
19  import io.netty.handler.codec.http2.Http2Stream.State;
20  import io.netty.util.internal.UnstableApi;
21  
22  /**
23   * A single stream within a HTTP/2 connection. To be used with the {@link Http2FrameCodec}.
24   */
25  @UnstableApi
26  public interface Http2FrameStream {
27      /**
28       * Returns the stream identifier.
29       *
30       * <p>Use {@link Http2CodecUtil#isStreamIdValid(int)} to check if the stream has already been assigned an
31       * identifier.
32       */
33      int id();
34  
35      /**
36       * Returns the state of this stream.
37       */
38      State state();
39  }