Package: WriteHandler

WriteHandler

Coverage

1: /*
2: * Copyright (c) 2011, 2020 Oracle and/or its affiliates. All rights reserved.
3: *
4: * This program and the accompanying materials are made available under the
5: * terms of the Eclipse Public License v. 2.0, which is available at
6: * http://www.eclipse.org/legal/epl-2.0.
7: *
8: * This Source Code may also be made available under the following Secondary
9: * Licenses when the conditions for such availability set forth in the
10: * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
11: * version 2 with the GNU Classpath Exception, which is available at
12: * https://www.gnu.org/software/classpath/license.html.
13: *
14: * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15: */
16:
17: package org.glassfish.grizzly;
18:
19: /**
20: * Callback notification mechanism that signals the developer it's possible to write content.
21: *
22: * @since 2.2
23: */
24: public interface WriteHandler {
25:
26: /**
27: * This callback will be invoked when the requirements as dictated by writer are met.
28: *
29: * @throws Exception {@link Exception} might be thrown by the custom handler code. This exception will be delegated for
30: * processing to {@link #onError(java.lang.Throwable)}.
31: */
32: void onWritePossible() throws Exception;
33:
34: /**
35: * Invoked when an error occurs processing the request asynchronously.
36: *
37: * @param t cause of error
38: */
39: void onError(final Throwable t);
40:
41: }