HPS.EventDispatcher Class Reference

Inheritance diagram for HPS.EventDispatcher:

Public Member Functions
override void	Dispose ()
override bool	Equals (System.Object obj)
bool	Equals (HPS.EventDispatcher in_that)
	EventDispatcher ()
	EventDispatcher (HPS.EventDispatcher in_that)
override int	GetHashCode ()
bool	InjectEvent (HPS.Event in_event)
HPS.EventNotifier	InjectEventWithNotifier (HPS.Event in_event)
bool	IsShutdown ()
override HPS.Type	ObjectType ()
void	SetName (string in_name)
void	ShowName (out string out_name)
void	Shutdown ()
bool	Subscribe (HPS.EventHandler in_handler, IntPtr in_type)
bool	UnSubscribe (HPS.EventHandler in_handler, IntPtr in_type)
bool	UnSubscribe (HPS.EventHandler in_handler)
bool	UnSubscribe (IntPtr in_type)
Public Member Functions inherited from HPS.Object
virtual bool	Empty ()
IntPtr	GetClassID ()
IntPtr	GetInstanceID ()
bool	HasType (HPS.Type in_mask)
	Object (HPS.Object that)
virtual void	Reset ()
virtual HPS.Type	Type ()

Static Public Member Functions
static bool	operator!= (HPS.EventDispatcher a, HPS.EventDispatcher b)
static bool	operator== (HPS.EventDispatcher a, HPS.EventDispatcher b)
Static Public Member Functions inherited from HPS.Object
static IntPtr	ClassID< T > ()

Protected Member Functions
override void	deleteCptr ()
Protected Member Functions inherited from HPS.Object
virtual IntPtr	GetNonDirectorClassID ()

Additional Inherited Members
Protected Attributes inherited from HPS.Object
bool	cMemOwn
HandleRef	cptr

Detailed Description

The EventDispatcher class is used for injecting any events and dealing with event handlers which handle those events.

Constructor & Destructor Documentation

EventDispatcher() [1/2]

HPS.EventDispatcher.EventDispatcher ( )

inline

The default constructor creates an uninitialized EventDispatcher object which cannot be subscribed to.

See also

Database.CreateEventDispatcher()

EventDispatcher() [2/2]

HPS.EventDispatcher.EventDispatcher ( HPS.EventDispatcher  in_that )

inline

The copy constructor creates an EventDispatcher object that points to the same underlying impl as the source EventDispatcher.

Parameters

in_that

The source EventHandler to point to.

Member Function Documentation

Equals()

bool HPS.EventDispatcher.Equals ( HPS.EventDispatcher  in_that )

inline

Check if the source EventDispatcher is equivalent to this object.

Parameters

in_that

The source EventDispatcher to compare to this object.

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()

HPS.EventNotifier HPS.EventDispatcher.InjectEventWithNotifier ( HPS.Event  in_event )

inline

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

Sets the EventDispatcher's name

Parameters

in_name

Name to set.

ShowName()

void HPS.EventDispatcher.ShowName ( out string  out_name )

inline

Shows the EventDispatcher's name

Parameters

out_name

Current name of this EventDispatcher.

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]

bool HPS.EventDispatcher.UnSubscribe ( HPS.EventHandler  in_handler )

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.

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