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

Factory

class Factory : WsProtocol.Factory

A factory for GraphQLWsProtocol.

Constructors

fun Factory( connectionPayload: suspend () -> Map<String, Any?>? = { null }, pingIntervalMillis: Long = -1, pingPayload: Map<String, Any?>? = null, pongPayload: Map<String, Any?>? = null, connectionAcknowledgeTimeoutMs: Long, frameType: WsFrameType = WsFrameType.Text)

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_2_3)

~~fun~~ ~~Factory~~( connectionPayload: Map<String, Any?>?, pingIntervalMillis: Long = -1, pingPayload: Map<String, Any?>? = null, pongPayload: Map<String, Any?>? = null, connectionAcknowledgeTimeoutMs: Long, frameType: WsFrameType = WsFrameType.Text)

Functions

connectionAcknowledgeTimeoutMillis

@ApolloExperimental

fun connectionAcknowledgeTimeoutMillis(connectionAcknowledgeTimeoutMillis: Long)

connectionPayload

@ApolloExperimental

fun connectionPayload(connectionPayload: suspend () -> Map<String, Any?>)

open override fun create( webSocketConnection: WebSocketConnection, listener: WsProtocol.Listener, scope: CoroutineScope): WsProtocol

Create a WsProtocol

@ApolloExperimental

fun frameType(frameType: WsFrameType)

pingIntervalMillis

@ApolloExperimental

fun pingIntervalMillis(pingIntervalMillis: Long)

@ApolloExperimental

fun pingPayload(pingPayload: Map<String, Any?>?)

@ApolloExperimental

fun pongPayload(pongPayload: Map<String, Any?>?)

webSocketPayloadComposer

@ApolloExperimental

fun webSocketPayloadComposer(webSocketPayloadComposer: WebSocketPayloadComposer)

Properties

open override val name: String

The name of the protocol as in the Sec-WebSocket-Protocol header