Data Structures
class	telux::cv2x::Cv2xFactory
	Cv2xFactory is the factory that creates the Cv2x Radio. More...

class	telux::cv2x::ICv2xRadio

class	telux::cv2x::ICv2xRadioListener
	Listeners for Cv2xRadio must implement this interface. More...

class	telux::cv2x::ICv2xRadioManager
	Cv2xRadioManager manages instances of Cv2xRadio. More...

struct	telux::cv2x::SocketInfo

struct	telux::cv2x::Cv2xStatus

struct	telux::cv2x::Cv2xPoolStatus

struct	telux::cv2x::Cv2xStatusEx

struct	telux::cv2x::TxPoolIdInfo

struct	telux::cv2x::EventFlowInfo

struct	telux::cv2x::SpsFlowInfo

struct	telux::cv2x::Cv2xRadioCapabilities

struct	telux::cv2x::MacDetails

struct	telux::cv2x::SpsSchedulingInfo

struct	telux::cv2x::TrustedUEInfo

struct	telux::cv2x::TrustedUEInfoList

struct	telux::cv2x::IPv6Address

struct	telux::cv2x::DataSessionSettings

class	telux::cv2x::ICv2xRxSubscription

class	telux::cv2x::ICv2xTxFlow

class	telux::cv2x::ICv2xTxRxSocket

Enumerations
enum	telux::cv2x::TrafficCategory { telux::cv2x::TrafficCategory::SAFETY_TYPE, telux::cv2x::TrafficCategory::NON_SAFETY_TYPE }

enum	telux::cv2x::Cv2xStatusType { telux::cv2x::Cv2xStatusType::INACTIVE, telux::cv2x::Cv2xStatusType::ACTIVE, telux::cv2x::Cv2xStatusType::SUSPENDED, telux::cv2x::Cv2xStatusType::UNKNOWN }

enum	telux::cv2x::Cv2xCauseType { telux::cv2x::Cv2xCauseType::TIMING, telux::cv2x::Cv2xCauseType::CONFIG, telux::cv2x::Cv2xCauseType::UE_MODE, telux::cv2x::Cv2xCauseType::GEOPOLYGON, telux::cv2x::Cv2xCauseType::UNKNOWN }

enum	telux::cv2x::TrafficIpType { telux::cv2x::TrafficIpType::TRAFFIC_IP, telux::cv2x::TrafficIpType::TRAFFIC_NON_IP }

enum	telux::cv2x::RadioConcurrencyMode { telux::cv2x::RadioConcurrencyMode::WWAN_NONCONCURRENT, telux::cv2x::RadioConcurrencyMode::WWAN_CONCURRENT }

enum	telux::cv2x::Cv2xEvent { telux::cv2x::Cv2xEvent::CV2X_INACTIVE, telux::cv2x::Cv2xEvent::CV2X_ACTIVE, telux::cv2x::Cv2xEvent::TX_SUSPENDED, telux::cv2x::Cv2xEvent::TXRX_SUSPENDED }

enum	telux::cv2x::Priority { telux::cv2x::Priority::MOST_URGENT, telux::cv2x::Priority::PRIORITY_1, telux::cv2x::Priority::PRIORITY_2, telux::cv2x::Priority::PRIORITY_3, telux::cv2x::Priority::PRIORITY_4, telux::cv2x::Priority::PRIORITY_5, telux::cv2x::Priority::PRIORITY_6, telux::cv2x::Priority::PRIORITY_BACKGROUND, telux::cv2x::Priority::PRIORITY_UNKNOWN }

enum	telux::cv2x::Periodicity { telux::cv2x::Periodicity::PERIODICITY_10MS, telux::cv2x::Periodicity::PERIODICITY_20MS, telux::cv2x::Periodicity::PERIODICITY_50MS, telux::cv2x::Periodicity::PERIODICITY_100MS, telux::cv2x::Periodicity::PERIODICITY_UNKNOWN }

Detailed Description

This section contains APIs related to Cellular-V2X operation.

Data Structure Documentation

class telux::cv2x::Cv2xFactory

Cv2xFactory is the factory that creates the Cv2x Radio.

Public Member Functions
std::shared_ptr< ICv2xRadioManager >	getCv2xRadioManager ()

Static Public Member Functions
static Cv2xFactory &	getInstance ()

Member Function Documentation

static Cv2xFactory& telux::cv2x::Cv2xFactory::getInstance ( )

static

Get Cv2xFactory instance

Returns: Reference to Cv2xFactory singleton.

std::shared_ptr<ICv2xRadioManager> telux::cv2x::Cv2xFactory::getCv2xRadioManager ( )

Get Cv2xRadioManager instance.

Returns: shared pointer to Radio upon success. nullptr otherwise.

class telux::cv2x::ICv2xRadio

This is class encapsulates a Cv2xRadio interface.

Returned from getCv2xRadio in Cv2xFactory

Public Member Functions
virtual Cv2xRadioCapabilities	getCapabilities () const =0

virtual bool	isReady () const =0

virtual std::future< telux::common::Status >	onReady ()=0

virtual telux::common::Status	registerListener (std::weak_ptr< ICv2xRadioListener > listener)=0

virtual telux::common::Status	deregisterListener (std::weak_ptr< ICv2xRadioListener > listener)=0

virtual telux::common::Status	createRxSubscription (TrafficIpType ipType, uint16_t port, CreateRxSubscriptionCallback cb, std::shared_ptr< std::vector< uint32_t >> idList=nullptr)=0

