The class cEventSource provides a basic implementation of IEventSource and wraps code to manage lists of pointers to IEventSink interfaces. More...

Inheritance diagram for cEventSource:

Public Member Functions
tResult	FireEvent (const void *pvEventData) const
	Fire event.

tResult	RegisterEventSink (IEventSink &oEventSink)

tResult	UnregisterEventSink (IEventSink &oEventSink)

Public Member Functions inherited from object< IEventSource >
tResult	GetInterface (const char i_strIID, void &o_pInterface) override
	Query interfaces on an object.

tResult	GetInterface (const char i_strIID, const void &o_pInterface) const override
	Provides const correct interface querying.

void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.

tResult	GetInterface (const char i_strIID, void &o_pInterface) override
	Query interfaces on an object.

tResult	GetInterface (const char i_strIID, const void &o_pInterface) const override
	Provides const correct interface querying.

void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.

tResult	GetInterface (const char i_strIID, void &o_pInterface) override
	Query interfaces on an object.

tResult	GetInterface (const char i_strIID, const void &o_pInterface) const override
	Provides const correct interface querying.

void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.

Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()`

Additional Inherited Members
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

The class cEventSource provides a basic implementation of IEventSource and wraps code to manage lists of pointers to IEventSink interfaces.

This will show you how to define such simple event.

Warning: : This is only a simple Internal Event pattern and is different from the IKernel Signals !!

Definition at line 30 of file event_source.h.

Member Function Documentation

tResult FireEvent ( const void * pvEventData ) const

Fire event.

The FireEvent method sends an event to all registered event sinks. If one event sink returns ERR_CANCELED, the calling loop is aborted.

Parameters

pvEventData [in] Pointer to event specific data.

Returns: Returns a standard result code. If cancelled, ERR_CANCELED is returned.

std::vector<IEventSink*> m_oEventSinks

private

Definition at line 33 of file event_source.h.