org.jppf.comm.socket.SocketInitializer 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.comm.socket;

/**
 * Common interface for objects that establish a connection with a remote socket.
 * @author Laurent Cohen
 */
public interface SocketInitializer
{
  /**
   * Initialize the underlying socket client, by starting a Timer and a corresponding
   * TimerTask until a specified amount of time has passed.
   * @param socketWrapper the socket wrapper to initialize.
   */
  void initializeSocket(SocketWrapper socketWrapper);

  /**
   * Close this initializer.
   */
  void close();

  /**
   * Determine whether any connection attempt succeeded.
   * @return true if any attempt was successful, false otherwise.
   */
  boolean isSuccessful();

  /**
   * Determine whether this socket initializer has been intentionally closed.
   * @return true if this socket initializer has been intentionally closed, false otherwise.
   */
  boolean isClosed();
}