io.ktor.http.cio.websocket

Class WebSocketReader

io.ktor.http.cio.websocket.WebSocketReader

public class WebSocketReader

Class that continuously reads a byteChannel and converts into Websocket class Frame exposing them in WebSocketReader.getIncoming.

See Also:

class Frame, WebSocketReader.getIncoming

Constructor Summary

Constructors

Constructor and Description
WebSocketReader(kotlinx.coroutines.io.ByteReadChannel byteChannel, NonExistentClass coroutineContext, long maxFrameSize, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Class that continuously reads a byteChannel and converts into Websocket class Frame exposing them in WebSocketReader.getIncoming.
WebSocketReader(kotlinx.coroutines.io.ByteReadChannel byteChannel, long maxFrameSize, kotlinx.coroutines.Job parent, NonExistentClass coroutineContext, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Deprecated.

Method Summary

Modifier and Type	Method and Description
NonExistentClass	getCoroutineContext()
kotlinx.coroutines.channels.ReceiveChannel<io.ktor.http.cio.websocket.Frame>	getIncoming() Channel receiving Websocket's class Frame objects read from byteChannel.
long	getMaxFrameSize() maximum frame size that could be read
void	setMaxFrameSize(long p) maximum frame size that could be read

Constructor Detail

WebSocketReader

public WebSocketReader(kotlinx.coroutines.io.ByteReadChannel byteChannel,
                       NonExistentClass coroutineContext,
                       long maxFrameSize,
                       kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Class that continuously reads a byteChannel and converts into Websocket class Frame exposing them in WebSocketReader.getIncoming.

Parameters:

maxFrameSize - maximum frame size that could be read

maxFrameSize - maximum frame size that could be read

See Also:

class Frame, WebSocketReader.getIncoming

WebSocketReader

public WebSocketReader(kotlinx.coroutines.io.ByteReadChannel byteChannel,
                       long maxFrameSize,
                       kotlinx.coroutines.Job parent,
                       NonExistentClass coroutineContext,
                       kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Deprecated.

Method Detail

getIncoming

public kotlinx.coroutines.channels.ReceiveChannel<io.ktor.http.cio.websocket.Frame> getIncoming()

Channel receiving Websocket's class Frame objects read from byteChannel.

See Also:

class Frame

getCoroutineContext

public NonExistentClass getCoroutineContext()

getMaxFrameSize

public long getMaxFrameSize()

maximum frame size that could be read

setMaxFrameSize

public void setMaxFrameSize(long p)

maximum frame size that could be read

Parameters:

p - maximum frame size that could be read