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

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.

See also

Types

Link copied to clipboard

Functions

Link copied to clipboard
fun closeConnection(reason: ApolloException)

Close the connection to the server if it's open.

Link copied to clipboard
@ApolloExperimental
fun NetworkTransport.closeConnection(exception: ApolloException)

Closes the websocket connection if the transport is a WebSocketNetworkTransport.

fun NetworkTransport.closeConnection(reason: Throwable)

Closes the websocket connection if the transport is a WebSocketNetworkTransport.

Link copied to clipboard
open override fun dispose()
Link copied to clipboard
open override fun <D : Operation.Data> execute(request: ApolloRequest<D>): Flow<ApolloResponse<D>>

Executes the given ApolloRequest using WebSockets