org.apache.hc.core5.http.impl.io

类 ContentLengthInputStream

java.lang.Object

java.io.InputStream

org.apache.hc.core5.http.impl.io.ContentLengthInputStream

所有已实现的接口:

Closeable, AutoCloseable

public class ContentLengthInputStream
extends InputStream

Input stream that cuts off after a defined number of bytes. This class is used to receive content of HTTP messages where the end of the content entity is determined by the value of the Content-Length header. Entities transferred using this stream can be maximum Long.MAX_VALUE long.

Note that this class NEVER closes the underlying stream, even when close() gets called. Instead, it will read until the "end" of its limit on close, which allows for the seamless execution of subsequent HTTP 1.1 requests, while not requiring the client to remember to read the entire contents of the response.

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
ContentLengthInputStream(SessionInputBuffer buffer, InputStream inputStream, long contentLength) Default constructor.

方法概要

限定符和类型	方法和说明
int	available()
void	close() Reads until the end of the known length of content.
int	read() Read the next byte from the stream
int	read(byte[] b) Read more bytes from the stream.
int	read(byte[] b, int off, int len) Does standard InputStream.read(byte[], int, int) behavior, but also notifies the watcher when the contents have been consumed.
long	skip(long n) Skips and discards a number of bytes from the input stream.

从类继承的方法 java.io.InputStream

mark, markSupported, reset

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ContentLengthInputStream

public ContentLengthInputStream(SessionInputBuffer buffer,
                                InputStream inputStream,
                                long contentLength)

Default constructor.

参数:

buffer - Session input buffer

inputStream - Input stream

contentLength - The maximum number of bytes that can be read from the stream. Subsequent read operations will return -1.

方法详细资料

close

public void close()
           throws IOException

Reads until the end of the known length of content.

Does NOT close the underlying stream, but instead leaves it primed to parse the next response.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 InputStream

抛出:

IOException - If an IO problem occurs.

available

public int available()
              throws IOException

覆盖:

available 在类中 InputStream

抛出:

IOException

read

public int read()
         throws IOException

Read the next byte from the stream

指定者:

read 在类中 InputStream

返回:

The next byte or -1 if the end of stream has been reached.

抛出:

IOException - If an IO problem occurs

另请参阅:

InputStream.read()

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Does standard InputStream.read(byte[], int, int) behavior, but also notifies the watcher when the contents have been consumed.

覆盖:

read 在类中 InputStream

参数:

b - The byte array to fill.

off - Start filling at this position.

len - The number of bytes to attempt to read.

返回:

The number of bytes read, or -1 if the end of content has been reached.

抛出:

IOException - Should an error occur on the wrapped stream.

read

public int read(byte[] b)
         throws IOException

Read more bytes from the stream.

覆盖:

read 在类中 InputStream

参数:

b - The byte array to put the new data in.

返回:

The number of bytes read into the buffer.

抛出:

IOException - If an IO problem occurs

另请参阅:

InputStream.read(byte[])

skip

public long skip(long n)
          throws IOException

Skips and discards a number of bytes from the input stream.

覆盖:

skip 在类中 InputStream

参数:

n - The number of bytes to skip.

返回:

The actual number of bytes skipped. ≤ 0 if no bytes are skipped.

抛出:

IOException - If an error occurs while skipping bytes.

另请参阅:

InputStream.skip(long)