ChannelProvider Class |
Provides a message channel provider for channel messaging.
Inheritance HierarchyNamespace: Openfin.Desktop.Messaging
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
SyntaxC#
public class ChannelProvider : MessageChannel
The ChannelProvider type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ChannelName |
The name of the channel.
(Inherited from MessageChannel.) |
Methods| Name | Description | |
|---|---|---|
 | Broadcast |
Broadcasts to all connected ChannelClients on a specific topic.
|
| CloseAsync |
Closes the current ChannelProvider instance as an asynchronous operation.
|
| DispatchAsync(ChannelEndpoint, String, Object) |
Dispatch a message to a connected ChannelClient.
|
| DispatchAsyncT(ChannelEndpoint, String, T) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnClosed |
Raises the Closed event.
(Inherited from MessageChannel.) |
| OnOpened |
Raises the Opened event.
(Inherited from MessageChannel.) |
| OpenAsync |
Opens the current ChannelProvider instance as an asynchronous operation.
|
| RegisterTopic(String, ActionChannelClient) |
Registers a method for a given topic.
|
| RegisterTopic(String, Action) |
Registers a method for a given topic.
(Inherited from MessageChannel.) |
| RegisterTopicT(String, ActionT, ChannelClient) |
Registers a method for a given topic.
|
| RegisterTopicTResult(String, FuncChannelClient, TResult) |
Registers a method that returns a value for a given topic.
|
| RegisterTopicT(String, ActionT) |
Registers a method that takes a parameter for a given topic.
(Inherited from MessageChannel.) |
| RegisterTopicTResult(String, FuncTResult) |
Registers a method that returns a value for a given topic.
(Inherited from MessageChannel.) |
| RegisterTopicT, TResult(String, FuncT, ChannelClient, TResult) |
Registers a method that takes a parameter and returns a value for a given topic.
|
| RegisterTopicT, TResult(String, FuncT, TResult) |
Registers a method that takes a parameter and returns a value for a given topic.
(Inherited from MessageChannel.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnregisterTopic |
Removes a previously registered method for the specified topic.
(Inherited from MessageChannel.) |
Events| Name | Description | |
|---|---|---|
 | ClientConnected |
Occurs when a ChannelClient has connected to the ChannelProvider instance.
|
| ClientDisconnected |
Occurs when a ChannelClient has disconnected from the ChannelProvider instance.
|
| Closed |
Occurrs when the MessageChannel has closed.
(Inherited from MessageChannel.) |
| Opened |
Occurs when the MessageChannel has opened.
(Inherited from MessageChannel.) |
See Also