Skip to main content

interface RemoteChannel.WriteConfig

Interface defining the write configuration for a RemoteChannel.

Implemented by: RemoteChannelClient.WriteChannelConfig

Properties

capacity

The maximum amount of messages the Channel can buffer. If 0, the channel is unbuffered and the communication is synchronous.

Definition

capacity?: number;

channelId

An ID used for the client and server to connect the correct channels to each other.

Definition

channelId: string;

handshakeAttemptTimeoutMs

The amount of milliseconds to wait for a reponse to each handshake.

Definition

handshakeAttemptTimeoutMs?: number;

maxHandshakeAttempts

The amount of handshake attempts to make before failing.

Definition

maxHandshakeAttempts?: number;

validator

A function taking a message and returning true if the message is of a valid type, false otherwise

Definition

validator?: (value: any) => boolean;