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

GraphQLWsProtocol

class GraphQLWsProtocol : WsProtocol

An WsProtocol that uses https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md It can carry queries in addition to subscriptions over the websocket

Constructors

GraphQLWsProtocol

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_7_2)

constructor(connectionPayload: suspend () -> Map<String, Any?>? = { null }, pingPayload: Map<String, Any?>? = null, pongPayload: Map<String, Any?>? = null, connectionAcknowledgeTimeoutMs: Long, pingIntervalMillis: Long, frameType: WsFrameType, webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, scope: CoroutineScope)

Types

class Factory : WsProtocol.Factory

A factory for GraphQLWsProtocol.

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 override 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