ADTF
Loading...
Searching...
No Matches
adtf::ucom::ant::IEventSource Class Referenceabstract

#include <event_source_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions

 ADTF_IID (IEventSource, "event_source.ant.ucom.adtf.iid")
 
virtual tResult RegisterEventSink (IEventSink &oEventSink)=0
 
virtual tResult UnregisterEventSink (IEventSink &oEventSink)=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Protected Member Functions

 ~IEventSource ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 
- Protected Member Functions inherited from adtf::ucom::ant::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.

Member Function Documentation

◆ ADTF_IID()

adtf::ucom::ant::IEventSource::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 adtf::ucom::ant::IEventSource::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 adtf::ucom::ant::IEventSource::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.

The documentation for this class was generated from the following file: