java.lang.Object | ||
↳ | org.apache.http.nio.util.ExpandableBuffer | |
↳ | org.apache.http.nio.util.SharedInputBuffer |
Implementation of the ContentInputBuffer
interface that can be
shared by multiple threads, usually the I/O dispatch of an I/O reactor and
a worker thread.
The I/O dispatch thread is expect to transfer data from ContentDecoder
to the buffer
by calling consumeContent(ContentDecoder)
.
The worker thread is expected to read the data from the buffer by calling
read()
or read(byte[], int, int)
methods.
In case of an abnormal situation or when no longer needed the buffer must be shut down
using shutdown()
method.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.http.nio.util.ExpandableBuffer
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.http.nio.util.ExpandableBuffer
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns available capacity of this buffer.
| |||||||||||
Returns the total capacity of this buffer.
| |||||||||||
Reads content from the given
ContentDecoder and stores it in
this buffer. | |||||||||||
Determines if the buffer contains data.
| |||||||||||
Returns the length of this buffer.
| |||||||||||
Reads one byte from this buffer.
| |||||||||||
Reads up to
len bytes of data from this buffer into
an array of bytes. | |||||||||||
Resets the buffer by clearing its state and stored content.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.http.nio.util.ExpandableBuffer
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.apache.http.io.BufferInfo
| |||||||||||
From interface
org.apache.http.nio.util.BufferInfo
| |||||||||||
From interface
org.apache.http.nio.util.ContentInputBuffer
|
Returns available capacity of this buffer.
Returns the total capacity of this buffer.
Reads content from the given ContentDecoder
and stores it in
this buffer.
decoder | the content decoder. |
---|
IOException |
---|
Determines if the buffer contains data.
true
if there is data in the buffer,
false
otherwise.
Returns the length of this buffer.
Reads one byte from this buffer. If the buffer is empty this method can
throw a runtime exception. The exact type of runtime exception thrown
by this method depends on implementation. This method returns
-1
if the end of content stream has been reached.
IOException |
---|
Reads up to len
bytes of data from this buffer into
an array of bytes. The exact number of bytes read depends how many bytes
are stored in the buffer.
If off
is negative, or len
is negative, or
off+len
is greater than the length of the array
b
, this method can throw a runtime exception. The exact type
of runtime exception thrown by this method depends on implementation.
This method returns -1
if the end of content stream has been
reached.
b | the buffer into which the data is read. |
---|---|
off | the start offset in array b
at which the data is written. |
len | the maximum number of bytes to read. |
-1
if there is no more data because the end of
the stream has been reached.IOException |
---|
Resets the buffer by clearing its state and stored content.