001/**
002 *
003 * Copyright 2017 Florian Schmaus.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smack;
018
019/**
020 * A listener for the {@link ReconnectionManager}. Use
021 * {@link ReconnectionManager#addReconnectionListener(ReconnectionListener)} to add new listeners to the reconnection
022 * manager.
023 *
024 * @since 4.2.2
025 */
026public interface ReconnectionListener {
027
028    /**
029     * The connection will retry to reconnect in the specified number of seconds.
030     * <p>
031     * Note: This method is only called if {@link ReconnectionManager#isAutomaticReconnectEnabled()} returns true, i.e.
032     * only when the reconnection manager is enabled for the connection.
033     * </p>
034     *
035     * @param seconds remaining seconds before attempting a reconnection.
036     */
037    void reconnectingIn(int seconds);
038
039    /**
040     * An attempt to connect to the server has failed. The connection will keep trying reconnecting to the server in a
041     * moment.
042     * <p>
043     * Note: This method is only called if {@link ReconnectionManager#isAutomaticReconnectEnabled()} returns true, i.e.
044     * only when the reconnection manager is enabled for the connection.
045     * </p>
046     *
047     * @param e the exception that caused the reconnection to fail.
048     */
049    void reconnectionFailed(Exception e);
050}