virtual telux::common::Status	createTxSpsFlow (TrafficIpType ipType, uint32_t serviceId, const SpsFlowInfo &spsInfo, uint16_t spsSrcPort, bool eventSrcPortValid, uint16_t eventSrcPort, CreateTxSpsFlowCallback cb)=0

virtual telux::common::Status	createTxEventFlow (TrafficIpType ipType, uint32_t serviceId, uint16_t eventSrcPort, CreateTxEventFlowCallback cb)=0

virtual telux::common::Status	createTxEventFlow (TrafficIpType ipType, uint32_t serviceId, const EventFlowInfo &flowInfo, uint16_t eventSrcPort, CreateTxEventFlowCallback cb)=0

virtual telux::common::Status	closeRxSubscription (std::shared_ptr< ICv2xRxSubscription > rxSub, CloseRxSubscriptionCallback cb)=0

virtual telux::common::Status	closeTxFlow (std::shared_ptr< ICv2xTxFlow > txFlow, CloseTxFlowCallback cb)=0

virtual telux::common::Status	changeSpsFlowInfo (std::shared_ptr< ICv2xTxFlow > txFlow, const SpsFlowInfo &spsInfo, ChangeSpsFlowInfoCallback cb)=0

virtual telux::common::Status	requestSpsFlowInfo (std::shared_ptr< ICv2xTxFlow > txFlow, RequestSpsFlowInfoCallback cb)=0

virtual telux::common::Status	changeEventFlowInfo (std::shared_ptr< ICv2xTxFlow > txFlow, const EventFlowInfo &flowInfo, ChangeEventFlowInfoCallback cb)=0

virtual telux::common::Status	requestCapabilities (RequestCapabilitiesCallback cb)=0

virtual telux::common::Status	requestDataSessionSettings (RequestDataSessionSettingsCallback cb)=0

virtual telux::common::Status	updateSrcL2Info (UpdateSrcL2InfoCallback cb)=0

virtual telux::common::Status	updateTrustedUEList (const TrustedUEInfoList &infoList, UpdateTrustedUEListCallback cb)=0

virtual	~ICv2xRadio ()

virtual std::string	getIfaceNameFromIpType (TrafficIpType ipType)=0

virtual telux::common::Status	createCv2xTcpSocket (const EventFlowInfo &eventInfo, const SocketInfo &sockInfo, CreateTcpSocketCallback cb)=0

virtual telux::common::Status	closeCv2xTcpSocket (std::shared_ptr< ICv2xTxRxSocket > sock, CloseTcpSocketCallback cb)=0

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xRadio::~ICv2xRadio ( )

virtual

Destructor for ICv2xRadio

Member Function Documentation

virtual Cv2xRadioCapabilities telux::cv2x::ICv2xRadio::getCapabilities ( ) const

pure virtual

Get the capabilities of this Cv2xRadio.

Returns: Cv2xRadioCapabilities - Contains capabilities of this Cv2xRadio.

Deprecated:: Use requestCapabilities() API

virtual bool telux::cv2x::ICv2xRadio::isReady ( ) const

pure virtual

Returns true if the radio interface has completed initialization.

Returns: True if ready. False otherwise.

virtual std::future<telux::common::Status> telux::cv2x::ICv2xRadio::onReady ( )

pure virtual

Returns a future that indicated if the radio interface is ready or if radio failed to initialize.

Returns: SUCCESS if Cv2xRadio initialization was successful. Otherwise it returns an Error Code.

virtual telux::common::Status telux::cv2x::ICv2xRadio::registerListener ( std::weak_ptr< ICv2xRadioListener > listener )

pure virtual

Registers a listener for this Cv2xRadio.

Parameters

[in] listener - Listener that implements Cv2xRadioListener interface.

virtual telux::common::Status telux::cv2x::ICv2xRadio::deregisterListener ( std::weak_ptr< ICv2xRadioListener > listener )

pure virtual

Deregisters a listener from this Cv2xRadio.

Parameters

[in] listener - Previously registered Cv2xRadioListener that is to be deregistered.

virtual telux::common::Status telux::cv2x::ICv2xRadio::createRxSubscription	(	TrafficIpType	ipType,
		uint16_t	port,
		CreateRxSubscriptionCallback	cb,
		std::shared_ptr< std::vector< uint32_t >>	idList = `nullptr`
	)

pure virtual

Creates and initializes a new Rx subscription which will be returned in the user-supplied callback.

Parameters

[in]	ipType	- IP traffic type (IP or NON-IP)
[in]	port	- Rx port number
[in]	cb	- Callback function that is invoked when socket creation is complete.
[in]	idList	- Service ID list to subscribe, optional parameter using nullptr by default. Subscribe wildcard if this parameter is set to nullptr.

Returns: SUCCESS on success. Error status otherwise.

Dependencies The interface must be pre-initialized with init().

virtual telux::common::Status telux::cv2x::ICv2xRadio::createTxSpsFlow	(	TrafficIpType	ipType,
		uint32_t	serviceId,
		const SpsFlowInfo &	spsInfo,
		uint16_t	spsSrcPort,
		bool	eventSrcPortValid,
		uint16_t	eventSrcPort,
		CreateTxSpsFlowCallback	cb
	)

pure virtual

Creates a Tx SPS flow with the specified IP type, serviceId, and other parameters specified in reservation. Additionally, an option event flow will be created with the same IP type and serviceId. A Tx socket will be created and initialized for the SPS flow. A Tx socket will be created and initialized for the event flow if the optional event flow is specified.

Parameters

[in]	ipType	- IP traffic type (IP or NON-IP)
[in]	serviceId	- ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID.
[in]	spsInfo	- SPS reservation parameters.
[in]	spsPort	- Requested source port number for the bandwidth reserved SPS transmissions.
[in]	eventSrcPortValid	- True if an optional event flow is desired. If this field is left false, the event flow will not be created.
[in]	eventSrcPort	- Requested source port number for the optional event flow.
[in]	cb	- Callback function that is invoked when socket creation is complete. This must not be null.

This caller is expected to identify two unused local port numbers: to use for binding: one for the event-driven flow and one for the SPS flow.

Returns: SUCCESS upon success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadio::createTxEventFlow	(	TrafficIpType	ipType,
		uint32_t	serviceId,
		uint16_t	eventSrcPort,
		CreateTxEventFlowCallback	cb
	)

pure virtual

Creates an event flow. An associated Tx socket will be created and initialized.

Parameters

[in]	ipType	- IP traffic type (IP or NON-IP)
[in]	serviceId	- ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID.
[in]	eventSrcPort	- Local port number to which the socket is bound. Used for transmissions of this ID.
[in]	cb	- Callback function that is invoked when socket creation is complete. This must not be null.

Detailed description This function is used only for TX when no periodicity is: available for the application type. If your transmit data periodicity is known, use createTxSpsFlow() instead.

These even-driven sockets pay attention to the QoS parameters in: the IP socket.

Returns: SUCCESS upon success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadio::createTxEventFlow	(	TrafficIpType	ipType,
		uint32_t	serviceId,
		const EventFlowInfo &	flowInfo,
		uint16_t	eventSrcPort,
		CreateTxEventFlowCallback	cb
	)

pure virtual

Creates an event flow. An associated Tx socket will be created and initialized.

Parameters

[in]	ipType	- IP traffic type (IP or NON-IP)
[in]	serviceId	- ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID.
[in]	flowInfo	- Flow configuration parameters
[in]	eventSrcPort	- Local port number to which the socket is bound. Used for transmissions of this ID.
[in]	cb	- Callback function that is invoked when socket creation is complete. This must not be null.

Detailed description This function is used only for TX when no periodicity is: available for the application type. If your transmit data periodicity is known, use createTxSpsFlow() instead.

These even-driven sockets pay attention to the QoS parameters in: the IP socket.

Returns: SUCCESS upon success. Error status otherwise.

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

virtual telux::common::Status telux::cv2x::ICv2xRadio::closeRxSubscription	(	std::shared_ptr< ICv2xRxSubscription >	rxSub,
		CloseRxSubscriptionCallback	cb
	)

pure virtual

Closes the RxSubscription and frees resources (such as the Rx socket) associated with it.

Parameters

[in]	rxSub	- RxSubscription to close
[in]	cb	- Callback that is invoked when socket close is complete. This may be null.

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::closeTxFlow	(	std::shared_ptr< ICv2xTxFlow >	txFlow,
		CloseTxFlowCallback	cb
	)

pure virtual

Closes the TxFlow and frees resources associated with it (such as reserved SPS bandwidth contracts and sockets). This function works on both SPS and event flows.

Parameters

[in]	txFlow	- Tx (SPS or event) flow to close.
[in]	cb	- Callback that is invoked when Tx flow close is complete. This may be null.

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::changeSpsFlowInfo	(	std::shared_ptr< ICv2xTxFlow >	txFlow,
		const SpsFlowInfo &	spsInfo,
		ChangeSpsFlowInfoCallback	cb
	)

pure virtual

Request to change TX SPS Flow reservation parameters.

Parameters

[in]	txFlow	- Tx SPS flow
[in]	spsInfo	- Desired SPS reservation parameters
[in]	cb	- Callback that is invoked upon reservation change. This may be null.

Detailed description: This function does not update reservation priority

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::requestSpsFlowInfo	(	std::shared_ptr< ICv2xTxFlow >	txFlow,
		RequestSpsFlowInfoCallback	cb
	)

pure virtual

Request SPS flow info.

Parameters

[in]	sock	- Tx SPS flow
[in]	cb	- Callback that will be invoked and returns the SPS info. Must not be null.

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::changeEventFlowInfo	(	std::shared_ptr< ICv2xTxFlow >	txFlow,
		const EventFlowInfo &	flowInfo,
		ChangeEventFlowInfoCallback	cb
	)

pure virtual

Request to change TX Event Flow reservation parameters.

Parameters

[in]	txFlow	- Tx Event flow
[in]	flowInfo	- Desired Event flow parameters
[in]	cb	- Callback that is invoked upon parameter change. This may be null.

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::requestCapabilities ( RequestCapabilitiesCallback cb )

pure virtual

Request modem Cv2x capability information.

Parameters

[in] cb - Callback that will be invoked and returns the capability info. Must not be null.

Returns: SUCCESS if no error occurred.

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

virtual telux::common::Status telux::cv2x::ICv2xRadio::requestDataSessionSettings ( RequestDataSessionSettingsCallback cb )

pure virtual

Request data session settings currently in use.

Parameters

[in] cb - Callback that will be invoked and returns the data session settings. Must not be null.

Returns: SUCCESS if no error occurred.

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

virtual telux::common::Status telux::cv2x::ICv2xRadio::updateSrcL2Info ( UpdateSrcL2InfoCallback cb )

pure virtual

Requests modem to change L2 info.

Parameters

[in] cb - Callback that will be invoked and returns status. Must not be null.

