DataTransportListener.java

/*******************************************************************************
 * Copyright (c) 2011, 2016 Eurotech and/or its affiliates
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Eurotech
 *******************************************************************************/
package org.eclipse.kura.data;

/**
 * Listener interface to be implemented by applications that needs to be notified of events in the
 * {@link DataTransportService}.
 * All registered listeners are called synchronously by the {@link DataTransportService} at the occurrence of the event.
 * It expected that implementers of this interface do NOT perform long running tasks in the implementation of this
 * interface.
 *
 * @deprecated As of {@link org.eclipse.kura.data} 1.1.0, use
 *             {@link DataTransportService#addDataTransportListener(org.eclipse.kura.data.transport.listener.DataTransportListener)}
 *             to register a listener to a DataTransportService.
 */
@Deprecated
public interface DataTransportListener {

    /**
     * Notifies the listener of the establishment of the new connection with the remote server.
     *
     * @param newSession
     *            true if the connection is to the same broker with the same client ID.
     */
    public void onConnectionEstablished(boolean newSession);

    /**
     * Notifies the listener that the connection to the remote server is about to be terminated.
     */
    public void onDisconnecting();

    /**
     * Notifies the listener that the connection to the remote server has been terminated.
     */
    public void onDisconnected();

    /**
     * Notifies the {@link DataTransportService} has received a configuration update.
     */
    public void onConfigurationUpdating(boolean wasConnected);

    /**
     * Notifies the {@link DataTransportService} has received a configuration update and it has applied the new
     * configuration
     */
    public void onConfigurationUpdated(boolean wasConnected);

    /**
     * Notifies the listener that the connection to the remote server has been lost.
     */
    public void onConnectionLost(Throwable cause);

    /**
     * Notifies the listener that a new message has been received from the remote server.
     */
    public void onMessageArrived(String topic, byte[] payload, int qos, boolean retained);

    /**
     * Notifies the listener that a message has been confirmed by the remote server.
     */
    public void onMessageConfirmed(DataTransportToken token);
}