• Home
• org.jellyfin.sdk
• jellyfin-api-jvm
• 1.6.0-beta.1
• source code
• SocketApi.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.org.jellyfin.sdk.api.sockets.SocketApi.kt Maven / Gradle / Ivy

package org.jellyfin.sdk.api.sockets

import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.StateFlow
import org.jellyfin.sdk.model.api.OutboundWebSocketMessage
import kotlin.reflect.KClass

/**
 * The SocketApi maintains a WebSocket connection to the current server specified in its parent ApiClient. Each
 * ApiClient has one SocketApi instance. Updating the server URL, device info, client info or access token using the
 * update function will automatically propagate and reconnect the WebSocket.
 *
 * The WebSocket automatically disconnects when there are no active subscriptions. Subscriptions will automatically send
 * the appropriate start and stop messages to the server, the start messages will always request an interval of one
 * second. Prefer using individual subscriptions above the [subscribeAll] function for best performance.
 */
public interface SocketApi {
	/**
	 * Flow indicating the current status of the WebSocket connection.
	 */
	public val state: StateFlow

	/**
	 * Subscribe to all incoming WebSocket messages.
	 * @see subscribe
	 */
	public fun subscribeAll(): Flow

	/**
	 * Subscribe to a specific WebSocket message type.
	 * @see subscribeAll
	 */
	public fun  subscribe(messageType: KClass): Flow
}