Returns: SUCCESS if no error occurred.

virtual telux::common::Status telux::cv2x::ICv2xRadio::updateTrustedUEList	(	const TrustedUEInfoList &	infoList,
		UpdateTrustedUEListCallback	cb
	)

pure virtual

Send request to modem to update the list of malicious UE source IDs and trusted UE source IDs with corresponding confidence information.

Parameters

[in]	infoList	- Trusted and malicious UE information list
[in]	cb	- Callback that will be invoked and returns status. Must not be null.

Returns: SUCCESS if no error occurred.

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

virtual std::string telux::cv2x::ICv2xRadio::getIfaceNameFromIpType ( TrafficIpType ipType )

pure virtual

Get interface name based on ipType.

Parameters

ipType - IP traffic type (IP or NON-IP)

Returns: Interface name as a string

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

virtual telux::common::Status telux::cv2x::ICv2xRadio::createCv2xTcpSocket	(	const EventFlowInfo &	eventInfo,
		const SocketInfo &	sockInfo,
		CreateTcpSocketCallback	cb
	)

pure virtual

Creates a CV2X TCP socket with specified event flow information and TCP socket information. The TCP socket will be created and bound to the IPv6 address of local IP interface with specifed source port. Additionally, this API also registers a Tx event flow and subscribes Rx with specified service ID. If the created socket is expected to work as TCP client mode, the caller must connect the created socket to a destination using connect() and then use the socket for send() and recv() on successful connection. If the created socket is expected to work as TCP server mode, the caller must mark this socket as a listening socket using listen() and accept connections received from this listening socket using accept(), and then use the accepted sockets returned from accept() for send() or recv().

Parameters

[in]	eventInfo	- Information for the Event flow.
[in]	sockInfo	- Information for the TCP socket.
[in]	cb	- Callback function that is invoked when socket creation is complete. This must not be null.

The caller is expected to identify an unused local port number as the source: port number in structure SocketInfo to use for binding.

The caller must release the created socket and associated resources with: closeCv2xTcpSocket. Additionally, if the created socket is marked as a listening socket, the caller must close all the accepted sockets returned by accept() using close() first, and then release the listening socket and associated resources by calling closeCv2xTcpSocket.

Returns: SUCCESS upon success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadio::closeCv2xTcpSocket	(	std::shared_ptr< ICv2xTxRxSocket >	sock,
		CloseTcpSocketCallback	cb
	)

pure virtual

Closes the CV2X TCP socket and frees resources associated with it (such as registered event Tx flow and subscribed Rx service ID and created TCP socket).

Parameters

[in]	sock	- CV2X TCP socket to close.
[in]	cb	- Callback that is invoked when CV2X TCP socket close is complete. This may be null.

Returns: SUCCESS if no error occurred.

class telux::cv2x::ICv2xRadioListener

Listeners for Cv2xRadio must implement this interface.

Public Member Functions
virtual void	onStatusChanged (Cv2xStatus status)

virtual void	onStatusChanged (Cv2xStatusEx status)

virtual void	onL2AddrChanged (uint32_t newL2Address)

virtual void	onSpsOffsetChanged (int spsId, MacDetails details)

virtual void	onSpsSchedulingChanged (const SpsSchedulingInfo &schedulingInfo)

virtual void	onCapabilitiesChanged (const Cv2xRadioCapabilities &capabilities)

virtual	~ICv2xRadioListener ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xRadioListener::~ICv2xRadioListener ( )

virtual

Destructor for ICv2xRadioListener

Member Function Documentation

virtual void telux::cv2x::ICv2xRadioListener::onStatusChanged ( Cv2xStatus status )

virtual

Called when the status of the CV2X radio has changed.

Parameters

[in] status - CV2X radio status.

Deprecated:: use onStatusChanged in Cv2xListener

virtual void telux::cv2x::ICv2xRadioListener::onStatusChanged ( Cv2xStatusEx status )

virtual

Called when the status of the CV2X radio has changed.

Parameters

[in] status - CV2X radio status.

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

Deprecated:: use onStatusChanged in Cv2xListener

virtual void telux::cv2x::ICv2xRadioListener::onL2AddrChanged ( uint32_t newL2Address )

virtual

Called when the L2 Address has changed.

Parameters

[in] newL2Address - The new L2 address.

virtual void telux::cv2x::ICv2xRadioListener::onSpsOffsetChanged	(	int	spsId,
		MacDetails	details
	)

virtual

Called when SPS offset has changed.

Parameters

[in]	spsId	- SPS Id of the SPS flow
[in]	details	- new SPS MAC PHY details.

Deprecated:: use onSpsSchedulingChanged

virtual void telux::cv2x::ICv2xRadioListener::onSpsSchedulingChanged ( const SpsSchedulingInfo & schedulingInfo )

virtual

Called when SPS scheduling has changed.

Parameters

[in] schedulingInfo - SPS scheduling information .

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::ICv2xRadioListener::onCapabilitiesChanged ( const Cv2xRadioCapabilities & capabilities )

virtual

Called when Cv2x radio capabilities have changed.

Parameters

[in] capabilities - Capabilities of the CV2X radio .

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

class telux::cv2x::ICv2xRadioManager

Cv2xRadioManager manages instances of Cv2xRadio.

Public Member Functions
virtual bool	isReady ()=0

virtual std::future< bool >	onReady ()=0

virtual std::shared_ptr< ICv2xRadio >	getCv2xRadio (TrafficCategory category)=0

