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

GraphQLWsProtocol

class GraphQLWsProtocol : WsProtocol
Content copied to clipboard

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

Link copied to clipboard
@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_7_2)
fun GraphQLWsProtocol(    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)
Content copied to clipboard
Link copied to clipboard
@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_2_3)
fun GraphQLWsProtocol(    connectionPayload: 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)
Content copied to clipboard

Types

Link copied to clipboard
class Factory : WsProtocol.Factory
Content copied to clipboard

A factory for GraphQLWsProtocol.

Functions

Link copied to clipboard
open fun close()
Content copied to clipboard

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

Link copied to clipboard
open suspend override fun connectionInit()
Content copied to clipboard

Initializes the connection and suspends until the server acknowledges it.

Link copied to clipboard
open override fun handleServerMessage(messageMap: Map<String, Any?>)
Content copied to clipboard

Handles a server message and notifies listener appropriately

Link copied to clipboard
open suspend override fun run()
Content copied to clipboard

Read the WebSocket

Link copied to clipboard
open override fun <D : Operation.Data> startOperation(request: ApolloRequest<D>)
Content copied to clipboard

Starts the given operation

Link copied to clipboard
open override fun <D : Operation.Data> stopOperation(request: ApolloRequest<D>)
Content copied to clipboard

Stops the given operation