Skip to main content

interface RemoteChannelClient.WriteChannelConfig

Interface defining the configuration options for creating a remote Channel.Write channel

Extends: RemoteChannel.WriteConfig

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;

Overrides​

WriteConfig.capacity

channelId​

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

Definition​

channelId: string;

Overrides​

WriteConfig.channelId

handshakeAttemptTimeoutMs​

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

Definition​

handshakeAttemptTimeoutMs?: number;

Overrides​

WriteConfig.handshakeAttemptTimeoutMs

maxHandshakeAttempts​

The amount of handshake attempts to make before failing.

Definition​

maxHandshakeAttempts?: number;

Overrides​

WriteConfig.maxHandshakeAttempts

rcsChannelTimeoutMs​

The amount of ms to wait when blocked sending to the RCS channel.

Definition​

rcsChannelTimeoutMs?: 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;

Overrides​

WriteConfig.validator