Package-level declarations

Types

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

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

Link copied to clipboard

A WebSocket message sent by the client

Link copied to clipboard

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

Link copied to clipboard

A WebSocket data message

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

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

Link copied to clipboard

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

Link copied to clipboard

Special Server message that indicates a malformed message

Link copied to clipboard

A GraphQL response was received

Link copied to clipboard

A WebSocket message sent by the server

Link copied to clipboard

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

Link copied to clipboard
class SubscriptionWsProtocol(val connectionPayload: suspend () -> Any? = { null }) : WsProtocol

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

Link copied to clipboard

A WebSocket text message

Link copied to clipboard
Link copied to clipboard
interface WebSocketEngine : Closeable

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

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

A WsProtocol manages different flavours of WebSocket protocols.

Functions

Link copied to clipboard
Link copied to clipboard
fun WebSocketEngine(webSocketFactory: <Error class: unknown class>): <Error class: unknown class>