org.jppf.client.ClientConnectionHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jppf-client 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.client;

import org.jppf.client.event.ClientConnectionStatusHandler;
import org.jppf.comm.socket.SocketWrapper;

/**
 * Interface for wrappers around a socket connection to the server on the client side.
 * @author Laurent Cohen
 * @author Jeff Rosen
 */
interface ClientConnectionHandler extends ClientConnectionStatusHandler, AutoCloseable
{
  /**
   * Initialize the connection.
   * @throws Exception if an error is raised while initializing the connection.
   */
  void init() throws Exception;

  /**
   * Initialize the underlying socket connection of this connection handler.
   * @throws Exception if an error is raised during initialization.
   */
  void initSocketClient() throws Exception;

  /**
   * Get the socket client uses to communicate over a socket connection.
   * @return a SocketWrapper instance.
   * @throws Exception if the connection has failed or timed out.
   */
  SocketWrapper getSocketClient() throws Exception;

  /**
   * Close and cleanup this connection handler.
   */
  void close();

  /**
   * Determine whether this connection handler is closed.
   * @return true if this connection handler is closed, false otherwise.
   */
  boolean isClosed();
}