/*
 * Copyright (c) 2010, 2017 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;

import java.io.IOException;

The IOEvent life-cycle listener, which will be notified about changes in IOEvent processing statuses. 
Author:
Alexey Stashok/**
 * The {@link IOEvent} life-cycle listener, which will be notified about changes
 * in {@link IOEvent} processing statuses.
 * 
 * @author Alexey Stashok
 */
public interface IOEventLifeCycleListener {
    
IOEvent processing suspended. 
Params:
context – 
Throws:
IOException – /**
     * {@link IOEvent} processing suspended.
     *
     * @param context
     * @throws IOException
     */
    void onContextSuspend(Context context) throws IOException;

    
IOEvent processing resumed. 
Params:
context – 
Throws:
IOException – /**
     * {@link IOEvent} processing resumed.
     *
     * @param context
     * @throws IOException
     */
    void onContextResume(Context context) throws IOException;

    
Processing switched to the manual IOEvent control. Connection.enableIOEvent(IOEvent) or Connection.disableIOEvent(IOEvent) might be explicitly called. 
Params:
context – /**
     * Processing switched to the manual IOEvent control.
     * {@link Connection#enableIOEvent(org.glassfish.grizzly.IOEvent)} or
     * {@link Connection#disableIOEvent(org.glassfish.grizzly.IOEvent)} might be
     * explicitly called.
     * 
     * @param context
     */
    void onContextManualIOEventControl(final Context context) throws IOException;

    
Reregister IOEvent interest. 
Params:
context – 
Throws:
IOException – /**
     * Reregister {@link IOEvent} interest.
     *
     * @param context
     * @throws IOException
     */
    void onReregister(Context context) throws IOException;

    
IOEvent processing completed. 
Params:
context – 
Throws:
IOException – /**
     * {@link IOEvent} processing completed.
     * 
     * @param context 
     * @throws IOException
     */
    void onComplete(Context context, Object data) throws IOException;

    
Detaching IOEvent processing out of this Context. 
Params:
context – 
Throws:
IOException – /**
     * Detaching {@link IOEvent} processing out of this {@link Context}.
     *
     * @param context
     * @throws IOException
     */
    void onLeave(Context context) throws IOException;

    
Terminate IOEvent processing in this thread, but it's going to be continued later. 
Params:
context – 
Throws:
IOException – 
Deprecated:
will never be invoked/**
     * Terminate {@link IOEvent} processing in this thread, but it's going to
     * be continued later.
     *
     * @param context
     * @throws IOException
     * 
     * @deprecated will never be invoked
     */
    void onTerminate(Context context) throws IOException;

    
Re-run IOEvent processing. 
Params:
context – original Context to be rerun
newContext – new context, which will replace original Context
Throws:
IOException – /**
     * Re-run {@link IOEvent} processing.
     *
     * @param context original {@link Context} to be rerun
     * @param newContext new context, which will replace original {@link Context}
     * @throws IOException
     */
    void onRerun(Context context, Context newContext) throws IOException;

    
Error occurred during IOEvent processing. 
Params:
context – /**
     * Error occurred during {@link IOEvent} processing.
     *
     * @param context
     */
    void onError(Context context, Object description) throws IOException;

    
IOEvent wasn't processed. 
Params:
context – /**
     * {@link IOEvent} wasn't processed.
     *
     * @param context
     */
    void onNotRun(Context context) throws IOException;

    
Empty IOEventLifeCycleListener implementation. /**
     * Empty {@link IOEventLifeCycleListener} implementation.
     */
    class Adapter implements IOEventLifeCycleListener {

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContextSuspend(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContextResume(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onComplete(Context context, Object data) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onTerminate(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onError(Context context, Object description) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onNotRun(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContextManualIOEventControl(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onReregister(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onLeave(Context context) throws IOException {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onRerun(Context context, Context newContext) throws IOException {
        }
    }
}