javax.servlet
Class ServletInputStream
InputStream
javax.servlet.ServletInputStream
public abstract class ServletInputStream
extends InputStream
This class serves as a stream where servlets can read data supplied by
the client from.
int | readLine(byte[] buffer, int offset, int length) - This method read bytes from a stream and stores them into a caller
supplied buffer.
|
ServletInputStream
protected ServletInputStream()
Does nothing.
readLine
public int readLine(byte[] buffer,
int offset,
int length)
throws IOException
This method read bytes from a stream and stores them into a caller
supplied buffer. It starts storing the data at index
offset
into the buffer and attempts to read until a
end of line ('\n') is encountered or length
bytes are
read.
This method can return before reading the number of bytes requested.
The actual number of bytes read is returned as an int.
A -1 is returned to indicate the end of the stream.
This method will block until some data can be read.
This method operates by calling the single byte read()
method in a loop until the desired number of bytes are read.
The read loop stops short if the end of the stream is encountered
or if an IOException is encountered on any read operation except
the first. If the first attempt to read a bytes fails, the
IOException is allowed to propagate upward. And subsequent
IOException is caught and treated identically to an end of stream
condition. Subclasses can (and should if possible)
override this method to provide a more efficient implementation.
buffer
- The array into which the bytes read should be storedoffset
- The offset into the array to start storing byteslength
- The maximum number of bytes to read
- The actual number of bytes read, or -1 if end of stream.