public interface SessionInputBuffer
This interface facilitates intermediate buffering of input data streamed from an input stream and provides methods for reading lines of text.
Modifier and Type | Method and Description |
---|---|
int |
available()
Returns available space in the buffer.
|
int |
capacity()
Returns total capacity of the buffer
|
HttpTransportMetrics |
getMetrics()
Returns
HttpTransportMetrics for this session buffer. |
int |
length()
Returns length data stored in the buffer
|
int |
read(byte[] b,
InputStream inputStream)
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,
InputStream inputStream)
Reads up to
len bytes of data from the session buffer into
an array of bytes. |
int |
read(InputStream inputStream)
Reads the next byte of data from this session buffer.
|
int |
readLine(CharArrayBuffer buffer,
InputStream inputStream)
Reads a complete line of characters up to a line delimiter from this
session buffer into the given line buffer.
|
int length()
int capacity()
int available()
int read(byte[] b, int off, int len, InputStream inputStream) throws IOException
len
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.
If len
is zero, then no bytes are read and 0 is returned.
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.inputStream
- Input stream-1
if there is no more data because the end of
the stream has been reached.IOException
- if an I/O error occurs.int read(byte[] b, InputStream inputStream) throws IOException
b
. 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.b
- the buffer into which the data is read.inputStream
- Input stream-1
is there is no more data because the end of
the stream has been reached.IOException
- if an I/O error occurs.int read(InputStream inputStream) throws IOException
int
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.inputStream
- Input stream-1
if the end of the
stream is reached.IOException
- if an I/O error occurs.int readLine(CharArrayBuffer buffer, InputStream inputStream) throws IOException
-1
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.
buffer
- the line buffer, one line of characters upon returninputStream
- Input stream-1
is there is no more data because the end of
the stream has been reached.IOException
- if an I/O error occurs.HttpTransportMetrics getMetrics()
HttpTransportMetrics
for this session buffer.Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.