/*
 *
 * Copyright (c) 2006 The Apache Software Foundation
 *
 * 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.apache.qpid.jms;

public interface ConnectionListener
{
    /**
     * Called when bytes have been transmitted to the server
     * @param count the number of bytes sent in total since the connection was opened
     */
    void bytesSent(long count);

    /**
     * Called when some bytes have been received on a connection
     * @param count the number of bytes received in total since the connection was opened
     */
    void bytesReceived(long count);

    /**
     * Called after the infrastructure has detected that failover is required but before attempting failover.
     * @param redirect true if the broker requested redirect. false if failover is occurring due to a connection error.
     * @return true to continue failing over, false to veto failover and raise a connection exception
     */
    boolean preFailover(boolean redirect);

    /**
     * Called after connection has been made to another broker after failover has been started but before
     * any resubscription has been done.
     * @return true to continue with resubscription, false to prevent automatic resubscription. This is useful in
     * cases where the application wants to handle resubscription. Note that in the latter case all sessions, producers
     * and consumers are invalidated.
     */
    boolean preResubscribe();

    /**
     * Called once failover has completed successfully. This is called irrespective of whether the client has
     * vetoed automatic resubscription.
     */
    void failoverComplete();
}
