Telematics SDK - Interface Specification  v1.38.19
Data Structures | Typedefs | Enumerations
telux::cv2x Namespace Reference

Data Structures

struct  ConfigEventInfo
 
class  Cv2xFactory
 Cv2xFactory is the factory that creates the Cv2x Radio. More...
 
struct  Cv2xPoolStatus
 
struct  Cv2xRadioCapabilities
 
struct  Cv2xStatus
 
struct  Cv2xStatusEx
 
struct  DataSessionSettings
 
struct  EventFlowInfo
 
class  ICv2xConfig
 Cv2xConfig provide operations to update or request cv2x configuration. More...
 
class  ICv2xConfigListener
 Listeners for ICv2xConfig must implement this interface. More...
 
class  ICv2xListener
 Cv2x Radio Manager listeners implement this interface. More...
 
class  ICv2xRadio
 
class  ICv2xRadioListener
 Listeners for Cv2xRadio must implement this interface. More...
 
class  ICv2xRadioManager
 Cv2xRadioManager manages instances of Cv2xRadio. More...
 
class  ICv2xRxSubscription
 
class  ICv2xTxFlow
 
class  ICv2xTxRxSocket
 
struct  IPv6Address
 
struct  MacDetails
 
struct  SocketInfo
 
struct  SpsFlowInfo
 
struct  SpsSchedulingInfo
 
struct  TrustedUEInfo
 
struct  TrustedUEInfoList
 
struct  TxPoolIdInfo
 

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 ChangeEventFlowInfoCallback = std::function< void(std::shared_ptr< ICv2xTxFlow > txFlow, telux::common::ErrorCode error)>
 
using RequestCapabilitiesCallback = std::function< void(const Cv2xRadioCapabilities &capabilities, telux::common::ErrorCode error)>
 
using RequestDataSessionSettingsCallback = std::function< void(const DataSessionSettings &settings, telux::common::ErrorCode error)>
 
using UpdateTrustedUEListCallback = std::function< void(telux::common::ErrorCode error)>
 
using UpdateSrcL2InfoCallback = std::function< void(telux::common::ErrorCode error)>
 
using CreateTcpSocketCallback = std::function< void(std::shared_ptr< ICv2xTxRxSocket > sock, telux::common::ErrorCode error)>
 
using CloseTcpSocketCallback = std::function< void(std::shared_ptr< ICv2xTxRxSocket > sock, 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 RequestCv2xStatusCallbackEx = std::function< void(Cv2xStatusEx 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::GEOPOLYGON,
  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
}
 
enum  ConfigSourceType { ConfigSourceType::UNKNOWN = 0u, ConfigSourceType::PRECONFIG = 1u, ConfigSourceType::SIM_CARD = 2u, ConfigSourceType::OMA_DM = 4u }
 
enum  ConfigEvent { ConfigEvent::CHANGED = 0u, ConfigEvent::EXPIRED = 1u }
 

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
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
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
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
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
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
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
using telux::cv2x::ChangeEventFlowInfoCallback = typedef std::function<void (std::shared_ptr<ICv2xTxFlow> txFlow, telux::common::ErrorCode error)>

This function is called with the response to changeEventFlowInfo.

Parameters
[in]txFlow- Event flow that requested reservation change
[in]error- SUCCESS if Tx parameter change succeeded
  • SUCCESS
  • GENERIC_FAILURE
using telux::cv2x::RequestCapabilitiesCallback = typedef std::function<void(const Cv2xRadioCapabilities & capabilities, telux::common::ErrorCode error)>

This function is called with the response to requestCapabilities.

Parameters
[in]capabilities- Capability info
[in]error- SUCCESS if capabilities request succeeded
  • SUCCESS
  • GENERIC_FAILURE
using telux::cv2x::RequestDataSessionSettingsCallback = typedef std::function<void (const DataSessionSettings & settings, telux::common::ErrorCode error)>

This function is called with the response to requestDataSessionSettings.

Parameters
[in]settings- Data session settings
[in]error- SUCCESS if data session settings request succeeded
  • SUCCESS
  • GENERIC_FAILURE
using telux::cv2x::UpdateTrustedUEListCallback = typedef std::function<void(telux::common::ErrorCode error)>

This function is called with the response to updateTrustedUEList.

Parameters
[in]error- SUCCESS if update succeeded
  • INVALID_ARGUMENTS if trustedUEs or maliciousIds length greater than maximum value
  • SUCCESS
  • GENERIC_FAILURE
  • INVALID_ARGUMENTS
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
using telux::cv2x::CreateTcpSocketCallback = typedef std::function<void (std::shared_ptr<ICv2xTxRxSocket> sock, telux::common::ErrorCode error)>

This function is called with the response to createCv2xTcpSocket.

Parameters
[in]sock- TCP socket
[in]error- Indicates whether TCP socket creation succeeded
  • SUCCESS
  • GENERIC_FAILURE
using telux::cv2x::CloseTcpSocketCallback = typedef std::function<void (std::shared_ptr<ICv2xTxRxSocket> sock, telux::common::ErrorCode error)>

This function is called with the response to closeCv2xTcpSocket.

Parameters
[in]sock- Closed TCP socket
[in]error- Indicates whether close operation succeeded
  • SUCCESS
  • GENERIC_FAILURE
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
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
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
Deprecated:
use RequestCv2xStatusCallbackEx
using telux::cv2x::RequestCv2xStatusCallbackEx = typedef std::function<void (Cv2xStatusEx 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
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