Telematics SDK - Interface Specification
v1.33.62
|
Data Structures | |
class | telux::cv2x::ICv2xThrottleManagerListener |
Listener class for getting filter rate update notification. More... | |
class | telux::cv2x::ICv2xThrottleManager |
ThrottleManager provides throttle manager client interface. More... | |
Typedefs | |
using | telux::cv2x::setVerificationLoadCallback = std::function< void(telux::common::ErrorCode error)> |
class telux::cv2x::ICv2xThrottleManagerListener |
Listener class for getting filter rate update notification.
Public Member Functions | |
virtual void | onFilterRateAdjustment (int rate) |
virtual void | onServiceStatusChange (telux::common::ServiceStatus status) |
virtual | ~ICv2xThrottleManagerListener () |
|
virtual |
Destructor of ICv2xThrottleManagerListener
|
virtual |
This API is invoked to advise the client to adjust the incoming message filtering rate by rate
messages/second. If the rate
is positive, it indicates the client to filter rate
more messages/second If the rate
is negative, it indicates the client to filter rate
less messages/second
[in] | rate | the reported filter rate adjustment value. |
|
virtual |
This API is invoked when the service status changes for example when a subsytem restart (SSR) occurs
[in] | status | - ServiceStatus |
class telux::cv2x::ICv2xThrottleManager |
ThrottleManager provides throttle manager client interface.
ThrottleManager provides APIs that allows applications to specify the incoming verification load on the system. This is used to make decisions on how to optimally use the resources available in the system. The API also provides feedback to clients on the suggested filtering that needs to be done when the incoming message verification rate exceeds the instantaneous system capacity.
Public Member Functions | |
virtual telux::common::ServiceStatus | getServiceStatus ()=0 |
virtual std::future< bool > | onSubsystemReady ()=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ICv2xThrottleManagerListener > listener)=0 |
virtual telux::common::Status | deregisterListener (std::weak_ptr< ICv2xThrottleManagerListener > listener)=0 |
virtual telux::common::Status | setVerificationLoad (int load, setVerificationLoadCallback cb)=0 |
virtual | ~ICv2xThrottleManager () |
|
virtual |
|
pure virtual |
This status indicates whether the object is in a usable state.
|
pure virtual |
Wait for Cv2x throttle manager client to be ready.
|
pure virtual |
Registers a listener to receive the updated filer rate adjustment data.
[in] | listner | - Listener that implement ICv2xThrottleManagerListener interface. |
|
pure virtual |
Deregister a ICv2xThrottleManagerListener.
[in] | listener | - Previously registered Cv2xThrottleManagerListener that is deregistered. |
|
pure virtual |
Set current measured/average verification load.
[in] | load | - current measured verification load(verification/second). |
using telux::cv2x::setVerificationLoadCallback = typedef std::function<void (telux::common::ErrorCode error)> |
This function is called as a response to setVerificationLoad
[in] | error | - SUCCESS if verification load was set successfully
|