interface RemoteChannelClient
A RemoteChannelClient allows creating channels to communicate with a RemoteChannelServer. The server should be configured to listen to channels with the channel ids provided to the channel creation functions in the client.
Companion namespace: RemoteChannelClient
Methods
createCross
Resolves, if successful, to a new remote cross channel.
createCrossDefinition
createCross<TSend = void, TReceive = TSend>(config: RemoteChannelClient.CrossChannelConfig): Promise<CrossChannel<TSend, TReceive>>;
Type parameters
| Name | Default | Description |
|---|---|---|
| TSend | void | the send message type |
| TReceive | TSend | the receive message type |
Parameters
| Name | Type | Description |
|---|---|---|
config | RemoteChannelClient.CrossChannelConfig | the remote channel configuration |
createRead
Resolves, if successful, to a new remote read channel.
createReadDefinition
createRead<T>(config: RemoteChannelClient.ReadChannelConfig): Promise<Channel.Read<T>>;
Type parameters
| Name | Description |
|---|---|
| T | the channel message type |
Parameters
| Name | Type | Description |
|---|---|---|
config | RemoteChannelClient.ReadChannelConfig | the remote channel configuration |
createWrite
Resolves, if successful, to a new remote write channel.
createWriteDefinition
createWrite<T>(config: RemoteChannelClient.WriteChannelConfig): Promise<Channel.Write<T>>;
Type parameters
| Name | Description |
|---|---|
| T | the channel message type |
Parameters
| Name | Type | Description |
|---|---|---|
config | RemoteChannelClient.WriteChannelConfig | the remote channel configuration |