001/*
002 * JPPF.
003 * Copyright (C) 2005-2015 JPPF Team.
004 * http://www.jppf.org
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.jppf.client.event;
020
021import org.jppf.client.JPPFClientConnectionStatus;
022
023/**
024 * Interface implemented by all classes that desire to handle a connection status
025 * and notify others about status changes.
026 * @author Laurent Cohen
027 */
028public interface ClientConnectionStatusHandler {
029  /**
030   * Get the status of this connection.
031   * @return a <code>JPPFClientConnectionStatus</code> enumerated value.
032   */
033  JPPFClientConnectionStatus getStatus();
034
035  /**
036   * Set the status of this connection.
037   * @param status  a <code>JPPFClientConnectionStatus</code> enumerated value.
038   * @exclude
039   */
040  void setStatus(JPPFClientConnectionStatus status);
041
042  /**
043   * Add a connection status listener to this connection's list of listeners.
044   * @param listener the listener to add to the list.
045   */
046  void addClientConnectionStatusListener(ClientConnectionStatusListener listener);
047
048  /**
049   * Remove a connection status listener from this connection's list of listeners.
050   * @param listener the listener to remove from the list.
051   */
052  void removeClientConnectionStatusListener(ClientConnectionStatusListener listener);
053}