namespace 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 interface: RemoteChannelClient
Interfaces
| Name | Description |
|---|---|
RemoteChannelClient.Config | Interface defining the confirgartion options for a RemoteChannelClient |
RemoteChannelClient.Constructors | Defines the static RemoteChannelClient API. |
RemoteChannelClient.CrossChannelConfig | Interface defining the configuration options for creating a remote Channel.Cross channel |
RemoteChannelClient.ReadChannelConfig | Interface defining the configuration options for creating a remote Channel.Read channel |
RemoteChannelClient.WriteChannelConfig | Interface defining the configuration options for creating a remote Channel.Write channel |
Static Methods
create
Creates a new RemoteChannelClient instance with the given configuration.
createDefinition
create(config: RemoteChannelClient.Config): Promise<RemoteChannelClient>;
Parameters
| Name | Type | Description |
|---|---|---|
config | RemoteChannelClient.Config | the configuration for the client: |