apollo-runtime/com.apollographql.apollo.network.websocket

Package-level declarations

Types

AppSyncWsProtocol

@ApolloExperimental

class AppSyncWsProtocol(val authorization: suspend () -> Any? = { null }) : WsProtocol

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

@ApolloExperimental

sealed interface ClientMessage

A WebSocket message sent by the client

CompleteServerMessage

@ApolloExperimental

class CompleteServerMessage(val id: String) : ServerMessage

The subscription completed normally This is a terminal message for the given operation.

ConnectionAckServerMessage

@ApolloExperimental

object ConnectionAckServerMessage : ServerMessage

ConnectionErrorServerMessage

@ApolloExperimental

class ConnectionErrorServerMessage(val payload: ApolloJsonElement) : ServerMessage

ConnectionKeepAliveServerMessage

@ApolloExperimental

object ConnectionKeepAliveServerMessage : ServerMessage

DataClientMessage

@ApolloExperimental

class DataClientMessage(val data: ByteArray) : ClientMessage

A WebSocket data message

GraphQLWsProtocol

@ApolloExperimental

class GraphQLWsProtocol(val connectionPayload: suspend () -> Any? = { null }) : WsProtocol

An WsProtocol for https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md

OperationErrorServerMessage

@ApolloExperimental

class OperationErrorServerMessage(val id: String, val payload: ApolloJsonElement) : ServerMessage

There was an error with the operation that cannot be represented by a GraphQL response. This is a terminal message that terminates the subscription.

ParseErrorServerMessage

@ApolloExperimental

class ParseErrorServerMessage(val errorMessage: String) : ServerMessage

Special Server message that indicates a malformed message

PingServerMessage

@ApolloExperimental

object PingServerMessage : ServerMessage

PongServerMessage

@ApolloExperimental

object PongServerMessage : ServerMessage

ResponseServerMessage

@ApolloExperimental

class ResponseServerMessage(val id: String, val response: ApolloJsonElement) : ServerMessage

A GraphQL response was received

@ApolloExperimental

sealed interface ServerMessage

A WebSocket message sent by the server

SubscriptionParser

@ApolloExperimental

interface SubscriptionParser<D : Operation.Data>

A SubscriptionParser transforms JSON responses contained in WebSocket messages into parsed ApolloResponse

SubscriptionParserFactory

@ApolloExperimental

interface SubscriptionParserFactory

A factory for SubscriptionParser

SubscriptionWsProtocol

@ApolloExperimental

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

class ~~SubscriptionWsProtocol~~(val connectionPayload: suspend () -> Any? = { null }) : WsProtocol

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

TextClientMessage

@ApolloExperimental

class TextClientMessage(val text: String) : ClientMessage

A WebSocket text message

@ApolloExperimental

interface WebSocket

WebSocketEngine

@ApolloExperimental

interface WebSocketEngine : Closeable

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

WebSocketListener

@ApolloExperimental

interface WebSocketListener

WebSocketNetworkTransport

@ApolloExperimental

class WebSocketNetworkTransport : NetworkTransport

A NetworkTransport that uses WebSockets to execute GraphQL operations. Most of the time, it is used for subscriptions but some WsProtocol like GraphQLWsProtocol also allow executing queries and mutations over WebSockets.

@ApolloExperimental

interface WsProtocol

A WsProtocol manages different flavours of WebSocket protocols.

Functions

closeConnection

@ApolloExperimental

fun NetworkTransport.closeConnection()

@ApolloExperimental

fun NetworkTransport.closeConnection(exception: ApolloException)

Closes the websocket connection if the transport is a WebSocketNetworkTransport.

WebSocketEngine

actual fun WebSocketEngine(): WebSocketEngine

@ApolloExperimental

expect fun WebSocketEngine(): WebSocketEngine

actual fun WebSocketEngine(): WebSocketEngine

actual fun WebSocketEngine(): WebSocketEngine

@ApolloExperimental

fun WebSocketEngine(webSocketFactory: <Error class: unknown class>): WebSocketEngine

@ApolloExperimental

fun WebSocketEngine(webSocketFactory: () -> <Error class: unknown class>): WebSocketEngine

Creates a new WebSocketEngine from webSocketFactory

actual fun WebSocketEngine(): WebSocketEngine