org.glassfish.grizzly.WriteHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grizzly-http-server-core Show documentation

There is a newer version: 4.0.2

Show newest version

/*
 * Copyright (c) 2011, 2020 Oracle and/or its affiliates. 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 org.glassfish.grizzly;

/**
 * Callback notification mechanism that signals the developer it's possible to write content.
 *
 * @since 2.2
 */
public interface WriteHandler {

    /**
     * This callback will be invoked when the requirements as dictated by writer are met.
     *
     * @throws Exception {@link Exception} might be thrown by the custom handler code. This exception will be delegated for
     * processing to {@link #onError(java.lang.Throwable)}.
     */
    void onWritePossible() throws Exception;

    /**
     * Invoked when an error occurs processing the request asynchronously.
     * 
     * @param t cause of error
     */
    void onError(final Throwable t);

}