/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/M3UASelectionKey.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.protocols.ss7.m3ua;

/**
 * A token representing the registration of a M3UAChannel with a multiplexer.
 * 
 * A selection key is created each time a channel is registered with a selector.
 * A key remains valid until it is cancelled by invoking its cancel method, by
 * closing its channel, or by closing its selector. Cancelling a key does not
 * immediately remove it from its selector.
 * 
 * A selection key is created each time a channel is registered with a selector.
 * A key remains valid until it is cancelled by invoking its cancel method, by
 * closing its channel, or by closing its selector. Cancelling a key does not
 * immediately remove it from its selector
 * 
 * That a selection key's ready set indicates that its channel is ready for some
 * operation category is a hint, but not a guarantee, that an operation in such
 * a category may be performed by a thread without causing the thread to block.
 * A ready set is most likely to be accurate immediately after the completion of
 * a selection operation. It is likely to be made inaccurate by external events
 * and by I/O operations that are invoked upon the corresponding channel.
 * 
 * @author amit bhayani
 * @author kulikov
 */
public interface M3UASelectionKey {
    /**
     * Returns the channel for which this key was created. This method will
     * continue to return the channel even after the key is cancelled.
     * 
     * @return This key's channel.
     */
    public M3UASelectableChannel channel();

    /**
     * Tests whether this key's channel is ready to accept a new connection.
     * 
     * @return true if, and only if channel ready to accept new connection
     */
    public boolean isAcceptable();

    /**
     * Tests whether this key's channel is ready for reading.
     * 
     * @return true if, and only if channel ready for reading
     */
    public boolean isReadable();

    /**
     * Tests whether this key's channel is ready for writting.
     * 
     * @return true if, and only if channel ready for writting
     */
    public boolean isWritable();

    /**
     * Requests that the registration of this key's channel with its selector be
     * cancelled.
     */
    public void cancel();

    /**
     * Attaches the given object to this key.
     * 
     * <p>
     * An attached object may later be retrieved via the {@link #attachment
     * attachment} method. Only one object may be attached at a time; invoking
     * this method causes any previous attachment to be discarded. The current
     * attachment may be discarded by attaching <tt>null</tt>.
     * </p>
     * 
     * @param ob
     *            The object to be attached; may be <tt>null</tt>
     * 
     * @return The previously-attached object, if any, otherwise <tt>null</tt>
     */
    public Object attach(Object ob);

    /**
     * Retrieves the current attachment.
     * </p>
     * 
     * @return The object currently attached to this key, or <tt>null</tt> if
     *         there is no attachment
     */
    public Object attachment();
    
    /**
     * Tells whether or not this key is valid.
     *
     * <p> A key is valid upon creation and remains so until it is cancelled,
     * its channel is closed, or its selector is closed.  </p>
     *
     * @return  <tt>true</tt> if, and only if, this key is valid
     */
    public abstract boolean isValid();

}