Package org.angular.ts.ng
Interface WebTransportConfig
@JsType(isNative=true,
name="ng.WebTransportConfig",
namespace="<global>")
public interface WebTransportConfig
Options passed to `$webTransport`.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property.static interfaceTypeScript callback contract for this property. -
Method Summary
Modifier and TypeMethodDescriptionstatic WebTransportConfigcreate()doubleMaximum reconnect attempts before `closed` settles.Called when the managed connection closes without another reconnect.Called with each incoming datagram.Called when opening, reading, writing, or closing fails.Called whenever the current native transport resolves `ready`.Called when a decoded datagram uses the realtime protocol shape.Called after a replacement session is ready so callers can renegotiate state.Delay before each reconnect attempt.Converts incoming datagram bytes into the value passed as `event.message`.booleanReopen the native WebTransport session when it closes unexpectedly.voidsetMaxRetries(double maxRetries) Maximum reconnect attempts before `closed` settles.voidCalled when the managed connection closes without another reconnect.voidsetOnDatagram(WebTransportConfig.OnDatagramCallback onDatagram) Called with each incoming datagram.voidCalled when opening, reading, writing, or closing fails.voidCalled whenever the current native transport resolves `ready`.voidsetOnProtocolMessage(WebTransportConfig.OnProtocolMessageCallback onProtocolMessage) Called when a decoded datagram uses the realtime protocol shape.voidsetOnReconnect(WebTransportConfig.OnReconnectCallback onReconnect) Called after a replacement session is ready so callers can renegotiate state.voidsetReconnect(boolean reconnect) Reopen the native WebTransport session when it closes unexpectedly.voidsetRetryDelay(Object retryDelay) Delay before each reconnect attempt.voidsetTransformDatagram(WebTransportConfig.TransformDatagramCallback transformDatagram) Converts incoming datagram bytes into the value passed as `event.message`.
-
Method Details
-
create
-
getMaxRetries
@JsProperty double getMaxRetries()Maximum reconnect attempts before `closed` settles. Defaults to no limit. -
getOnClose
Called when the managed connection closes without another reconnect. -
getOnDatagram
Called with each incoming datagram. -
getOnError
Called when opening, reading, writing, or closing fails. -
getOnOpen
Called whenever the current native transport resolves `ready`. -
getOnProtocolMessage
Called when a decoded datagram uses the realtime protocol shape. -
getOnReconnect
Called after a replacement session is ready so callers can renegotiate state. -
getRetryDelay
Delay before each reconnect attempt. Defaults to 1000ms. -
getTransformDatagram
Converts incoming datagram bytes into the value passed as `event.message`. -
isReconnect
@JsProperty boolean isReconnect()Reopen the native WebTransport session when it closes unexpectedly. -
setMaxRetries
@JsProperty void setMaxRetries(double maxRetries) Maximum reconnect attempts before `closed` settles. Defaults to no limit. -
setOnClose
Called when the managed connection closes without another reconnect. -
setOnDatagram
Called with each incoming datagram. -
setOnError
Called when opening, reading, writing, or closing fails. -
setOnOpen
Called whenever the current native transport resolves `ready`. -
setOnProtocolMessage
@JsProperty void setOnProtocolMessage(WebTransportConfig.OnProtocolMessageCallback onProtocolMessage) Called when a decoded datagram uses the realtime protocol shape. -
setOnReconnect
Called after a replacement session is ready so callers can renegotiate state. -
setReconnect
@JsProperty void setReconnect(boolean reconnect) Reopen the native WebTransport session when it closes unexpectedly. -
setRetryDelay
Delay before each reconnect attempt. Defaults to 1000ms. -
setTransformDatagram
@JsProperty void setTransformDatagram(WebTransportConfig.TransformDatagramCallback transformDatagram) Converts incoming datagram bytes into the value passed as `event.message`.
-