Telematics SDK - Interface Specification  v1.46.10
telux::common Namespace Reference

Data Structures

class  DeviceConfig
 
class  ICommandCallback
 
class  ICommandResponseCallback
 General command response callback for most of the requests, client needs to implement this interface to get single shot response. More...
 
class  IServiceStatusListener
 
class  Log
 
struct  SdkVersion
 
class  Version
 Provides version of SDK. More...
 

Typedefs

using ResponseCallback = std::function< void(telux::common::ErrorCode errorCode)>
 General response callback for most of the requests, client needs to implement this function to get the asynchronous response. More...
 
using InitResponseCb = std::function< void(telux::common::ServiceStatus status)>
 

Enumerations

enum  Status {
  Status::SUCCESS, Status::FAILED, Status::NOCONNECTION, Status::NOSUBSCRIPTION,
  Status::INVALIDPARAM, Status::INVALIDSTATE, Status::NOTREADY, Status::NOTALLOWED,
  Status::NOTIMPLEMENTED, Status::CONNECTIONLOST, Status::EXPIRED, Status::ALREADY,
  Status::NOSUCH, Status::NOTSUPPORTED, Status::NOMEMORY
}
 
enum  ErrorCode {
  ErrorCode::SUCCESS = 0, ErrorCode::RADIO_NOT_AVAILABLE = 1, ErrorCode::GENERIC_FAILURE = 2, ErrorCode::PASSWORD_INCORRECT = 3,
  ErrorCode::SIM_PIN2 = 4, ErrorCode::SIM_PUK2 = 5, ErrorCode::REQUEST_NOT_SUPPORTED = 6, ErrorCode::CANCELLED = 7,
  ErrorCode::OP_NOT_ALLOWED_DURING_VOICE_CALL = 8, ErrorCode::OP_NOT_ALLOWED_BEFORE_REG_TO_NW = 9, ErrorCode::SMS_SEND_FAIL_RETRY = 10, ErrorCode::SIM_ABSENT = 11,
  ErrorCode::SUBSCRIPTION_NOT_AVAILABLE = 12, ErrorCode::MODE_NOT_SUPPORTED = 13, ErrorCode::FDN_CHECK_FAILURE = 14, ErrorCode::ILLEGAL_SIM_OR_ME = 15,
  ErrorCode::MISSING_RESOURCE = 16, ErrorCode::NO_SUCH_ELEMENT = 17, ErrorCode::DIAL_MODIFIED_TO_USSD = 18, ErrorCode::DIAL_MODIFIED_TO_SS = 19,
  ErrorCode::DIAL_MODIFIED_TO_DIAL = 20, ErrorCode::USSD_MODIFIED_TO_DIAL = 21, ErrorCode::USSD_MODIFIED_TO_SS = 22, ErrorCode::USSD_MODIFIED_TO_USSD = 23,
  ErrorCode::SS_MODIFIED_TO_DIAL = 24, ErrorCode::SS_MODIFIED_TO_USSD = 25, ErrorCode::SUBSCRIPTION_NOT_SUPPORTED = 26, ErrorCode::SS_MODIFIED_TO_SS = 27,
  ErrorCode::LCE_NOT_SUPPORTED = 36, ErrorCode::NO_MEMORY = 37, ErrorCode::INTERNAL_ERR = 38, ErrorCode::SYSTEM_ERR = 39,
  ErrorCode::MODEM_ERR = 40, ErrorCode::INVALID_STATE = 41, ErrorCode::NO_RESOURCES = 42, ErrorCode::SIM_ERR = 43,
  ErrorCode::INVALID_ARGUMENTS = 44, ErrorCode::INVALID_SIM_STATE = 45, ErrorCode::INVALID_MODEM_STATE = 46, ErrorCode::INVALID_CALL_ID = 47,
  ErrorCode::NO_SMS_TO_ACK = 48, ErrorCode::NETWORK_ERR = 49, ErrorCode::REQUEST_RATE_LIMITED = 50, ErrorCode::SIM_BUSY = 51,
  ErrorCode::SIM_FULL = 52, ErrorCode::NETWORK_REJECT = 53, ErrorCode::OPERATION_NOT_ALLOWED = 54, ErrorCode::EMPTY_RECORD = 55,
  ErrorCode::INVALID_SMS_FORMAT = 56, ErrorCode::ENCODING_ERR = 57, ErrorCode::INVALID_SMSC_ADDRESS = 58, ErrorCode::NO_SUCH_ENTRY = 59,
  ErrorCode::NETWORK_NOT_READY = 60, ErrorCode::NOT_PROVISIONED = 61, ErrorCode::NO_SUBSCRIPTION = 62, ErrorCode::NO_NETWORK_FOUND = 63,
  ErrorCode::DEVICE_IN_USE = 64, ErrorCode::ABORTED = 65, ErrorCode::INCOMPATIBLE_STATE = 90, ErrorCode::NO_EFFECT = 101,
  ErrorCode::DEVICE_NOT_READY = 102, ErrorCode::MISSING_ARGUMENTS = 103, ErrorCode::PIN_PERM_BLOCKED = 201, ErrorCode::PIN_BLOCKED = 202,
  ErrorCode::MALFORMED_MSG = 1001, ErrorCode::INTERNAL = 1003, ErrorCode::CLIENT_IDS_EXHAUSTED = 1005, ErrorCode::UNABORTABLE_TRANSACTION = 1006,
  ErrorCode::INVALID_CLIENT_ID = 1007, ErrorCode::NO_THRESHOLDS = 1008, ErrorCode::INVALID_HANDLE = 1009, ErrorCode::INVALID_PROFILE = 1010,
  ErrorCode::INVALID_PINID = 1011, ErrorCode::INCORRECT_PIN = 1012, ErrorCode::CALL_FAILED = 1014, ErrorCode::OUT_OF_CALL = 1015,
  ErrorCode::MISSING_ARG = 1017, ErrorCode::ARG_TOO_LONG = 1019, ErrorCode::INVALID_TX_ID = 1022, ErrorCode::OP_NETWORK_UNSUPPORTED = 1024,
  ErrorCode::OP_DEVICE_UNSUPPORTED = 1025, ErrorCode::NO_FREE_PROFILE = 1027, ErrorCode::INVALID_PDP_TYPE = 1028, ErrorCode::INVALID_TECH_PREF = 1029,
  ErrorCode::INVALID_PROFILE_TYPE = 1030, ErrorCode::INVALID_SERVICE_TYPE = 1031, ErrorCode::INVALID_REGISTER_ACTION = 1032, ErrorCode::INVALID_PS_ATTACH_ACTION = 1033,
  ErrorCode::AUTHENTICATION_FAILED = 1034, ErrorCode::SIM_NOT_INITIALIZED = 1037, ErrorCode::MAX_QOS_REQUESTS_IN_USE = 1038, ErrorCode::INCORRECT_FLOW_FILTER = 1039,
  ErrorCode::NETWORK_QOS_UNAWARE = 1040, ErrorCode::INVALID_ID = 1041, ErrorCode::REQUESTED_NUM_UNSUPPORTED = 1042, ErrorCode::INTERFACE_NOT_FOUND = 1043,
  ErrorCode::FLOW_SUSPENDED = 1044, ErrorCode::INVALID_DATA_FORMAT = 1045, ErrorCode::GENERAL = 1046, ErrorCode::UNKNOWN = 1047,
  ErrorCode::INVALID_ARG = 1048, ErrorCode::INVALID_INDEX = 1049, ErrorCode::NO_ENTRY = 1050, ErrorCode::DEVICE_STORAGE_FULL = 1051,
  ErrorCode::CAUSE_CODE = 1054, ErrorCode::MESSAGE_NOT_SENT = 1055, ErrorCode::MESSAGE_DELIVERY_FAILURE = 1056, ErrorCode::INVALID_MESSAGE_ID = 1057,
  ErrorCode::ENCODING = 1058, ErrorCode::AUTHENTICATION_LOCK = 1059, ErrorCode::INVALID_TRANSITION = 1060, ErrorCode::NOT_A_MCAST_IFACE = 1061,
  ErrorCode::MAX_MCAST_REQUESTS_IN_USE = 1062, ErrorCode::INVALID_MCAST_HANDLE = 1063, ErrorCode::INVALID_IP_FAMILY_PREF = 1064, ErrorCode::SESSION_INACTIVE = 1065,
  ErrorCode::SESSION_INVALID = 1066, ErrorCode::SESSION_OWNERSHIP = 1067, ErrorCode::INSUFFICIENT_RESOURCES = 1068, ErrorCode::DISABLED = 1069,
  ErrorCode::INVALID_OPERATION = 1070, ErrorCode::INVALID_QMI_CMD = 1071, ErrorCode::TPDU_TYPE = 1072, ErrorCode::SMSC_ADDR = 1073,
  ErrorCode::INFO_UNAVAILABLE = 1074, ErrorCode::SEGMENT_TOO_LONG = 1075, ErrorCode::SEGMENT_ORDER = 1076, ErrorCode::BUNDLING_NOT_SUPPORTED = 1077,
  ErrorCode::OP_PARTIAL_FAILURE = 1078, ErrorCode::POLICY_MISMATCH = 1079, ErrorCode::SIM_FILE_NOT_FOUND = 1080, ErrorCode::EXTENDED_INTERNAL = 1081,
  ErrorCode::ACCESS_DENIED = 1082, ErrorCode::HARDWARE_RESTRICTED = 1083, ErrorCode::ACK_NOT_SENT = 1084, ErrorCode::INJECT_TIMEOUT = 1085,
  ErrorCode::FDN_RESTRICT = 1091, ErrorCode::SUPS_FAILURE_CAUSE = 1092, ErrorCode::NO_RADIO = 1093, ErrorCode::NOT_SUPPORTED = 1094,
  ErrorCode::CARD_CALL_CONTROL_FAILED = 1096, ErrorCode::NETWORK_ABORTED = 1097, ErrorCode::MSG_BLOCKED = 1098, ErrorCode::INVALID_SESSION_TYPE = 1100,
  ErrorCode::INVALID_PB_TYPE = 1101, ErrorCode::NO_SIM = 1102, ErrorCode::PB_NOT_READY = 1103, ErrorCode::PIN_RESTRICTION = 1104,
  ErrorCode::PIN2_RESTRICTION = 1105, ErrorCode::PUK_RESTRICTION = 1106, ErrorCode::PUK2_RESTRICTION = 1107, ErrorCode::PB_ACCESS_RESTRICTED = 1108,
  ErrorCode::PB_DELETE_IN_PROG = 1109, ErrorCode::PB_TEXT_TOO_LONG = 1110, ErrorCode::PB_NUMBER_TOO_LONG = 1111, ErrorCode::PB_HIDDEN_KEY_RESTRICTION = 1112,
  ErrorCode::PB_NOT_AVAILABLE = 1113, ErrorCode::DEVICE_MEMORY_ERROR = 1114, ErrorCode::NO_PERMISSION = 1115, ErrorCode::TOO_SOON = 1116,
  ErrorCode::TIME_NOT_ACQUIRED = 1117, ErrorCode::OP_IN_PROGRESS = 1118, ErrorCode::DS_PROFILE_REG_RESULT_FAIL = 2001, ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_HNDL = 2002,
  ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_OP = 2003, ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_PROFILE_TYPE = 2004, ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_PROFILE_NUM = 2005, ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_IDENT = 2006,
  ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL = 2007, ErrorCode::DS_PROFILE_REG_RESULT_ERR_LIB_NOT_INITED = 2008, ErrorCode::DS_PROFILE_REG_RESULT_ERR_LEN_INVALID = 2009, ErrorCode::DS_PROFILE_REG_RESULT_LIST_END = 2010,
  ErrorCode::DS_PROFILE_REG_RESULT_ERR_INVAL_SUBS_ID = 2011, ErrorCode::DS_PROFILE_REG_INVAL_PROFILE_FAMILY = 2012, ErrorCode::DS_PROFILE_REG_PROFILE_VERSION_MISMATCH = 2013, ErrorCode::REG_RESULT_ERR_OUT_OF_MEMORY = 2014,
  ErrorCode::DS_PROFILE_REG_RESULT_ERR_FILE_ACCESS = 2015, ErrorCode::DS_PROFILE_REG_RESULT_ERR_EOF = 2016, ErrorCode::REG_RESULT_ERR_VALID_FLAG_NOT_SET = 2017, ErrorCode::REG_RESULT_ERR_OUT_OF_PROFILES = 2018,
  ErrorCode::REG_RESULT_NO_EMERGENCY_PDN_SUPPORT = 2019, ErrorCode::V2X_ERR_EXCEED_MAX = 3000, ErrorCode::V2X_ERR_V2X_DISABLED = 3001, ErrorCode::V2X_ERR_UNKNOWN_SERVICE_ID = 3002,
  ErrorCode::V2X_ERR_SRV_ID_L2_ADDRS_NOT_COMPATIBLE = 3003, ErrorCode::V2X_ERR_PORT_UNAVAIL = 3004, ErrorCode::DS_PROFILE_3GPP_INVAL_PROFILE_FAMILY = 4097, ErrorCode::DS_PROFILE_3GPP_ACCESS_ERR = 4098,
  ErrorCode::DS_PROFILE_3GPP_CONTEXT_NOT_DEFINED = 4099, ErrorCode::DS_PROFILE_3GPP_VALID_FLAG_NOT_SET = 4100, ErrorCode::DS_PROFILE_3GPP_READ_ONLY_FLAG_SET = 4101, ErrorCode::DS_PROFILE_3GPP_ERR_OUT_OF_PROFILES = 4102,
  ErrorCode::DS_PROFILE_3GPP2_ERR_INVALID_IDENT_FOR_PROFILE = 4353, ErrorCode::DS_PROFILE_3GPP2_ERR_OUT_OF_PROFILE = 4354, ErrorCode::INTERNAL_ERROR = -1, ErrorCode::SERVICE_ERROR = -2,
  ErrorCode::TIMEOUT_ERROR = -3, ErrorCode::EXTENDED_ERROR = -4, ErrorCode::PORT_NOT_OPEN_ERROR = -5, ErrorCode::MEMCOPY_ERROR = -13,
  ErrorCode::INVALID_TRANSACTION = -14, ErrorCode::ALLOCATION_FAILURE = -15, ErrorCode::TRANSPORT_ERROR = -16, ErrorCode::PARAM_ERROR = -17,
  ErrorCode::INVALID_CLIENT = -18, ErrorCode::FRAMEWORK_NOT_READY = -19, ErrorCode::INVALID_SIGNAL = -20, ErrorCode::TRANSPORT_BUSY_ERROR = -21,
  ErrorCode::SUBSYSTEM_UNAVAILABLE = 5000, ErrorCode::OPERATION_TIMEOUT = 5001
}
 
enum  ServiceStatus { ServiceStatus::SERVICE_UNAVAILABLE, ServiceStatus::SERVICE_AVAILABLE, ServiceStatus::SERVICE_FAILED }
 Service status. More...
 
enum  ProcType { ProcType::LOCAL_PROC = 0, ProcType::REMOTE_PROC }
 
enum  LogLevel {
  LogLevel::LEVEL_NONE = 1, LogLevel::LEVEL_PERF, LogLevel::LEVEL_ERROR, LogLevel::LEVEL_WARNING,
  LogLevel::LEVEL_INFO, LogLevel::LEVEL_DEBUG
}
 

Typedef Documentation

using telux::common::ResponseCallback = typedef std::function<void(telux::common::ErrorCode errorCode)>

General response callback for most of the requests, client needs to implement this function to get the asynchronous response.

The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.

Parameters
[in]errorCodeErrorCode
using telux::common::InitResponseCb = typedef std::function<void(telux::common::ServiceStatus status)>

This API is invoked when the initialization of an object completes.

Parameters
[in]status- Service status