ADTF  3.15.3
ISignalListeningabstract

Interface for listening to signals that are available via the signal regsitry. More...

Inheritance diagram for ISignalListening:
[legend]

Classes

class  ISignalListener
 Callback interface for signal value updates. More...
 
class  ISignalsListener
 Callback interface that informs about added and/or removed signals. More...
 

Public Member Functions

 ADTF_IID (ISignalListening, "signal_listening.ant.services.adtf.iid")
 Interface ID for the interface.
 
virtual tResult RegisterSignalsListener (ISignalsListener &oListener)=0
 Registers a new listener for added and removed signals. More...
 
virtual tResult UnregisterSignalsListener (ISignalsListener &oListener)=0
 Unregisters a listener for added and removed signals. More...
 
virtual tResult RequestSignalUpdates (ISignalRegistry::tSignalID nSignalID, ISignalListener &oListener)=0
 Requests updates for a given signal. More...
 
virtual tResult CancelSignalUpdates (ISignalRegistry::tSignalID nSignalID, ISignalListener &oListener)=0
 Cancels a request for signal updates. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~ISignalListening ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Interface for listening to signals that are available via the signal regsitry.

Definition at line 27 of file signal_listening_intf.h.

Member Function Documentation

◆ CancelSignalUpdates()

virtual tResult CancelSignalUpdates ( ISignalRegistry::tSignalID  nSignalID,
ISignalListener oListener 
)
pure virtual

Cancels a request for signal updates.

Parameters
[in]nSignalIDThe id of the signal.
[in]oListenerThe listener.
Returns
Standard result.

◆ RegisterSignalsListener()

virtual tResult RegisterSignalsListener ( ISignalsListener oListener)
pure virtual

Registers a new listener for added and removed signals.

This will call ISignalsListener::SignalAdded for each signal currently registered.

Parameters
[in]oListenerThe new listener.
Returns
Standard result.

◆ RequestSignalUpdates()

virtual tResult RequestSignalUpdates ( ISignalRegistry::tSignalID  nSignalID,
ISignalListener oListener 
)
pure virtual

Requests updates for a given signal.

Parameters
[in]nSignalIDThe id of the signal
[in]oListenerThe listener whose ISignalListener::SignalUpdated method will be called.
Returns
Standard result.

◆ UnregisterSignalsListener()

virtual tResult UnregisterSignalsListener ( ISignalsListener oListener)
pure virtual

Unregisters a listener for added and removed signals.

Parameters
[in]oListenerThe listener.
Returns
Standard result.