Click or drag to resize

ChannelProvider Class

Provides a message channel provider for channel messaging.
Inheritance Hierarchy
SystemObject
  Openfin.Desktop.MessagingMessageChannel
    Openfin.Desktop.MessagingChannelProvider

Namespace:  Openfin.Desktop.Messaging
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
Syntax
C#
public class ChannelProvider : MessageChannel

The ChannelProvider type exposes the following members.

Properties
  NameDescription
Public propertyChannelName
The name of the channel.
(Inherited from MessageChannel.)
Top
Methods
  NameDescription
Public methodBroadcast
Broadcasts to all connected ChannelClients on a specific topic.
Public methodCloseAsync
Closes the current ChannelProvider instance as an asynchronous operation.
Public methodDispatchAsync(ChannelEndpoint, String, Object)
Dispatch a message to a connected ChannelClient.
Public methodDispatchAsyncT(ChannelEndpoint, String, T)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClosed
Raises the Closed event.
(Inherited from MessageChannel.)
Protected methodOnOpened
Raises the Opened event.
(Inherited from MessageChannel.)
Public methodOpenAsync
Opens the current ChannelProvider instance as an asynchronous operation.
Public methodRegisterTopic(String, ActionChannelClient)
Registers a method for a given topic.
Public methodRegisterTopic(String, Action)
Registers a method for a given topic.
(Inherited from MessageChannel.)
Public methodRegisterTopicT(String, ActionT, ChannelClient)
Registers a method for a given topic.
Public methodRegisterTopicTResult(String, FuncChannelClient, TResult)
Registers a method that returns a value for a given topic.
Public methodRegisterTopicT(String, ActionT)
Registers a method that takes a parameter for a given topic.
(Inherited from MessageChannel.)
Public methodRegisterTopicTResult(String, FuncTResult)
Registers a method that returns a value for a given topic.
(Inherited from MessageChannel.)
Public methodRegisterTopicT, TResult(String, FuncT, ChannelClient, TResult)
Registers a method that takes a parameter and returns a value for a given topic.
Public methodRegisterTopicT, TResult(String, FuncT, TResult)
Registers a method that takes a parameter and returns a value for a given topic.
(Inherited from MessageChannel.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregisterTopic
Removes a previously registered method for the specified topic.
(Inherited from MessageChannel.)
Top
Events
  NameDescription
Public eventClientConnected
Occurs when a ChannelClient has connected to the ChannelProvider instance.
Public eventClientDisconnected
Occurs when a ChannelClient has disconnected from the ChannelProvider instance.
Public eventClosed
Occurrs when the MessageChannel has closed.
(Inherited from MessageChannel.)
Public eventOpened
Occurs when the MessageChannel has opened.
(Inherited from MessageChannel.)
Top
See Also