1 /*
2 * Copyright 2020 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.netty5.handler.codec.http2;
17
18 import io.netty5.util.internal.UnstableApi;
19
20 /**
21 * HTTP/2 Push Promise Frame
22 */
23 @UnstableApi
24 public interface Http2PushPromiseFrame extends Http2StreamFrame {
25
26 /**
27 * Set the Promise {@link Http2FrameStream} object for this frame.
28 */
29 Http2StreamFrame pushStream(Http2FrameStream stream);
30
31 /**
32 * Returns the Promise {@link Http2FrameStream} object for this frame, or {@code null} if the
33 * frame has yet to be associated with a stream.
34 */
35 Http2FrameStream pushStream();
36
37 /**
38 * {@link Http2Headers} sent in Push Promise
39 */
40 Http2Headers http2Headers();
41
42 /**
43 * Frame padding to use. Will be non-negative and less than 256.
44 */
45 int padding();
46
47 /**
48 * Promised Stream ID
49 */
50 int promisedStreamId();
51
52 @Override
53 Http2PushPromiseFrame stream(Http2FrameStream stream);
54
55 }