com.pdd.pop.ext.glassfish.grizzly.nio.SelectionKeyHandler Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.pdd.pop.ext.glassfish.grizzly.nio;

import com.pdd.pop.ext.glassfish.grizzly.IOEvent;
import java.io.IOException;
import java.nio.channels.SelectionKey;

/**
 * {@link SelectionKeyHandler} implementations are responsible for handling
 * {@link SelectionKey} life cycle events.
 * 
 * @author Alexey Stashok
 */
public interface SelectionKeyHandler {

    /**
     * 
     * The default {@link SelectionKeyHandler} used by all created builder instances.
     * 
     *
     * 
     * The default may be changed by setting the system property com.pdd.pop.ext.glassfish.grizzly.DEFAULT_SELECTION_KEY_HANDLER
     * with the fully qualified name of the class that implements the SelectionKeyHandler interface.  Note that this class must
     * be public and have a public no-arg constructor.
     * 
     */
    SelectionKeyHandler DEFAULT_SELECTION_KEY_HANDLER =
            SelectionKeyHandlerInitializer.initHandler();

    void onKeyRegistered(SelectionKey key);
    
    void onKeyDeregistered(SelectionKey key);

    boolean onProcessInterest(SelectionKey key, int interest) throws IOException;

    void cancel(SelectionKey key) throws IOException;
    
    NIOConnection getConnectionForKey(SelectionKey selectionKey);

    void setConnectionForKey(NIOConnection connection,
            SelectionKey selectionKey);

    int ioEvent2SelectionKeyInterest(IOEvent ioEvent);
    
    IOEvent selectionKeyInterest2IoEvent(int selectionKeyInterest);

    IOEvent[] getIOEvents(int interest);
}