|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The EventDispatcher class is used for injecting any events and dealing with event handlers which handle those events.
◆ EventDispatcher() [1/2]
HPS.EventDispatcher.EventDispatcher |
( |
| ) |
|
|
inline |
◆ EventDispatcher() [2/2]
◆ Equals()
Check if the source EventDispatcher is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ InjectEvent()
bool HPS.EventDispatcher.InjectEvent |
( |
HPS.Event |
in_event | ) |
|
|
inline |
Inject the specified event and propagate it to all subscribed handlers in the order of subscription.
- Parameters
-
in_event | Event to inject and propagate. |
- Returns
- true if the event injection was successful, false otherwise.
◆ InjectEventWithNotifier()
Inject the specified event and propagate it to all subscribed handlers in the order of subscription and return an EventNotifier associated with the injected event.
- Parameters
-
in_event | Event to inject and propagate. |
- Returns
- An event notifier associated with the injected event.
◆ IsShutdown()
bool HPS.EventDispatcher.IsShutdown |
( |
| ) |
|
|
inline |
Query whether the asynchronous shutdown has completed.
- Returns
- true if the event dispatcher has shutdown, false otherwise.
◆ ObjectType()
override HPS.Type HPS.EventDispatcher.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ SetName()
void HPS.EventDispatcher.SetName |
( |
string |
in_name | ) |
|
|
inline |
◆ ShowName()
void HPS.EventDispatcher.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
◆ Shutdown()
void HPS.EventDispatcher.Shutdown |
( |
| ) |
|
|
inline |
Shutdown this EventDispatcher asynchronously. Any pending events injected into this EventDispatcher will be processed prior to shutdown, but no new events can be injected.
◆ Subscribe()
bool HPS.EventDispatcher.Subscribe |
( |
HPS.EventHandler |
in_handler, |
|
|
IntPtr |
in_type |
|
) |
| |
|
inline |
Add the specified event handler to the list of subscribers for events of the specified type on this EventDispatcher.
- Parameters
-
in_handler | Event handler to add to the subscriber list for events of the given type. |
in_type | Type of event to add the handler for. |
- Returns
- true if the subscription was successful, false otherwise.
◆ UnSubscribe() [1/3]
bool HPS.EventDispatcher.UnSubscribe |
( |
HPS.EventHandler |
in_handler, |
|
|
IntPtr |
in_type |
|
) |
| |
|
inline |
Remove the specified event handler from the list of subscribers for events of the specified type on this EventDispatcher.
- Parameters
-
in_handler | Event handler to remove from the subscriber list for events of the given type. |
in_type | Type of event to remove the handler for. |
- Returns
- true if the unsubscription was successful, false otherwise.
◆ UnSubscribe() [2/3]
Remove the specified event handler from the list of subscribers for events of the specified type on this EventDispatcher.
- Parameters
-
in_handler | Event handler to remove from the subscriber list for events of the given type. |
- Returns
- true if the unsubscription was successful, false otherwise.
◆ UnSubscribe() [3/3]
bool HPS.EventDispatcher.UnSubscribe |
( |
IntPtr |
in_type | ) |
|
|
inline |
Remove the specified event handler from the list of subscribers for events of the specified type on this EventDispatcher.
- Parameters
-
in_type | Type of event to remove the handler for. |
- Returns
- true if the unsubscription was successful, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.EventDispatcher.cs