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 * 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.buffer.api.Buffer;
19 import io.netty5.util.Resource;
20 import io.netty5.util.internal.UnstableApi;
21
22 /**
23 * HTTP/2 DATA frame.
24 */
25 @UnstableApi
26 public interface Http2DataFrame extends Http2StreamFrame, Resource<Http2DataFrame> {
27
28 /**
29 * Frame padding to use. Will be non-negative and less than 256.
30 */
31 int padding();
32
33 /**
34 * Payload of DATA frame. Will not be {@code null}.
35 */
36 Buffer content();
37
38 /**
39 * Returns the number of bytes that are flow-controlled initially, so even if the {@link #content()} is consumed
40 * this will not change.
41 */
42 int initialFlowControlledBytes();
43
44 /**
45 * Returns {@code true} if the END_STREAM flag is set.
46 */
47 boolean isEndStream();
48
49 /**
50 * Produce a copy of this data frame, which contain a copy of the frame {@linkplain #content() contents}.
51 *
52 * @return A copy of this data frame.
53 */
54 Http2DataFrame copy();
55 }