io.ktor.http.cio.websocket

Class RawWebSocket

io.ktor.http.cio.websocket.RawWebSocket

All Implemented Interfaces:

WebSocketSession

public class RawWebSocket
implements WebSocketSession

Represents a RAW web socket session

Nested Class Summary

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

WebSocketSession.DefaultImpls

Constructor Summary

Constructors

Constructor and Description
RawWebSocket(kotlinx.coroutines.io.ByteReadChannel input, kotlinx.coroutines.io.ByteWriteChannel output, long maxFrameSize, boolean masking, NonExistentClass coroutineContext, kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool) Represents a RAW web socket session

Method Summary

Modifier and Type	Method and Description
java.lang.Object	close(java.lang.Throwable cause, kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p) Close session with the specified cause or with no reason if null
java.lang.Object	flush(kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p) Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that WebSocketSession.flush doesn't guarantee that frames were actually delivered.
NonExistentClass	getCoroutineContext()
kotlinx.coroutines.channels.ReceiveChannel<io.ktor.http.cio.websocket.Frame>	getIncoming() Incoming frames channel
boolean	getMasking() Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
long	getMaxFrameSize() Specifies frame size limit. Connection will be closed if violated
kotlinx.coroutines.channels.SendChannel<io.ktor.http.cio.websocket.Frame>	getOutgoing() Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.
void	setMasking(boolean p) Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously
void	setMaxFrameSize(long p) Specifies frame size limit. Connection will be closed if violated
void	terminate() Initiate connection termination immediately. Termination may complete asynchronously.

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

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

Constructor Detail

RawWebSocket

public RawWebSocket(kotlinx.coroutines.io.ByteReadChannel input,
                    kotlinx.coroutines.io.ByteWriteChannel output,
                    long maxFrameSize,
                    boolean masking,
                    NonExistentClass coroutineContext,
                    kotlinx.io.pool.ObjectPool<java.nio.ByteBuffer> pool)

Represents a RAW web socket session

Method Detail

getCoroutineContext

public NonExistentClass getCoroutineContext()

getIncoming

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

Incoming frames channel

getOutgoing

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

Outgoing frames channel. It could have limited capacity so sending too much frames may lead to suspension at corresponding send invocations. It also may suspend if a peer doesn't read frames for some reason.

getMaxFrameSize

public long getMaxFrameSize()

Specifies frame size limit. Connection will be closed if violated

setMaxFrameSize

public void setMaxFrameSize(long p)

Specifies frame size limit. Connection will be closed if violated

getMasking

public boolean getMasking()

Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously

setMasking

public void setMasking(boolean p)

Enable or disable masking output messages by a random xor mask. Please note that changing this flag on the fly could be applied to the messages already sent (enqueued earlier) as the sending pipeline works asynchronously

flush

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

Flush all outstanding messages and suspend until all earlier sent messages will be written. Could be called at any time even after close. May return immediately if the connection is already terminated. However it may also fail with an exception (or cancellation) at any point due to session failure. Please note that WebSocketSession.flush doesn't guarantee that frames were actually delivered.

See Also:

WebSocketSession.flush

terminate

public void terminate()

Initiate connection termination immediately. Termination may complete asynchronously.

close

public java.lang.Object close(java.lang.Throwable cause,
                              kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)

Close session with the specified cause or with no reason if null