virtual telux::common::Status	startCv2x (StartCv2xCallback cb)=0

virtual telux::common::Status	stopCv2x (StopCv2xCallback cb)=0

virtual telux::common::Status	requestCv2xStatus (RequestCv2xStatusCallback cb)=0

virtual telux::common::Status	requestCv2xStatus (RequestCv2xStatusCallbackEx cb)=0

virtual telux::common::Status	registerListener (std::weak_ptr< ICv2xListener > listener)=0

virtual telux::common::Status	deregisterListener (std::weak_ptr< ICv2xListener > listener)=0

virtual telux::common::Status	updateConfiguration (const std::string &configFilePath, UpdateConfigurationCallback cb)=0

virtual	~ICv2xRadioManager ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xRadioManager::~ICv2xRadioManager ( )

virtual

Member Function Documentation

virtual bool telux::cv2x::ICv2xRadioManager::isReady ( )

pure virtual

Checks if the Cv2x Radio Manager is ready.

Returns: True if Cv2x Radio Manager is ready for service, otherwise returns false.

virtual std::future<bool> telux::cv2x::ICv2xRadioManager::onReady ( )

pure virtual

Wait for Cv2x Radio Manager to be ready.

Returns: A future that caller can wait on to be notified when Cv2x Radio Manager is ready.

virtual std::shared_ptr<ICv2xRadio> telux::cv2x::ICv2xRadioManager::getCv2xRadio ( TrafficCategory category )

pure virtual

Get Cv2xRadio instance

Parameters

[in] category - Specifies the category of the client application. This field is currently unused.

Returns: Reference to Cv2xRadio interface that corresponds to the Cv2x Traffic Category specified.

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::startCv2x ( StartCv2xCallback cb )

pure virtual

Put modem into CV2X mode.

Parameters

[in] cb - Callback that is invoked when Cv2x mode is started

Returns: SUCCESS on success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::stopCv2x ( StopCv2xCallback cb )

pure virtual

Take modem outo of CV2X mode

Parameters

[in] cb - Callback that is invoked when Cv2x mode is stopped

Returns: SUCCESS on success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::requestCv2xStatus ( RequestCv2xStatusCallback cb )

pure virtual

request CV2X status from modem

Parameters

[in] cb - Callback that is invoked when Cv2x status is retrieved

Returns: SUCCESS on success. Error status otherwise.

Deprecated:: use requestCv2xStatus(RequestCv2xCalbackEx)

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::requestCv2xStatus ( RequestCv2xStatusCallbackEx cb )

pure virtual

request CV2X status from modem

Parameters

[in] cb - Callback that is invoked when Cv2x status is retrieved

Returns: SUCCESS on success. Error status otherwise.

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::registerListener ( std::weak_ptr< ICv2xListener > listener )

pure virtual

Registers a listener for this manager.

Parameters

[in] listener - Listener that implements Cv2xListener interface.

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

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::deregisterListener ( std::weak_ptr< ICv2xListener > listener )

pure virtual

Deregisters a Cv2xListener for this manager.

Parameters

[in] listener - Previously registered CvListener that is to be deregistered.

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

virtual telux::common::Status telux::cv2x::ICv2xRadioManager::updateConfiguration	(	const std::string &	configFilePath,
		UpdateConfigurationCallback	cb
	)

pure virtual

Updates CV2X configuration. Requires CV2X TX/RX radio status be Inactive. If CV2X radio status is Active or Suspended, call stopCv2x before updateConfiguration.

Parameters

[in]	configFilePath	- Path to config file.
[in]	cb	- Callback that is invoked when the send is complete. This may be null.

struct telux::cv2x::SocketInfo

Encapsulates parameters of a CV2X socket.

Used in createCv2xTcpSocket.

Data Fields
uint32_t	serviceId	V2X service ID bound to the socket.
uint16_t	localPort	Local port number of the socket used for binding.

struct telux::cv2x::Cv2xStatus

Encapsulates status of CV2X radio.

Used in Cv2xRadioManager:requestV2xStatus and Cv2xRadioListener.

Data Fields
Cv2xStatusType	rxStatus	RX status
Cv2xStatusType	txStatus	TX status
Cv2xCauseType	rxCause	RX cause of failure
Cv2xCauseType	txCause	TX cause of failure
uint8_t	cbrValue	Channel Busy Ratio
bool	cbrValueValid	CBR value is valid

struct telux::cv2x::Cv2xPoolStatus

Encapsulates status for single pool.

Used in Cv2xStatusEx.

Data Fields
uint8_t	poolId	pool ID
Cv2xStatus	status	status

struct telux::cv2x::Cv2xStatusEx

Encapsulates status of CV2X radio and per pool status.

Used in Cv2xRadioManager:requestV2xStatus and Cv2xRadioListener.

Data Fields
Cv2xStatus	status	Overall Cv2x status
vector< Cv2xPoolStatus >	poolStatus	Multi pool status vector
bool	timeUncertaintyValid	Time uncertainty value is valid
float	timeUncertainty	Time uncertainty value in milleseconds

struct telux::cv2x::TxPoolIdInfo

Contains minimum and maximum frequency for a given TX pool ID. Multiple TX Pools allow the same radio and overall frequency range to be shared for multiple types of traffic like V2V and V2X. Each pool ID and frequency range corresponds to a certain type of traffic.

Used in Cv2xRadioCapabilities

Data Fields
uint8_t	poolId	TX pool ID.
uint16_t	minFreq	Minimum frequency in MHz.
uint16_t	maxFreq	Maximum frequency in MHz.

