Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Classes

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

ChunkedInputStream

extends InputStream

java.lang.Object
↳	java.io.InputStream
	↳	org.apache.http.impl.io.ChunkedInputStream

Class Overview

Implements chunked transfer coding. See RFC 2616 , section 3.6.1 . It transparently coalesces chunks of a HTTP stream that uses chunked transfer coding. After the stream is read to the end, it provides access to the trailers, if any.

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 execution of subsequent HTTP 1.1 requests, while not requiring the client to remember to read the entire contents of the response.

Summary

Public Constructors
	ChunkedInputStream ( SessionInputBuffer in)

Public Methods
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.
Header[]	getFooters ()
int	read (byte[] b) Read some bytes from the stream.
int	read () Returns all the data in a chunked stream in coalesced form.
int	read (byte[] b, int off, int len) Read some bytes from the stream.

[Expand]

Inherited Methods

From class java.io.InputStream

int	available () Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close () Closes this stream.
void	mark (int readlimit) Sets a mark position in this InputStream.
boolean	markSupported () Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read (byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)` .
abstract int	read () Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read (byte[] buffer, int byteOffset, int byteCount) Reads up to `byteCount` bytes from this stream and stores them in the byte array `buffer` starting at `byteOffset` .
synchronized void	reset () Resets this stream to the last marked location.
long	skip (long byteCount) Skips at most `byteCount` bytes in this stream.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.AutoCloseable

Public Constructors

public ChunkedInputStream ( SessionInputBuffer in)

Added in API level 1

Public Methods

public void close ()

Added in API level 1

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.

Throws

IOException	If an IO problem occurs.

public Header[] getFooters ()

Added in API level 1

public int read (byte[] b)

Added in API level 1

Read some bytes from the stream.

Parameters

b	The byte array that will hold the contents from the stream.

Returns

The number of bytes returned or -1 if the end of stream has been reached.

Throws

IOException	if an IO problem occurs.

public int read ()

Added in API level 1

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.

Returns

-1 of the end of the stream has been reached or the next data byte

Throws

IOException	If an IO problem occurs

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

Added in API level 1

Read some bytes from the stream.

Parameters

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.

Returns

The number of bytes returned or -1 if the end of stream has been reached.

Throws

IOException	if an IO problem occurs.

Results

Classes

ChunkedInputStream

Class Overview

Summary

Public Constructors

public ChunkedInputStream ( SessionInputBuffer in)

Public Methods

public void close ()

Throws

public Header[] getFooters ()

public int read (byte[] b)

Parameters

Returns

Throws

See Also

public int read ()

Returns

Throws

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

Parameters

Returns

Throws

See Also