org.jppf.nio.ChannelWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jppf-common Show documentation
JPPF, the open source grid computing solution
There is a newer version: 6.3-alpha
/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jppf.nio;

/**
 * Interface for a set of abstractions wrapping different communication channels into a common semantic.
 * @param 
 * @author Laurent Cohen
 */
public interface ChannelWrapper
{
  /**
   * Get the channel to wrap.
   * @return the wrapped channel.
   */
  S getChannel();

  /**
   * Close the channel.
   * @throws Exception if any error occurs while closing the channel.
   */
  void close() throws Exception;

  /**
   * Get the {@link NioContext} attached to the channel.
   * @return a {@link NioContext} instance.
   */
  NioContext getContext();

  /**
   * Determine whether the channel is opened.
   * @return true if the channel is opened, false otherwise.
   */
  boolean isOpen();

  /**
   * Get the operations enabled for this channel.
   * @return the operations as an int value.
   */
  int getInterestOps();

  /**
   * Get the operations enabled for this channel.
   * @param keyOps the operations as an int value.
   */
  void setInterestOps(int keyOps);

  /**
   * Get the operations available for this channel.
   * @return the operations as an int value.
   */
  int getReadyOps();

  /**
   * Determine whether the channel can be read from.
   * @return true if the channel can be read, false otherwise.
   */
  boolean isReadable();

  /**
   * Determine whether the channel can be written to.
   * @return true if the channel can be written to, false otherwise.
   */
  boolean isWritable();

  /**
   * Determine whether the channel can accept connections.
   * @return true if the channel can accept connections, false otherwise.
   */
  boolean isAcceptable();

  /**
   * Determine whether the channel can be connected.
   * @return true if the channel can be connected, false otherwise.
   */
  boolean isConnectable();

  /**
   * Get the selector associated with this channel.
   * @return a {@link ChannelSelector} instance.
   */
  ChannelSelector getSelector();

  /**
   * Set the selector associated with this channel.
   * @param selector a {@link ChannelSelector} instance.
   */
  void setSelector(ChannelSelector selector);

  /**
   * Determine whether this channel is local (for an in-JVM node).
   * @return false if the channel is local, false otherwise.
   */
  boolean isLocal();

  /**
   * Get this channel's id.
   * @return  the id as a long value.
   */
  long getId();
}