Telematics_cv2x_cpp

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)>

Detailed Description

---

Data Structure Documentation

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 ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xThrottleManagerListener::~ICv2xThrottleManagerListener ( )

virtual

Destructor of ICv2xThrottleManagerListener

Member Function Documentation

virtual void telux::cv2x::ICv2xThrottleManagerListener::onFilterRateAdjustment ( int  rate )

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

Parameters

[in]

rate

the reported filter rate adjustment value.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual void telux::cv2x::ICv2xThrottleManagerListener::onServiceStatusChange ( telux::common::ServiceStatus  status )

virtual

This API is invoked when the service status changes for example when a subsytem restart (SSR) occurs

Parameters

[in]

status

- ServiceStatus

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

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 ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xThrottleManager::~ICv2xThrottleManager ( )

virtual

Member Function Documentation

virtual telux::common::ServiceStatus telux::cv2x::ICv2xThrottleManager::getServiceStatus ( )

pure virtual

This status indicates whether the object is in a usable state.

Returns

SERVICE_AVAILABLE - If location manager is ready for service. SERVICE_UNAVAILABLE - If location manager is temporarily unavailable. SERVICE_FAILED - If location manager encountered an irrecoverable failure.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual std::future<bool> telux::cv2x::ICv2xThrottleManager::onSubsystemReady ( )

pure virtual

Wait for Cv2x throttle manager client to be ready.

Returns

A future that caller can wait on to be notified when Cv2x throttle manager client become ready.

virtual telux::common::Status telux::cv2x::ICv2xThrottleManager::registerListener ( std::weak_ptr< ICv2xThrottleManagerListener >  listener )

pure virtual

Registers a listener to receive the updated filer rate adjustment data.

Parameters

[in]

listner

- Listener that implement ICv2xThrottleManagerListener interface.

virtual telux::common::Status telux::cv2x::ICv2xThrottleManager::deregisterListener ( std::weak_ptr< ICv2xThrottleManagerListener >  listener )

pure virtual

Deregister a ICv2xThrottleManagerListener.

Parameters

[in]

listener

- Previously registered Cv2xThrottleManagerListener that is deregistered.

virtual telux::common::Status telux::cv2x::ICv2xThrottleManager::setVerificationLoad ( int  load, setVerificationLoadCallback  cb  )

pure virtual

Set current measured/average verification load.

Parameters

[in]

load

- current measured verification load(verification/second).

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

Typedef Documentation

using telux::cv2x::setVerificationLoadCallback = typedef std::function<void (telux::common::ErrorCode error)>

This function is called as a response to setVerificationLoad

Parameters

[in]

error

- SUCCESS if verification load was set successfully SUCCESS GENERIC_FAILURE