commonMain.com.pubnub.api.enums.PNReconnectionPolicy.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pubnub-kotlin-api-jvm Show documentation

PubNub is a cross-platform client-to-client (1:1 and 1:many) push service in the cloud, capable of broadcasting real-time messages to millions of web and mobile clients simultaneously, in less than a quarter second!

The newest version!

package com.pubnub.api.enums

@Deprecated(message = "Use [com.pubnub.api.retry.RetryConfiguration] instead.")
enum class PNReconnectionPolicy {
    /**
     * No reconnection policy. If the subscribe loop gets cancelled due to network or other issues,
     * the SDK will not attempt to try to restore it.
     */
    NONE,

    /**
     * The SDK will try to reconnect to the network by doing so every 3 seconds.
     *
     * @see [PNConfiguration.maximumReconnectionRetries]
     */
    LINEAR,

    /**
     * The SDK will try to reconnect to the network by doing so in non-fixed intervals.
     * ie. the interval between retries is another power of 2, starting from 0 to 5.
     *
     * @see [PNConfiguration.maximumReconnectionRetries]
     */
    EXPONENTIAL,
}