1 /*
2 * Copyright 2012 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.http;
17
18 import io.netty5.buffer.api.Buffer;
19 import io.netty5.util.Resource;
20 import io.netty5.channel.ChannelPipeline;
21
22 /**
23 * An HTTP chunk which is used for HTTP chunked transfer-encoding.
24 * {@link HttpObjectDecoder} generates {@link HttpContent} after
25 * {@link HttpMessage} when the content is large or the encoding of the content
26 * is 'chunked. If you prefer not to receive {@link HttpContent} in your handler,
27 * place {@link HttpObjectAggregator} after {@link HttpObjectDecoder} in the
28 * {@link ChannelPipeline}.
29 */
30 public interface HttpContent<R extends HttpContent<R>> extends HttpObject, Resource<R> {
31
32 /**
33 * Returns the {@link Buffer} representing the payload of the HTTP message.
34 *
35 * @return The {@link Buffer} representing the payload of the HTTP message.
36 */
37 Buffer payload();
38
39 /**
40 * Create a copy of this HTTP content instance, and return it.
41 *
42 * @return A copy of this HTTP content object.
43 */
44 R copy();
45 }