telux::cv2x Namespace Reference

Data Structures
class	Cv2xFactory
	Cv2xFactory is the factory that creates the Cv2x Radio. More...
class	ICv2xRadio
class	ICv2xRadioListener
	Listeners for Cv2xRadio must implement this interface. More...
class	ICv2xRadioManager
	Cv2xRadioManager manages instances of Cv2xRadio. More...
struct	Cv2xStatus
struct	SpsFlowInfo
struct	Cv2xRadioCapabilities
struct	MacDetails
class	ICv2xRxSubscription
class	ICv2xTxFlow

Typedefs
using	CreateRxSubscriptionCallback = std::function< void(std::shared_ptr< ICv2xRxSubscription > rxSub, telux::common::ErrorCode error)>
using	CreateTxSpsFlowCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txSpsFlow, std::shared_ptr< ICv2xTxFlow > txEventFlow, telux::common::ErrorCode spsError, telux::common::ErrorCode eventError)>
using	CreateTxEventFlowCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txEventFlow, telux::common::ErrorCode error)>
using	CloseTxFlowCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txFlow, telux::common::ErrorCode error)>
using	CloseRxSubscriptionCallback = std::function< void(std::shared_ptr< ICv2xRxSubscription > rxSub, telux::common::ErrorCode error)>
using	ChangeSpsFlowInfoCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txFlow, telux::common::ErrorCode error)>
using	RequestSpsFlowInfoCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txFlow, const SpsFlowInfo &spsInfo, telux::common::ErrorCode error)>
using	UpdateSrcL2InfoCallback = std::function< void(telux::common::ErrorCode error)>
using	StartCv2xCallback = std::function< void(telux::common::ErrorCode error)>
using	StopCv2xCallback = std::function< void(telux::common::ErrorCode error)>
using	RequestCv2xStatusCallback = std::function< void(Cv2xStatus status, telux::common::ErrorCode error)>
using	UpdateConfigurationCallback = std::function< void(telux::common::ErrorCode error)>

Enumerations
enum	TrafficCategory { TrafficCategory::SAFETY_TYPE, TrafficCategory::NON_SAFETY_TYPE }
enum	Cv2xStatusType { Cv2xStatusType::INACTIVE, Cv2xStatusType::ACTIVE, Cv2xStatusType::SUSPENDED, Cv2xStatusType::UNKNOWN }
enum	Cv2xCauseType { Cv2xCauseType::TIMING, Cv2xCauseType::CONFIG, Cv2xCauseType::UE_MODE, Cv2xCauseType::UNKNOWN }
enum	TrafficIpType { TrafficIpType::TRAFFIC_IP, TrafficIpType::TRAFFIC_NON_IP }
enum	RadioConcurrencyMode { RadioConcurrencyMode::WWAN_NONCONCURRENT, RadioConcurrencyMode::WWAN_CONCURRENT }
enum	Cv2xEvent { Cv2xEvent::CV2X_INACTIVE, Cv2xEvent::CV2X_ACTIVE, Cv2xEvent::TX_SUSPENDED, Cv2xEvent::TXRX_SUSPENDED }
enum	Priority {   Priority::MOST_URGENT, Priority::PRIORITY_1, Priority::PRIORITY_2, Priority::PRIORITY_3,   Priority::PRIORITY_4, Priority::PRIORITY_5, Priority::PRIORITY_6, Priority::PRIORITY_BACKGROUND,   Priority::PRIORITY_UNKNOWN }
enum	Periodicity {   Periodicity::PERIODICITY_10MS, Periodicity::PERIODICITY_20MS, Periodicity::PERIODICITY_50MS, Periodicity::PERIODICITY_100MS,   Periodicity::PERIODICITY_UNKNOWN }

Typedef Documentation

using telux::cv2x::CreateRxSubscriptionCallback = typedef std::function<void (std::shared_ptr<ICv2xRxSubscription> rxSub, telux::common::ErrorCode error)>

This function is called as a response to createRxSubscription.

Parameters

[in]	rxSub	- Rx Subscription
[in]	error	- Indicates whether socket creation succeeded SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::CreateTxSpsFlowCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txSpsFlow, std::shared_ptr<ICv2xTxFlow> txEventFlow, telux::common::ErrorCode spsError, telux::common::ErrorCode eventError)>

This function is called as a response to createTxSpsFlow

Parameters

[in]	spsFlow	- Sps flow
[in]	eventFlow	- Optional event flow. Will be nullptr if event flow was not specified in the request
[in]	error	- Indicates whether Tx SPS flow creation succeeded SUCCESS GENERIC_FAILURE
[in]	error	- Indicates whether optional Tx Event flow creation succeeded SUCCESS

Note

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

using telux::cv2x::CreateTxEventFlowCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txEventFlow, telux::common::ErrorCode error)>

This function is called with the response to createTxEventFlow

Parameters

[in]	txEventFlow	- Event flow
[in]	error	- Indicates whether Tx event flow creation succeeded SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::CloseTxFlowCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txFlow, telux::common::ErrorCode error)>

This function is called with the response to closeTxFlow.

Parameters

[in]	txFlow	- Closed tx flow
[in]	error	- Indicates whether close operation succeeded SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::CloseRxSubscriptionCallback = typedef std::function<void (std::shared_ptr<ICv2xRxSubscription> rxSub, telux::common::ErrorCode error)>

This function is called with the response to closeRxSubscription.

Parameters

[in]	rxSub	- Closed rx subscription
[in]	error	- Indicates whether Rx subscription close succeeded SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::ChangeSpsFlowInfoCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txFlow, telux::common::ErrorCode error)>

This function is called with the response to changeSpsFlowInfo.

Parameters

[in]	txFlow	- Sps flow that requested reservation change
[in]	error	- SUCCESS if Tx reservation change succeeded SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::RequestSpsFlowInfoCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txFlow, const SpsFlowInfo & spsInfo, telux::common::ErrorCode error)>

This function is called with the response to requestSpsFlowInfo.

Parameters

[in]	txFlow	- SPS flow that requested info
[in]	spsInfo	- SPS flow reservation info
[in]	error	- SUCCESS if Tx reservation change succeeded SUCCESS GENERIC_FAILURE

Note

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

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

This function is called with the response to updateSrcL2Info.

Parameters

[in]

error

- SUCCESS if Tx reservation change succeeded SUCCESS GENERIC_FAILURE

Note

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

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

This function is called as a response to startCv2x

Parameters

[in]

error

- SUCCESS if Cv2x mode successfully started SUCCESS GENERIC_FAILURE

Note

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

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

This function is called as a response to stopCv2x

Parameters

[in]

error

- SUCCESS if Cv2x mode successfully stopped SUCCESS GENERIC_FAILURE

Note

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

using telux::cv2x::RequestCv2xStatusCallback = typedef std::function<void (Cv2xStatus status, telux::common::ErrorCode error)>

This function is called as a response to requestCv2xStatus

Parameters

[in]	status	- Cv2x status
[in]	error	- SUCCESS if Cv2x status was successully retrieved SUCCESS GENERIC_FAILURE

Note

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

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

This function is called with the response to updateConfiguration

Parameters

[in]

error

- SUCCESS if configuration was updated successfully SUCCESS GENERIC_FAILURE

Note

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