struct telux::cv2x::EventFlowInfo

Contains event flow configuration parameters.

Used in createTxEventFlow

Data Fields
bool	autoRetransEnabledValid	Set to true if autoRetransEnabled field is specified. If false, the system will use the default setting.
bool	autoRetransEnabled	Used to enable automatic-retransmissions.
bool	peakTxPowerValid	Set to true if peakTxPower is used. If false, the system will use the default setting.
int32_t	peakTxPower	Max Tx power setting in dBm.
bool	mcsIndexValid	Set to true if mcsIndex is used. If false, the system will use its default setting.
uint8_t	mcsIndex	Modulation and Coding Scheme Index to use.
bool	txPoolIdValid	Set to true if txPoolId is used. If false, the system will use its default setting.
uint8_t	txPoolId	Transmission Pool ID.

struct telux::cv2x::SpsFlowInfo

Used to request the QoS bandwidth contract, implemented in PC5 3GPP V2X radio as a Semi Persistent Flow (SPS).

The underlying radio providing the interface might support periodicities of various granularity in 100ms integer multiples (e.g. 200ms, 300ms).

Used in txSpsCreateAndBindSock and changeSpsFlowInfo

Data Fields
Priority	priority	Specifies one of the 3GPP levels of Priority for the traffic that is pre-reserved on the SPS flow. Default is PRIORITY_2. Use getCapabilities() to discover the supported priority levels. : periodicity, Use new periodicityMs instead
Periodicity	periodicity
uint64_t	periodicityMs	This is the new interface to specify periodicity in milliseconds for SpsFlowInfo. Enum Periodicity is deprecated and will be removed in future release.Bandwidth-reserved periodicity interval in interval in milliseconds. There are limits on which intervals the underlying radio supports. Use getCapabilities() to discover minPeriodicityMultiplierMs and maximumPeriodicityMs.
uint32_t	nbytesReserved	Number of bytes of TX bandwidth that are sent every periodicity interval.
bool	autoRetransEnabledValid	Set to true if autoRetransEnabled field is specified. If false, the system will use the default setting.
bool	autoRetransEnabled	Used to enable automatic-retransmissions.
bool	peakTxPowerValid	Set to true if peakTxPower is used. If false, the system will use the default setting.
int32_t	peakTxPower	Max Tx power setting in dBm.
bool	mcsIndexValid	Set to true if mcsIndex is used. If false, the system will use its default setting.
uint8_t	mcsIndex	Modulation and Coding Scheme Index to use.
bool	txPoolIdValid	Set to true if txPoolId is used. If false, the system will use its default setting.
uint8_t	txPoolId	Transmission Pool ID.

struct telux::cv2x::Cv2xRadioCapabilities

Contains capabilities of the Cv2xRadio.

Used in requestCapabilities and onCapabilitiesChanged

Data Fields
uint32_t	linkIpMtuBytes	Maximum data payload length (in bytes) of a packet supported by the IP Radio interface.
uint32_t	linkNonIpMtuBytes	Maximum data payload length (in bytes) of a packet supported by the non-IP Radio interface.
RadioConcurrencyMode	maxSupportedConcurrency	Indicates whether this interface supports concurrent WWAN with V2X (PC5).
uint16_t	nonIpTxPayloadOffsetBytes	Byte offset in a non-IP Tx packet before the actual payload begins.
uint16_t	nonIpRxPayloadOffsetBytes	Byte offset in a non-IP Rx packet before the actual payload begins. : periodicitiesSupported, Use new periodicities instead
bitset< 8 >	periodicitiesSupported
vector< uint64_t >	periodicities	Specifies the periodicities supported
uint8_t	maxNumAutoRetransmissions	Least frequent bandwidth periodicity that is supported. Above this value, use event-driven periodic messages of a period larger than this value.
uint8_t	layer2MacAddressSize	Size of the L2 MAC address. Different Radio Access Technologies have different-sized L2 MAC addresses: 802.11 has 6 bytes, whereas 3GPP PC5 has only 3 bytes. Because a randomized MAC address comes from an HSM with good pseudo random entropy, higher layers must know how many bytes of the MAC address to generate.
bitset< 8 >	prioritiesSupported	Bit set of different priority levels supported by this Cv2xRadio. Refer to Priority
uint16_t	maxNumSpsFlows	Maximum number of supported SPS reservations.
uint16_t	maxNumNonSpsFlows	Maximum number of supported event flows (non-SPS ports).
int32_t	maxTxPower	Maximum supported transmission power.
int32_t	minTxPower	Minimum supported transmission power.
vector< TxPoolIdInfo >	txPoolIdsSupported	Vector of supported transmission pool IDs.

struct telux::cv2x::MacDetails

Contains MAC information that is reported from the actual MAC SPS in the radio. The offsets can periodically change on any given transmission report.

Data Fields
uint32_t	periodicityInUseNs	Actual transmission interval period (in nanoseconds) scheduled relative to 1PP 0:00.00 time
uint16_t	currentlyReservedPeriodicBytes	Actual number of bytes currently reserved at the MAC layer. This number can be slightly larger than original request.
uint32_t	txReservationOffsetNs	Actual offset, from a 1PPS pulse and TX flow periodicity, that the MAC selected and is using for the transmit reservation. If the data goes to the radio with enough time, it can be transmitted on the medium in the next immediately scheduled slot.

struct telux::cv2x::SpsSchedulingInfo

Contains SPS packet scheduling information that is reported from the radio.

