apollo-runtime/com.apollographql.apollo3.network.ws/WebSocketEngine

WebSocketEngine

interface WebSocketEngine
Content copied to clipboard

The low-level WebSocket API. Implement this interface to customize how WebSockets are handled

Functions

Link copied to clipboard
abstract suspend fun open(url: String, headers: List<HttpHeader> = emptyList()): WebSocketConnection
Content copied to clipboard
@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_2_2)
abstract suspend fun open(url: String, headers: Map<String, String> = emptyMap()): WebSocketConnection
Content copied to clipboard

Open the websocket. Suspends until the handshake is done

Inheritors

Link copied to clipboard