io.ktor.http.cio.websocket

Class PingPongKt

io.ktor.http.cio.websocket.PingPongKt

public class PingPongKt

Method Summary

Modifier and Type	Method and Description
static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Pong>	pinger(kotlinx.coroutines.CoroutineScope $receiver, kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame> outgoing, long periodMillis, long timeoutMillis, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client's pong frames. It is also handling timeoutMillis and sending timeout close frame
static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Ping>	ponger(WebSocketSession session, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Deprecated.
static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Ping>	ponger(kotlinx.coroutines.CoroutineScope $receiver, kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame.Pong> outgoing, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client's ping frame and replying with corresponding pong

Method Detail

ponger

public static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Ping> ponger(WebSocketSession session,
                                                                                                    kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Deprecated.

Launch a ponger actor job on the coroutineContext for websocket session. It is acting for every client's ping frame and replying with corresponding pong

See Also:

coroutineContext

ponger

public static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Ping> ponger(kotlinx.coroutines.CoroutineScope $receiver,
                                                                                                    kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame.Pong> outgoing,
                                                                                                    kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client's ping frame and replying with corresponding pong

pinger

public static kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame.Pong> pinger(kotlinx.coroutines.CoroutineScope $receiver,
                                                                                                    kotlinx.coroutines.channels.SendChannel<? super io.ktor.http.cio.websocket.Frame> outgoing,
                                                                                                    long periodMillis,
                                                                                                    long timeoutMillis,
                                                                                                    kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client's pong frames. It is also handling timeoutMillis and sending timeout close frame