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

WebTransport

constructor(url: URL, options: WebTransportOptions = definedExternally)

constructor(url: String, options: WebTransportOptions = definedExternally)

Properties

closed

val closed: Promise<WebTransportCloseInfo>

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

datagrams

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.

incomingBidirectionalStreams

val incomingBidirectionalStreams: ReadableStream<*>

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

incomingUnidirectionalStreams

val incomingUnidirectionalStreams: ReadableStream<*>

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

ready

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

fun close(closeInfo: WebTransportCloseInfo = definedExternally)

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

createBidirectionalStream

suspend fun createBidirectionalStream(options: WebTransportSendStreamOptions = definedExternally): WebTransportBidirectionalStream

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

createBidirectionalStreamAsync

fun createBidirectionalStreamAsync(options: WebTransportSendStreamOptions = definedExternally): Promise<WebTransportBidirectionalStream>

createUnidirectionalStream

suspend fun createUnidirectionalStream(options: WebTransportSendStreamOptions = definedExternally): WritableStream<*>

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

createUnidirectionalStreamAsync

fun createUnidirectionalStreamAsync(options: WebTransportSendStreamOptions = definedExternally): Promise<WritableStream<*>>