Used in onSpsSchedulingChanged

Data Fields
uint8_t	spsId	SPS ID
uint64_t	utcTime	Absolute UTC start time of next selected grant in nanoseconds.
uint32_t	periodicity	Periodicity of the grant in milliseconds.

struct telux::cv2x::TrustedUEInfo

Contains time confidence, position confidence, and propogation delay for a trusted UE.

Used in TrustedUEInfo

Data Fields
uint32_t	sourceL2Id	Trusted Source L2 ID
float	timeUncertainty	Time uncertainty value in milliseconds.
uint16_t	timeConfidenceLevel	Deprecated: Use timeUncertainty Time confidence level. Range from 0 to 127 with 0 being invalid/unavailable and 127 being the most confident.
uint16_t	positionConfidenceLevel	Position confidence level. Range from 0 to 127 with 0 being invalid/unavailable and 127 being the most confident.
uint32_t	propagationDelay	Propagation delay in microseconds.

struct telux::cv2x::TrustedUEInfoList

Contains list of malicious UE source L2 IDs. Contains list of trusted UE source L2 IDs and associated confidence values.

Used in updateTrustedUEList

Data Fields
bool	maliciousIdsValid	Malicious remote UE sources are valid.
vector< uint32_t >	maliciousIds	Malicious remote UE source L2 IDs.
bool	trustedUEsValid	Trusted remote UE sources are valid.
vector< TrustedUEInfo >	trustedUEs	Trusted remote UE sources.

struct telux::cv2x::IPv6Address

Contains IPv6 address.

Used in DataSessionSettings

Data Fields
uint8_t	addr[16]

struct telux::cv2x::DataSessionSettings

Contains packet data session settings.

Used in requestDataSessionSettings

Data Fields
bool	mtuValid	Set to true if mtu is valid.
uint32_t	mtu	MTU size.
bool	ipv6AddrValid	Set to true if ipv6 address is valid.
IPv6Address	ipv6Addr	IPv6 address.

class telux::cv2x::ICv2xRxSubscription

This class encapsulates a Cv2xRadio Rx Subscription. It contains the Rx socket associated with the subscription from which client applications can read data. This class is referenced in Cv2xRadio::createRxSubscription and Cv2xRadio::closeRxSubscription.

Public Member Functions
virtual uint32_t	getSubscriptionId () const =0

virtual TrafficIpType	getIpType () const =0

virtual int	getSock () const =0

virtual struct sockaddr_in6	getSockAddr () const =0

virtual uint16_t	getPortNum () const =0

virtual std::shared_ptr< std::vector< uint32_t > >	getServiceIDList () const =0

virtual void	setServiceIDList (const std::shared_ptr< std::vector< uint32_t >> idList)=0

virtual	~ICv2xRxSubscription ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xRxSubscription::~ICv2xRxSubscription ( )

virtual

Member Function Documentation

virtual uint32_t telux::cv2x::ICv2xRxSubscription::getSubscriptionId ( ) const

pure virtual

Accessor for Rx subscription ID

Returns: subscription ID

virtual TrafficIpType telux::cv2x::ICv2xRxSubscription::getIpType ( ) const

pure virtual

Accessor for IP traffic type

Returns: The Rx subscriptions's IP traffic type (IP or NON-IP)

virtual int telux::cv2x::ICv2xRxSubscription::getSock ( ) const

pure virtual

Accessor for the socket file descriptor

Returns: The Rx subscriptions's socket fd.

virtual struct sockaddr_in6 telux::cv2x::ICv2xRxSubscription::getSockAddr ( ) const

pure virtual

Accessor for the socket address description

Returns: The Rx subscriptions's socket address

virtual uint16_t telux::cv2x::ICv2xRxSubscription::getPortNum ( ) const

pure virtual

Accessor for the subscriptions's port number

Returns: The Rx subscriptions's port num

virtual std::shared_ptr<std::vector<uint32_t> > telux::cv2x::ICv2xRxSubscription::getServiceIDList ( ) const

pure virtual

Get subscriptions's service ID list

Returns: The Rx subscriptions's service ID list

virtual void telux::cv2x::ICv2xRxSubscription::setServiceIDList ( const std::shared_ptr< std::vector< uint32_t >> idList )

pure virtual

Set subscriptions's service ID list

Parameters

[in] idList - the subscriptions's service ID list

class telux::cv2x::ICv2xTxFlow

This is class encapsulates a Cv2xRadio Tx flows. It contains the Tx socket associated with the flow through which client applications can send data. This class is referenced in Cv2xRadio::createTxSpsFlow, Cv2xRadio::createTxEventFlow, and Cv2xRadio::closeTxFlow

Public Member Functions
virtual uint32_t	getFlowId () const =0

virtual TrafficIpType	getIpType () const =0

virtual uint32_t	getServiceId () const =0

virtual int	getSock () const =0

virtual struct sockaddr_in6	getSockAddr () const =0

virtual uint16_t	getPortNum () const =0

virtual	~ICv2xTxFlow ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xTxFlow::~ICv2xTxFlow ( )

virtual

Member Function Documentation

virtual uint32_t telux::cv2x::ICv2xTxFlow::getFlowId ( ) const

pure virtual

Accessor for flow ID. The flow ID should be unique within a process but will not be unique between processes.

Returns: flow ID

virtual TrafficIpType telux::cv2x::ICv2xTxFlow::getIpType ( ) const

pure virtual

Accessor for IP traffic type

Returns: The flow's IP traffic type (IP or NON-IP)

