apollo-runtime/com.apollographql.apollo.network.ws/AppSyncWsProtocol

AppSyncWsProtocol

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v5_0_0)

class ~~AppSyncWsProtocol~~(connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }, webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener) : WsProtocol

Deprecated

The websocket implementation has moved to 'com.apollographql.apollo.network.websocket'. See https://go.apollo.dev/ak-v5-websockets for more details.

A WsProtocol for https://docs.aws.amazon.com/appsync/latest/devguide/real-time-websocket-client.html

Constructors

AppSyncWsProtocol

constructor(connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }, webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener)

constructor(authorization: Map<String, Any?>, connectionAcknowledgeTimeoutMs: Long, webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener)

Types

object Companion

class Factory(connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }) : WsProtocol.Factory

Functions

open fun close()

Closes the connection gracefully. It is expected that a future call to WsProtocol.Listener.networkError is made

open suspend override fun connectionInit()

Initializes the connection and suspends until the server acknowledges it.

handleServerMessage

open override fun handleServerMessage(messageMap: Map<String, Any?>)

Handles a server message and notifies listener appropriately

open suspend fun run()

Read the WebSocket

open override fun <D : Operation.Data> startOperation(request: ApolloRequest<D>)

Starts the given operation

open override fun <D : Operation.Data> stopOperation(request: ApolloRequest<D>)

Stops the given operation