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