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

Package-level declarations

Types

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

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

DefaultWebSocketEngine

actual class DefaultWebSocketEngine : WebSocketEngine

expect class DefaultWebSocketEngine : WebSocketEngine

actual class DefaultWebSocketEngine : WebSocketEngine

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

NSWebSocketFactory

typealias NSWebSocketFactory = (NSURLRequest, WebSocketConnectionListener) -> NSURLSessionWebSocketTask

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

SubscriptionWsProtocolAdapter

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

WebSocketConnection

interface WebSocketConnection

WebSocketConnectionListener

interface WebSocketConnectionListener

WebSocketEngine

interface WebSocketEngine

The low-level WebSocket API. Implement this interface to customize how WebSockets are handled

WebSocketNetworkTransport

class WebSocketNetworkTransport : NetworkTransport

A NetworkTransport that works with WebSockets. Usually it is used with subscriptions but some WsProtocols like GraphQLWsProtocol also support queries and mutations.

WsFrameType

enum WsFrameType : Enum<WsFrameType>

WsProtocol

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

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

Functions

closeConnection

fun NetworkTransport.closeConnection(reason: Throwable)

A shorthand for WebSocketNetworkTransport.closeConnection. If the NetworkTransport is not a WebSocketNetworkTransport, a NotImplementedError is thrown.

Properties

CLOSE_GOING_AWAY

const val CLOSE_GOING_AWAY: Int = 1001

CLOSE_NORMAL

const val CLOSE_NORMAL: Int = 1000