1 /*
2 * Copyright 2017 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 @UnstableApi
23 public interface Http2UnknownFrame extends Http2StreamFrame, Resource<Http2UnknownFrame> {
24
25 /**
26 * Get the data content associated with this unknown frame.
27 * <p>
28 * The buffer will be empty if there is no data with this unknown frame.
29 *
30 * @return The contents of this unknown frame.
31 */
32 Buffer content();
33
34 @Override
35 Http2FrameStream stream();
36
37 @Override
38 Http2UnknownFrame stream(Http2FrameStream stream);
39
40 /**
41 * Get the raw frame type.
42 *
43 * This is the type value that wasn't recognized and caused this to be captured as an unknown frame.
44 *
45 * @return The raw frame type.
46 */
47 byte frameType();
48
49 /**
50 * Get the {@link Http2Flags} set on this unknown frame.
51 *
52 * @return The flags set on this frame.
53 */
54 Http2Flags flags();
55
56 /**
57 * Create a copy of this unknown frame, which in turn contain a copy of the frame {@linkplain #content() contents}.
58 *
59 * @return A copy of this unknown frame.
60 */
61 Http2UnknownFrame copy();
62 }