io.ktor.http.cio.websocket

Interface DefaultWebSocketSession

All Superinterfaces:

WebSocketSession

All Known Implementing Classes:

DefaultWebSocketSessionImpl

public DefaultWebSocketSession
extends WebSocketSession

Default websocket session with ping-pong and timeout processing and built-in DefaultWebSocketSession.getCloseReason population

See Also:

DefaultWebSocketSession.getCloseReason

Nested Class Summary

Nested classes/interfaces inherited from interface io.ktor.http.cio.websocket.WebSocketSession

WebSocketSession.DefaultImpls

Method Summary

Modifier and Type	Method and Description
kotlinx.coroutines.Deferred<io.ktor.http.cio.websocket.CloseReason>	getCloseReason() A close reason for this session. It could be null if a session is terminated with no close reason (for example due to connection failure).
long	getPingIntervalMillis() Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
long	getTimeoutMillis() A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).
void	setPingIntervalMillis(long p) Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.
void	setTimeoutMillis(long p) A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).

Methods inherited from interface io.ktor.http.cio.websocket.WebSocketSession

close, flush, getDispatcher, getIncoming, getMasking, getMaxFrameSize, getOutgoing, send, setMasking, setMaxFrameSize, terminate

Method Detail

getPingIntervalMillis

long getPingIntervalMillis()

Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.

setPingIntervalMillis

void setPingIntervalMillis(long p)

Ping interval or -1L to disable pinger. Please note that pongs will be handled despite of this setting.

getTimeoutMillis

long getTimeoutMillis()

A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).

See Also:

DefaultWebSocketSession.getPingIntervalMillis

setTimeoutMillis

void setTimeoutMillis(long p)

A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn't have any effect if DefaultWebSocketSession.getPingIntervalMillis is -1 (pinger is disabled).

See Also:

DefaultWebSocketSession.getPingIntervalMillis

getCloseReason

kotlinx.coroutines.Deferred<io.ktor.http.cio.websocket.CloseReason> getCloseReason()

A close reason for this session. It could be null if a session is terminated with no close reason (for example due to connection failure).