kotlin-web/web.transport/WebTransportSendStream

WebTransportSendStream

open class WebTransportSendStream : WritableStream<Uint8Array<*>> (source)

The WebTransportSendStream interface of the WebTransport API is a specialized WritableStream that is used to send outbound data in both unidirectional or bidirectional WebTransport streams. Available only in secure contexts.

MDN Reference

Properties

locked

val locked: Boolean

The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

sendOrder

var sendOrder: Int53

The sendOrder property of the WebTransportSendStream interface indicates the send priority of this stream relative to other streams for which the value has been set.

Functions

abort

inline suspend fun <W : ERROR CLASS: Symbol not found for JsAny??> WritableStream<W>.abort()

inline suspend fun <W : ERROR CLASS: Symbol not found for JsAny??> WritableStream<W>.abort(reason: JsError?)

The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

abortAsync

fun abortAsync(reason: JsError? = definedExternally): Promise<Void>

inline suspend fun <W : ERROR CLASS: Symbol not found for JsAny??> WritableStream<W>.close()

The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.

closeAsync

fun closeAsync(): Promise<Void>

The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.

getStats

inline suspend fun WebTransportSendStream.getStats(): WebTransportSendStreamStats

The getStats() method of the WebTransportSendStream interface asynchronously returns an object containing statistics for the current stream.

getStatsAsync

fun getStatsAsync(): Promise<WebTransportSendStreamStats>

The getStats() method of the WebTransportSendStream interface asynchronously returns an object containing statistics for the current stream.

getWriter

fun getWriter(): WritableStreamDefaultWriter<Uint8Array<*>>

The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.