org.apache.commons.httpclient
Class ChunkedInputStream
InputStream
org.apache.commons.httpclient.ChunkedInputStream
public class ChunkedInputStream
extends InputStream
Transparently coalesces chunks of a HTTP stream that uses
Transfer-Encoding chunked.
Note that this class NEVER closes the underlying stream, even when close
gets called. Instead, it will read until the "end" of its chunking on close,
which allows for the seamless invocation of subsequent HTTP 1.1 calls, while
not requiring the client to remember to read the entire contents of the
response.
void | close() - Upon close, this reads the remainder of the chunked message,
leaving the underlying socket at a position to start reading the
next response without scanning.
|
int | read() - Returns all the data in a chunked stream in coalesced form.
|
int | read(byte[] b) - Read some bytes from the stream.
|
int | read(byte[] b, int off, int len) - Read some bytes from the stream.
|
ChunkedInputStream
public ChunkedInputStream(InputStream in)
throws IOException
ChunkedInputStream constructor
in
- the raw input stream
ChunkedInputStream
public ChunkedInputStream(InputStream in,
HttpMethod method)
throws IOException
ChunkedInputStream constructor that associates the chunked input stream with a
HTTP method
. Usually it should be the same
HTTP method
the chunked input stream originates from. If chunked input stream
contains any footers (trailing headers), they will be added to the associated
HTTP method
.
in
- the raw input streammethod
- the HTTP method to associate this input stream with. Can be null.
close
public void close()
throws IOException
Upon close, this reads the remainder of the chunked message,
leaving the underlying socket at a position to start reading the
next response without scanning.
read
public int read()
throws IOException
Returns all the data in a chunked stream in coalesced form. A chunk
is followed by a CRLF. The method returns -1 as soon as a chunksize of 0
is detected.
Trailer headers are read automcatically at the end of the stream and
can be obtained with the getResponseFooters() method.
- -1 of the end of the stream has been reached or the next data
byte
read
public int read(byte[] b)
throws IOException
Read some bytes from the stream.
b
- The byte array that will hold the contents from the stream.
- The number of bytes returned or -1 if the end of stream has been
reached.
java.io.InputStream.read(byte[])
read
public int read(byte[] b,
int off,
int len)
throws IOException
Read some bytes from the stream.
b
- The byte array that will hold the contents from the stream.off
- The offset into the byte array at which bytes will start to be
placed.len
- the maximum number of bytes that can be returned.
- The number of bytes returned or -1 if the end of stream has been
reached.
java.io.InputStream.read(byte[], int, int)
Copyright (c) 1999-2005 - Apache Software Foundation