class RawWebSocket : WebSocketSession
Represents a RAW web socket session
RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long = Int.MAX_VALUE.toLong(), masking: Boolean = false, coroutineContext: <ERROR CLASS>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
Represents a RAW web socket session |
val coroutineContext: <ERROR CLASS> |
|
val extensions: List<WebSocketExtension<*>>
Negotiated WebSocket extensions. |
|
val incoming: ReceiveChannel<Frame>
Incoming frames channel |
|
var masking: Boolean
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 |
|
var maxFrameSize: Long
Specifies frame size limit. Connection will be closed if violated |
|
val outgoing: SendChannel<Frame>
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. |
suspend fun flush(): Unit
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 flush doesn't guarantee that frames were actually delivered. |
|
fun
Initiate connection termination immediately. Termination may complete asynchronously. |
abstract suspend fun send(frame: Frame): Unit
Enqueue frame, may suspend if outgoing queue is full. May throw an exception if outgoing channel is already closed so it is impossible to transfer any message. Frames that were sent after close frame could be silently ignored. Please note that close frame could be sent automatically in reply to a peer close frame unless it is raw websocket session. |
suspend fun WebSocketSession.close(reason: CloseReason = CloseReason(CloseReason.Codes.NORMAL, "")): Unit
Send a close frame with the specified reason. May suspend if outgoing channel is full. The specified reason could be ignored if there was already close frame sent (for example in reply to a peer close frame). It also may do nothing when a session or an outgoing channel is already closed due to any reason. suspend fun WebSocketSession.
Closes with reason depending on cause or normally if cause is |
|
suspend fun WebSocketSession.closeExceptionally(cause: Throwable): Unit
Closes session with normal or error close reason, depending on whether cause is cancellation or not. |
|
fun CoroutineScope. fun CoroutineScope.decodeChunked(input: ByteReadChannel, contentLength: Long): DecoderJob
Start a chunked stream decoder coroutine |
|
fun <T : WebSocketExtension<*>> WebSocketSession.extension(extension: WebSocketExtensionFactory<*, T>): T
Find the extensions using WebSocketExtensionFactory. |
|
fun <T : WebSocketExtension<*>> WebSocketSession.extensionOrNull(extension: WebSocketExtensionFactory<*, T>): T?
Search the extensions using WebSocketExtensionFactory. |
|
fun CoroutineScope.parseMultipart(input: ByteReadChannel, headers: HttpHeadersMap): ReceiveChannel<MultipartEvent> fun CoroutineScope.parseMultipart(input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent> fun CoroutineScope.
Starts a multipart parser coroutine producing multipart events |
|
fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, periodMillis: Long, timeoutMillis: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>
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 |
|
fun CoroutineScope.ponger(outgoing: SendChannel<Pong>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Ping>
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 |
|
suspend fun WebSocketSession.send(content: String): Unit
Enqueues a text frame for sending with the specified content. suspend fun WebSocketSession.send(content: ByteArray): Unit
Enqueues a final binary frame for sending with the specified content. |
|
suspend fun RawWebSocket.start(handler: suspend WebSocketSession.() -> Unit): Unit |
|
fun CoroutineScope.
Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |
|
fun CoroutineScope.startServerConnectionPipeline(connection: ServerIncomingConnection, timeout: WeakTimeoutQueue, handler: HttpRequestHandler): Job
Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |