io.netty.handler.stream.ChunkedInput Maven / Gradle / Ivy
/*
* Copyright 2012 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.stream;
import io.netty.buffer.ByteBufAllocator;
import io.netty.channel.ChannelHandlerContext;
/**
* A data stream of indefinite length which is consumed by {@link ChunkedWriteHandler}.
*/
public interface ChunkedInput {
/**
* Return {@code true} if and only if there is no data left in the stream
* and the stream has reached at its end.
*/
boolean isEndOfInput() throws Exception;
/**
* Releases the resources associated with the input.
*/
void close() throws Exception;
/**
* @deprecated Use {@link #readChunk(ByteBufAllocator)}.
*
* Fetches a chunked data from the stream. Once this method returns the last chunk
* and thus the stream has reached at its end, any subsequent {@link #isEndOfInput()}
* call must return {@code true}.
*
* @param ctx The context which provides a {@link ByteBufAllocator} if buffer allocation is necessary.
* @return the fetched chunk.
* {@code null} if there is no data left in the stream.
* Please note that {@code null} does not necessarily mean that the
* stream has reached at its end. In a slow stream, the next chunk
* might be unavailable just momentarily.
*/
@Deprecated
B readChunk(ChannelHandlerContext ctx) throws Exception;
/**
* Fetches a chunked data from the stream. Once this method returns the last chunk
* and thus the stream has reached at its end, any subsequent {@link #isEndOfInput()}
* call must return {@code true}.
*
* @param allocator {@link ByteBufAllocator} if buffer allocation is necessary.
* @return the fetched chunk.
* {@code null} if there is no data left in the stream.
* Please note that {@code null} does not necessarily mean that the
* stream has reached at its end. In a slow stream, the next chunk
* might be unavailable just momentarily.
*/
B readChunk(ByteBufAllocator allocator) throws Exception;
/**
* Returns the length of the input.
* @return the length of the input if the length of the input is known.
* a negative value if the length of the input is unknown.
*/
long length();
/**
* Returns current transfer progress.
*/
long progress();
}