Package com.apollographql.apollo3.network.ws

Types

AppSyncWsProtocol

common

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

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

DefaultWebSocketEngine

common

class DefaultWebSocketEngine : WebSocketEngine

GraphQLWsProtocol

common

class GraphQLWsProtocol(connectionPayload: Map<String, Any?>?, pingPayload: Map<String, Any?>?, pongPayload: Map<String, Any?>?, connectionAcknowledgeTimeoutMs: Long, pingIntervalMillis: Long, frameType: WsFrameType, webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, scope: CoroutineScope) : WsProtocol

An WsProtocol that uses https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.

NSWebSocketFactory

apple

typealias NSWebSocketFactory = (NSURLRequest, WebSocketConnectionListener) -> NSURLSessionWebSocketTask

SubscriptionWsProtocol

common

class SubscriptionWsProtocol(webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, connectionAcknowledgeTimeoutMs: Long, connectionPayload: suspend () -> Map<String, Any?>?) : WsProtocol

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

SubscriptionWsProtocolAdapter

common

open class SubscriptionWsProtocolAdapter(webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener) : WsProtocol

WebSocketConnection

common

interface WebSocketConnection

WebSocketConnectionListener

apple

interface WebSocketConnectionListener

WebSocketEngine

common

interface WebSocketEngine

The low-level WebSocket API.

WebSocketNetworkTransport

common

class WebSocketNetworkTransport : NetworkTransport

A NetworkTransport that works with WebSockets.

WsFrameType

common

enum WsFrameType : Enum<WsFrameType>

WsProtocol

common

abstract class WsProtocol(webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener)

A WsProtocol is responsible for handling the details of the WebSocket protocol.

Properties

CLOSE_GOING_AWAY

common

const val CLOSE_GOING_AWAY: Int = 1001

CLOSE_NORMAL

common

const val CLOSE_NORMAL: Int = 1000