Package jakarta.servlet
Interface ReadListener
-
- All Superinterfaces:
EventListener
public interface ReadListener extends EventListener
This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available to be read without blocking.
- Since:
- Servlet 3.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
onAllDataRead()
Invoked when all data for the current request has been read.void
onDataAvailable()
When an instance of theReadListener
is registered with aServletInputStream
, this method will be invoked by the container the first time when it is possible to read data.void
onError(Throwable t)
Invoked when an error occurs processing the request.
-
-
-
Method Detail
-
onDataAvailable
void onDataAvailable() throws IOException
When an instance of theReadListener
is registered with aServletInputStream
, this method will be invoked by the container the first time when it is possible to read data. Subsequently the container will invoke this method if and only if theServletInputStream.isReady()
method has been called and has returned a value offalse
and data has subsequently become available to read.- Throws:
IOException
- if an I/O related error has occurred during processing
-
onAllDataRead
void onAllDataRead() throws IOException
Invoked when all data for the current request has been read.- Throws:
IOException
- if an I/O related error has occurred during processing
-
onError
void onError(Throwable t)
Invoked when an error occurs processing the request.- Parameters:
t
- the throwable to indicate why the read operation failed
-
-