ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
IEventSourceabstract

The class IEventSource provides a generic event provider interface. More...

#include <event_source_intf.h>

Inheritance diagram for IEventSource:
[legend]

Public Member Functions

 ADTF_IID (IEventSource, "event_source.ant.ucom.adtf.iid")
 Marks the IEventSource to be castable with the ucom_cast<>
 
virtual tResult RegisterEventSink (IEventSink &oEventSink)=0
 Register event sink.
 
virtual tResult UnregisterEventSink (IEventSink &oEventSink)=0
 Unregister event sink.
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast()
 

Protected Member Functions

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

Detailed Description

The class IEventSource provides a generic event provider interface.

Commonly this interface is implemented by services.
See the cEventSource for the default implementation.

Definition at line 71 of file event_source_intf.h.

Member Function Documentation

◆ ADTF_IID()

ADTF_IID ( IEventSource ,
"event_source.ant.ucom.adtf.iid"  )

Marks the IEventSource to be castable with the ucom_cast<>

See also
ADTF_IID(_interface, _striid)

◆ RegisterEventSink()

virtual tResult RegisterEventSink ( IEventSink & oEventSink)
pure virtual

Register event sink.

The RegisterEventSink method registers an event sink interface.

Parameters
oEventSink[in] reference to the event sink to be registered.
Returns
Returns a standard result code.

◆ UnregisterEventSink()

virtual tResult UnregisterEventSink ( IEventSink & oEventSink)
pure virtual

Unregister event sink.

The UnregisterEventSink method unregisters an event sink interface.

Parameters
oEventSink[in] reference to the event sink to be unregistered.
Returns
Returns a standard result code.