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 * http://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.stream;
17
18
19 import io.netty.channel.ChannelHandlerContext;
20
21 /**
22 * A data stream of indefinite length which is consumed by {@link ChunkedWriteHandler}.
23 */
24 public interface ChunkedInput<B> {
25
26 /**
27 * Return {@code true} if and only if there is no data left in the stream
28 * and the stream has reached at its end.
29 */
30 boolean isEndOfInput() throws Exception;
31
32 /**
33 * Releases the resources associated with the input.
34 */
35 void close() throws Exception;
36
37 /**
38 * Fetches a chunked data from the stream. Once this method returns the last chunk
39 * and thus the stream has reached at its end, any subsequent {@link #isEndOfInput()}
40 * call must return {@code true}.
41 *
42 * @return the fetched chunk.
43 * {@code null} if there is no data left in the stream.
44 * Please note that {@code null} does not necessarily mean that the
45 * stream has reached at its end. In a slow stream, the next chunk
46 * might be unavailable just momentarily.
47 */
48 B readChunk(ChannelHandlerContext ctx) throws Exception;
49
50 }