cMessagePublisher Class |
This class provides a single interface for dealing with different types of messages.
It uses a Publisher/Subscriber or Observer pattern
Inheritance HierarchyNamespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe cMessagePublisher type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | cMessagePublisher | Initializes a new instance of the cMessagePublisher class |
Properties| Name | Description | |
|---|---|---|
 | PluginManager |
Get/set the cPluginManager to use.
|
Methods| Name | Description | |
|---|---|---|
| AddMessage |
Add a message to the message publisher.
|
| AddMessageHandler |
Add a Message Handler to list of message handlers
|
| Dispose | Releases all resources used by the cMessagePublisher |
| 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.) |
| RemoveMessageHandler |
Remove ALL instances of a Message Handler
|
| RemoveMessageLock |
Decrease the Messages lock count. While this lock count is active, no messages will
be sent. When the lock reaches zero, any obstructed SendMessage call will be completed.
|
| SendMessage |
Send the message to the all handlers that can handle this type of message or to the default handler for this eCoreComponentType.
|
| SetMessageLock |
Increase the Messages lock count. While this lock count is active, no messages will
be sent.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |
Remarks
How to use:
For a given message create a new cMessageHandler object and add it to the message handlers via the cMessagePublisher.AddMessageHandler(...) method
Then when you want to send a message create a new cMessage object with the information you want sent and call the cMessagePublisher.SendMessage(cMessage) method
This will send the message to any message handler that has been set-up to listen for this type of message.
If no handler was defined for this type of message then the default handler will be used.
If no default handler has been created then cMessagePublisher.SendMessage will return False.
See Also