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

Show more of this group Show more artifacts with this name
Show all versions of jppf-common-node Show documentation
JPPF, the open source grid computing solution
The newest version!
/*
 * JPPF.
 * Copyright (C) 2005-2014 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;


/**
 * Context associated with an open communication channel.
 * @param  the type of states associated with this context.
 * @author Laurent Cohen
 */
public interface NioContext>
{

  /**
   * Get the current state of the channel this context is associated with.
   * @return a state enum value.
   */
  S getState();

  /**
   * Set the current state of the channel this context is associated with.
   * @param state a state enum value.
   * @return true if the state was effectively changed to the specified value, false if the channel was transitioned to a different state.
   */
  boolean setState(S state);

  /**
   * Read data from a channel.
   * @param wrapper the channel to read the data from.
   * @return true if all the data has been read, false otherwise.
   * @throws Exception if an error occurs while reading the data.
   */
  boolean readMessage(ChannelWrapper wrapper) throws Exception;

  /**
   * Write data to a channel.
   * @param wrapper the channel to write the data to.
   * @return true if all the data has been written, false otherwise.
   * @throws Exception if an error occurs while writing the data.
   */
  boolean writeMessage(ChannelWrapper wrapper) throws Exception;

  /**
   * Get the uuid for this node context.
   * @return the uuid as a string.
   */
  String getUuid();

  /**
   * Set the uuid for this node context.
   * @param uuid the uuid as a string.
   */
  void setUuid(String uuid);

  /**
   * Handle the cleanup when an exception occurs on the channel.
   * @param channel the channel that threw the exception.
   * @param e exception.
   */
  void handleException(ChannelWrapper channel, final Exception e);

  /**
   * Get the associated channel.
   * @return a {@link ChannelWrapper} instance.
   */
  ChannelWrapper getChannel();

  /**
   * Set the associated channel.
   * @param channel a {@link ChannelWrapper} instance.
   */
  void setChannel(ChannelWrapper channel);

  /**
   * Get the SSL engine manager associated with the channel.
   * @return an instance of {@link SSLHandler}.
   */
  SSLHandler getSSLHandler();

  /**
   * Get the SSL engine associated with the channel.
   * @param sslHandler an instance of {@link SSLHandler}.
   */
  void setSSLHandler(SSLHandler sslHandler);

  /**
   * Determines whether the connection was opened on an SSL port.
   * @return true for an SSL connection, false otherwise.
   */
  boolean isSsl();

  /**
   * Specifies whether the connection was opened on an SSL port.
   * @param ssl true for an SSL connection, false otherwise.
   */
  void setSsl(final boolean ssl);

  /**
   * Determine whether the associated channel is connected to a peer server.
   * @return true if the channel is connected to a peer server, false otherwise.
   */
  boolean isPeer();

  /**
   * Specify whether the associated channel is connected to a peer server.
   * @param peer true if the channel is connected to a peer server, false otherwise.
   */
  void setPeer(boolean peer);

  /**
   * Whether this context is enabled.
   * @return {@code true} if this context is enabled, {@code false} otherwise.
   */
  boolean isEnabled();

  /**
   * Enable or disable this context.
   * @param enabled {@code true} to enable this context, {@code false} to disable it.
   */
  void setEnabled(boolean enabled);
}