kotlin-browser/web.transport/WebTransport

WebTransport

open class WebTransport(url: String, options: WebTransportOptions = definedExternally)(source)

The WebTransport interface of the WebTransport API provides functionality to enable a user agent to connect to an HTTP/3 server, initiate reliable and unreliable transport in either or both directions, and close the connection once it is no longer needed. Available only in secure contexts.

MDN Reference

Constructors

Link copied to clipboard
constructor(url: String, options: WebTransportOptions = definedExternally)
constructor(url: URL, options: WebTransportOptions = definedExternally)

Properties

Link copied to clipboard
val closed: Promise<WebTransportCloseInfo>

The closed read-only property of the WebTransport interface returns a promise that resolves when the transport is closed.

Link copied to clipboard
val datagrams: WebTransportDatagramDuplexStream

The datagrams read-only property of the WebTransport interface returns a WebTransportDatagramDuplexStream instance that can be used to send and receive datagrams — unreliable data transmission.

Link copied to clipboard
val incomingBidirectionalStreams: ReadableStream<*>

The incomingBidirectionalStreams read-only property of the WebTransport interface represents one or more bidirectional streams opened by the server.

Link copied to clipboard
val incomingUnidirectionalStreams: ReadableStream<*>

The incomingUnidirectionalStreams read-only property of the WebTransport interface represents one or more unidirectional streams opened by the server.

Link copied to clipboard
val ready: Promise<Void?>

The ready read-only property of the WebTransport interface returns a promise that resolves when the transport is ready to use.

Functions

Link copied to clipboard
fun close(closeInfo: WebTransportCloseInfo = definedExternally)

The close() method of the WebTransport interface closes an ongoing WebTransport session.

Link copied to clipboard
inline suspend fun WebTransport.createBidirectionalStream(): WebTransportBidirectionalStream
inline suspend fun WebTransport.createBidirectionalStream(options: WebTransportSendStreamOptions): WebTransportBidirectionalStream

The createBidirectionalStream() method of the WebTransport interface asynchronously opens and returns a bidirectional stream.

Link copied to clipboard
fun createBidirectionalStreamAsync(options: WebTransportSendStreamOptions = definedExternally): Promise<WebTransportBidirectionalStream>

The createBidirectionalStream() method of the WebTransport interface asynchronously opens and returns a bidirectional stream.

Link copied to clipboard
inline suspend fun WebTransport.createUnidirectionalStream(): WritableStream<*>
inline suspend fun WebTransport.createUnidirectionalStream(options: WebTransportSendStreamOptions): WritableStream<*>

The createUnidirectionalStream() method of the WebTransport interface asynchronously opens a unidirectional stream.

Link copied to clipboard
fun createUnidirectionalStreamAsync(options: WebTransportSendStreamOptions = definedExternally): Promise<WritableStream<*>>

The createUnidirectionalStream() method of the WebTransport interface asynchronously opens a unidirectional stream.