virtual uint32_t telux::cv2x::ICv2xTxFlow::getServiceId ( ) const

pure virtual

Accessor for service ID

Returns: The flow's Service ID.

virtual int telux::cv2x::ICv2xTxFlow::getSock ( ) const

pure virtual

Accessor for the socket file descriptor

Returns: The flow's socket fd.

virtual struct sockaddr_in6 telux::cv2x::ICv2xTxFlow::getSockAddr ( ) const

pure virtual

Accessor for the socket address description

Returns: The flow's socket address

virtual uint16_t telux::cv2x::ICv2xTxFlow::getPortNum ( ) const

pure virtual

Accessor for the flow's source port number

Returns: The flow's source port num

class telux::cv2x::ICv2xTxRxSocket

This is class encapsulates a Cv2xRadio socket for both Tx and Rx. It contains the socket through which client applications can send and receive data. This class is referenced in Cv2xRadio::createCv2xTcpSocket and Cv2xRadio::closeCv2xTcpSocket.

Public Member Functions
virtual uint32_t	getId () const =0

virtual uint32_t	getServiceId () const =0

virtual int	getSocket () const =0

virtual struct sockaddr_in6	getSocketAddr () const =0

virtual uint16_t	getPortNum () const =0

virtual	~ICv2xTxRxSocket ()

Constructor & Destructor Documentation

virtual telux::cv2x::ICv2xTxRxSocket::~ICv2xTxRxSocket ( )

virtual

Member Function Documentation

virtual uint32_t telux::cv2x::ICv2xTxRxSocket::getId ( ) const

pure virtual

Accessor for Cv2xRadio socket ID. The socket ID should be unique within a process but will not be unique between processes.

Returns: Cv2xRadio socket ID

virtual uint32_t telux::cv2x::ICv2xTxRxSocket::getServiceId ( ) const

pure virtual

Accessor for service ID

Returns: The Service ID bound to the socket.

virtual int telux::cv2x::ICv2xTxRxSocket::getSocket ( ) const

pure virtual

Accessor for the socket file descriptor

Returns: The socket fd.

virtual struct sockaddr_in6 telux::cv2x::ICv2xTxRxSocket::getSocketAddr ( ) const

pure virtual

Accessor for the socket address description

Returns: The socket address

virtual uint16_t telux::cv2x::ICv2xTxRxSocket::getPortNum ( ) const

pure virtual

Accessor for the local port number bound to the socket

Returns: The local port number

Enumeration Type Documentation

enum telux::cv2x::TrafficCategory

strong

Defines CV2X Traffic Types.

Used in Cv2xRadioManager::getCv2xRadio

Enumerator
SAFETY_TYPE	Safety message traffic category
NON_SAFETY_TYPE	Non-safety message traffic category

enum telux::cv2x::Cv2xStatusType

strong

Defines possible values for CV2X radio RX/TX status.

Used in Cv2xStatus

Enumerator
INACTIVE	RX/TX is inactive
ACTIVE	RX/TX is active
SUSPENDED	RX/TX is suspended
UNKNOWN	RX/TX status unknown

enum telux::cv2x::Cv2xCauseType

strong

Defines possible values for cause of CV2X radio failure.

Used in Cv2xStatus

Enumerator
TIMING	Timing is invalid
CONFIG	Config is invalid
UE_MODE	UE Mode is invalid
GEOPOLYGON	Left current geopolygon
UNKNOWN	Cause is unknown

enum telux::cv2x::TrafficIpType

strong

Defines CV2X traffic type in terms of IP or NON-IP.

Used in createRxSock, createTxSpsSock, and createTxEventSock

Enumerator
TRAFFIC_IP	IP message traffic
TRAFFIC_NON_IP	NON-IP message traffic

enum telux::cv2x::RadioConcurrencyMode

strong

Defines CV2X modes of concurrency with cellular WWAN.

Used in Cv2xRadioCapabilities

Enumerator
WWAN_NONCONCURRENT	No simultaneous WWAN + CV2X on this interface
WWAN_CONCURRENT	Interface supports requests for concurrent WWAN + CV2X connections.

enum telux::cv2x::Cv2xEvent

strong

Defines CV2X status change events. The state can change in response to the loss of timing precision or a geofencing change.

Used in onStatusChanged in ICv2xRadioListener

Enumerator
CV2X_INACTIVE
CV2X_ACTIVE
TX_SUSPENDED
TXRX_SUSPENDED

enum telux::cv2x::Priority

strong

Range of supported priority levels, where a lower number means a higher priority. For example, 8 is the current 3GPP standard.

Used in Cv2xRadioCapabilities and SpsFlowInfo

Enumerator
MOST_URGENT
PRIORITY_1
PRIORITY_2
PRIORITY_3
PRIORITY_4
PRIORITY_5
PRIORITY_6
PRIORITY_BACKGROUND
PRIORITY_UNKNOWN

enum telux::cv2x::Periodicity

strong

Range of supported periodicities in milliseconds.

Used in Cv2xRadioCapabilities and SpsFlowInfo

: enum class not going to be supported in future releases. Clients should stop using this. Once a class has been marked as Deprecated, the class could be removed in future releases.

Enumerator
PERIODICITY_10MS
PERIODICITY_20MS
PERIODICITY_50MS
PERIODICITY_100MS
PERIODICITY_UNKNOWN

Data Structures

Enumerations

Detailed Description

Data Structure Documentation

Public Member Functions

Static Public Member Functions

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Enumeration Type Documentation