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

Builder

@ApolloExperimental

Constructors

constructor()

Functions

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_0)

fun ~~addHeader~~(name: String, value: String): WebSocketNetworkTransport.Builder

Add a HttpHeader to the handshake query.

fun addHttpHeader(name: String, value: String): WebSocketNetworkTransport.Builder

Add a HttpHeader to the handshake query.

fun build(): WebSocketNetworkTransport

Builds the WebSocketNetworkTransport

connectionAcknowledgeTimeoutMillis

fun connectionAcknowledgeTimeoutMillis(connectionAcknowledgeTimeoutMillis: Long?): WebSocketNetworkTransport.Builder

The maximum number of milliseconds between a "connection_init" message and its acknowledgement

fun httpHeaders(headers: List<HttpHeader>): WebSocketNetworkTransport.Builder

Headers to add to the HTTP handshake query.

idleTimeoutMillis

fun idleTimeoutMillis(idleTimeoutMillis: Long?): WebSocketNetworkTransport.Builder

The number of milliseconds before a WebSocket with no active operations disconnects.

@ApolloExperimental

fun parserFactory(parserFactory: SubscriptionParserFactory?): WebSocketNetworkTransport.Builder

pingIntervalMillis

fun pingIntervalMillis(pingIntervalMillis: Long?): WebSocketNetworkTransport.Builder

The interval in milliseconds between two client pings or -1 to disable client pings. The WsProtocol used must also support client pings.

fun serverUrl(serverUrl: String?): WebSocketNetworkTransport.Builder

webSocketEngine

fun webSocketEngine(webSocketEngine: WebSocketEngine?): WebSocketNetworkTransport.Builder

Set the WebSocketEngine to use.

fun wsProtocol(wsProtocol: WsProtocol?): WebSocketNetworkTransport.Builder

The WsProtocol to use for this WebSocketNetworkTransport