io.ktor.http.cio.websocket

Class WebSocketWriter

io.ktor.http.cio.websocket.WebSocketWriter

public class WebSocketWriter

Class that processes written WebSocketWriter.getOutgoing Websocket class Frame, serializes them and writes the bits into the writeChannel.

See Also:

WebSocketWriter.getOutgoing, class Frame

Constructor Summary

Constructors

Constructor and Description
WebSocketWriter(kotlinx.coroutines.io.ByteWriteChannel writeChannel, NonExistentClass coroutineContext, boolean masking, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Class that processes written WebSocketWriter.getOutgoing Websocket class Frame, serializes them and writes the bits into the writeChannel.
WebSocketWriter(kotlinx.coroutines.io.ByteWriteChannel writeChannel, kotlinx.coroutines.Job parent, NonExistentClass coroutineContext, boolean masking, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message queue
java.lang.Object	flush(kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p) Ensures all enqueued messages has been written
NonExistentClass	getCoroutineContext()
boolean	getMasking() Whether it will mask serialized frames.
kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame>	getOutgoing() Channel for sending Websocket's class Frame that will be serialized and written to writeChannel.
kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer>	getPool() ByteBuffer pool to be used by this writer
java.lang.Object	send(Frame frame, kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p) Send a frame and write it and all outstanding frames in the queue
void	setMasking(boolean p) Whether it will mask serialized frames.

Constructor Detail

WebSocketWriter

public WebSocketWriter(kotlinx.coroutines.io.ByteWriteChannel writeChannel,
                       NonExistentClass coroutineContext,
                       boolean masking,
                       kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Class that processes written WebSocketWriter.getOutgoing Websocket class Frame, serializes them and writes the bits into the writeChannel.

Parameters:

masking - Whether it will mask serialized frames.

pool - ByteBuffer pool to be used by this writer

See Also:

WebSocketWriter.getOutgoing, class Frame

WebSocketWriter

public WebSocketWriter(kotlinx.coroutines.io.ByteWriteChannel writeChannel,
                       kotlinx.coroutines.Job parent,
                       NonExistentClass coroutineContext,
                       boolean masking,
                       kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Deprecated.

Method Detail

getOutgoing

public kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame> getOutgoing()

Channel for sending Websocket's class Frame that will be serialized and written to writeChannel.

See Also:

class Frame

send

public java.lang.Object send(Frame frame,
                             kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)

Send a frame and write it and all outstanding frames in the queue

flush

public java.lang.Object flush(kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)

Ensures all enqueued messages has been written

close

public void close()

Closes the message queue

getCoroutineContext

public NonExistentClass getCoroutineContext()

getMasking

public boolean getMasking()

Whether it will mask serialized frames.

setMasking

public void setMasking(boolean p)

Whether it will mask serialized frames.

Parameters:

p - Whether it will mask serialized frames.

getPool

public kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> getPool()

ByteBuffer pool to be used by this writer