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

SubscriptionWsProtocol

class SubscriptionWsProtocol @JvmOverloads constructor(webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }, frameType: WsFrameType = WsFrameType.Text) : WsProtocol

A WsProtocol for https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md

Note: This protocol is no longer actively maintained, and GraphQLWsProtocol should be favored instead.

Constructors

Link copied to clipboard
@JvmOverloads
constructor(webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }, frameType: WsFrameType = WsFrameType.Text)

Types

Link copied to clipboard
class Factory @JvmOverloads constructor(connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>? = { null }, frameType: WsFrameType = WsFrameType.Text) : WsProtocol.Factory

A factory for SubscriptionWsProtocol.

Functions

Link copied to clipboard
open fun close()

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()

Initializes the connection and suspends until the server acknowledges it.

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

Handles a server message and notifies listener appropriately

Link copied to clipboard
open suspend fun run()

Read the WebSocket

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

Starts the given operation

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

Stops the given operation