@NotThreadSafe public abstract class AbstractSessionInputBuffer extends Object implements SessionInputBuffer, BufferInfo
InputStream. This class buffers input data in
an internal byte array for optimal input performance.
readLine(CharArrayBuffer) and readLine() methods of this
class treat a lone LF as valid line delimiters in addition to CR-LF required
by the HTTP specification.
The following parameters can be used to customize the behavior of this class:
| Constructor and Description |
|---|
AbstractSessionInputBuffer() |
| Modifier and Type | Method and Description |
|---|---|
int |
available()
Returns available space in the buffer.
|
int |
capacity()
Returns total capacity of the buffer
|
protected HttpTransportMetricsImpl |
createTransportMetrics() |
protected int |
fillBuffer() |
HttpTransportMetrics |
getMetrics()
Returns
HttpTransportMetrics for this session buffer. |
protected boolean |
hasBufferedData() |
protected void |
init(InputStream instream,
int buffersize,
HttpParams params)
Initializes this session input buffer.
|
int |
length()
Return length data stored in the buffer
|
int |
read()
Reads the next byte of data from this session buffer.
|
int |
read(byte[] b)
Reads some number of bytes from the session buffer and stores them into
the buffer array
b. |
int |
read(byte[] b,
int off,
int len)
Reads up to
len bytes of data from the session buffer into
an array of bytes. |
String |
readLine()
Reads a complete line of characters up to a line delimiter from this
session buffer.
|
int |
readLine(CharArrayBuffer charbuffer)
Reads a complete line of characters up to a line delimiter from this
session buffer into the given line buffer.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisDataAvailableprotected void init(InputStream instream, int buffersize, HttpParams params)
instream - the source input stream.buffersize - the size of the internal buffer.params - HTTP parameters.protected HttpTransportMetricsImpl createTransportMetrics()
public int capacity()
BufferInfocapacity in interface BufferInfopublic int length()
BufferInfolength in interface BufferInfopublic int available()
BufferInfoavailable in interface BufferInfoprotected int fillBuffer()
throws IOException
IOExceptionprotected boolean hasBufferedData()
public int read()
throws IOException
SessionInputBufferint in the range 0 to
255. If no byte is available because the end of the stream
has been reached, the value -1 is returned. This method
blocks until input data is available, the end of the stream is detected,
or an exception is thrown.read in interface SessionInputBuffer-1 if the end of the
stream is reached.IOException - if an I/O error occurs.public int read(byte[] b,
int off,
int len)
throws IOException
SessionInputBufferlen bytes of data from the session buffer into
an array of bytes. An attempt is made to read as many as
len bytes, but a smaller number may be read, possibly
zero. The number of bytes actually read is returned as an integer.
This method blocks until input data is available, end of file is detected, or an exception is thrown.
If off is negative, or len is negative, or
off+len is greater than the length of the array
b, then an IndexOutOfBoundsException is
thrown.
read in interface SessionInputBufferb - 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 - if an I/O error occurs.public int read(byte[] b)
throws IOException
SessionInputBufferb. The number of bytes actually read is
returned as an integer. This method blocks until input data is
available, end of file is detected, or an exception is thrown.read in interface SessionInputBufferb - the buffer into which the data is read.-1 is there is no more data because the end of
the stream has been reached.IOException - if an I/O error occurs.public int readLine(CharArrayBuffer charbuffer) throws IOException
-1 is returned. This method blocks until input
data is available, end of file is detected, or an exception is thrown.
This method treats a lone LF as a valid line delimiters in addition to CR-LF required by the HTTP specification.
readLine in interface SessionInputBuffercharbuffer - the line buffer.IOException - if an I/O error occurs.public String readLine() throws IOException
SessionInputBuffernull is returned. This method blocks until input data is
available, end of file is detected, or an exception is thrown.
The choice of a char encoding and line delimiter sequence is up to the specific implementations of this interface.
readLine in interface SessionInputBufferIOException - if an I/O error occurs.public HttpTransportMetrics getMetrics()
SessionInputBufferHttpTransportMetrics for this session buffer.getMetrics in interface SessionInputBufferCopyright © 2005–2013 The Apache Software Foundation. All rights reserved.