-
Notifications
You must be signed in to change notification settings - Fork 79
/
ReadListener.java
59 lines (52 loc) · 2.2 KB
/
ReadListener.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
* Copyright (c) 2017, 2023 Oracle and/or its affiliates and others.
* All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.servlet;
import java.io.IOException;
import java.util.EventListener;
/**
* <p>
* This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available
* to be read without blocking.
* </p>
*
* @since Servlet 3.1
*/
public interface ReadListener extends EventListener {
/**
* When an instance of the <code>ReadListener</code> is registered with a {@link ServletInputStream}, 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 the {@link jakarta.servlet.ServletInputStream#isReady()} method has been called and has
* returned a value of <code>false</code>, data has subsequently become available to read and any previous call to this
* method has returned to the container.
*
* @throws IOException if an I/O related error has occurred during processing
*/
void onDataAvailable() throws IOException;
/**
* Invoked when all data for the current request has been read and any previous call to {@link #onDataAvailable()} has
* returned to the container.
*
* @throws IOException if an I/O related error has occurred during processing
*/
void onAllDataRead() throws IOException;
/**
* Invoked when an error occurs processing the request.
*
* @param t the throwable to indicate why the read operation failed
*/
void onError(Throwable t);
}