jellyfin-api/org.jellyfin.sdk.api.sockets/SocketReconnectPolicy

SocketReconnectPolicy

The SocketReconnectPolicy describes the behavior for reconnecting WebSockets when there are active subscriptions. It will be notified about specific events and asked for a delay when the socket is disconnected but still has active subscriptions.

Inheritors

DelayReconnect

ExponentialDelayReconnect

Types

DelayReconnect

class DelayReconnect(val delay: <Error class: unknown class> = 5.seconds) : SocketReconnectPolicy

Implementation of SocketReconnectPolicy that always uses the same delay.

ExponentialDelayReconnect

class ExponentialDelayReconnect(val minDelay: <Error class: unknown class> = 1.seconds, val maxDelay: <Error class: unknown class> = 5.minutes, val factor: Double = 1.5) : SocketReconnectPolicy

Implementation of SocketReconnectPolicy that grows the delay exponentially, starting with minDelay until the maximum of maxDelay.

Functions

getReconnectDelay

abstract fun getReconnectDelay(): <Error class: unknown class>?

The delay to use before attempting to reconnect or null if no new attempt should be made.

notifyConnected

open fun notifyConnected()

Notify about a successful connection attempt.

notifyDisconnected

open fun notifyDisconnected()

Notify about a disconnect event while there are active subscriptions. This is always called before getReconnectDelay. This function is not called when the WebSocket is disconnected without active subscriptions.

notifyUpdated

open fun notifyUpdated()

Notify about changed credentials. This means a new connection attempt will be made automatically.