com.sportradar.unifiedodds.sdk.SDKProducerStatusListener Maven / Gradle / Ivy

/*
 * Copyright (C) Sportradar AG. See LICENSE for full license governing this code
 */

package com.sportradar.unifiedodds.sdk;

import com.sportradar.unifiedodds.sdk.oddsentities.ProducerDown;
import com.sportradar.unifiedodds.sdk.oddsentities.ProducerStatus;
import com.sportradar.unifiedodds.sdk.oddsentities.ProducerUp;


/**
 * Defines a contract used to observe instances which provide information about a producer ({@link ProducerUp}
 * and {@link ProducerDown} messages)
 */
public interface SDKProducerStatusListener {

    /**
     * Invoked when a producer serving messages via the feed is down
     * (the SDK detected an invalid producer state)
     * 
     * @param producerDown A {@link ProducerDown} instance
     *        specifying the associated producer and reason
     *
     * @deprecated from v2.0.8 in favour of {@link #onProducerStatusChange(ProducerStatus)}
     */
    @Deprecated
    void onProducerDown(ProducerDown producerDown);

    /**
     * Invoked when a producer gets reawaken and the SDK gets up in sync with it
     *
     * @param producerUp the object containing information about the producer status update
     *
     * @deprecated from v2.0.8 in favour of {@link #onProducerStatusChange(ProducerStatus)}
     */
    @Deprecated
    void onProducerUp(ProducerUp producerUp);

    /**
     * Invoked when the producer status changes, some examples:
     * 
     *     Producer up to producer down
     *     Producer down(processing queue delay) to producer down(alive interval violation)
     *     Producer down to producer up
     *     ...
     * 
     *
     * @param producerStatus the new {@link ProducerStatus}
     * @since v2.0.8
     */
    default void onProducerStatusChange(ProducerStatus producerStatus) {
        // roll out default behaviour - its advised to update the code to use this method instead of the onProducerDown/onProducerUp
    }
}