Callback Service API function prototypes. More...
Go to the source code of this file.
Callback Service API function prototypes.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
#define CBK_DISABLE_EVENT 0x00 |
#define CBK_ENABLE_EVENT 0x01 |
#define CBK_NOCHANGE 0xFF |
#define MAX_RADIO_INTERFACE_LIST 255 |
#define QMI_WMS_MAX_PAYLOAD_LENGTH 256 |
#define SIGSTRENGTH_THRESHOLD_ARR_SZ 5 |
typedef enum device_state_enum eDevState |
Device State enumeration
typedef enum SMSEventType eSMSEventType |
This enumeration defines the different type of SMS events that are received
typedef union sessionInfo sessionInformation |
This union sessionInfo consist of omaDmFotaTlv and omaDmConfigTlv, out of which one will be unpacked against psessionTypeFields.
typedef struct SMSCAddress SMSCAddressInfo |
This structure holds SMSC information
length |
| |
data |
|
typedef struct SMSEtwsMessage SMSEtwsMessageInfo |
This structure holds information related earthquake and Tsunami warning system
notificationType |
| |
length |
| |
data |
|
typedef struct SMSEtwsPlmn SMSEtwsPlmnInfo |
This structure holds information related ETWS PLMN
mobileCountryCode |
| |
mobileNetworkCode |
|
typedef struct SMSEventInfo_s SMSEventInfo |
This structure will hold the information related to received SMS events
smsEventType |
| |
pMTMessageInfo |
| |
pTransferRouteMTMessageInfo |
| |
pMessageModeInfo |
| |
pEtwsMessageInfo |
| |
pEtwsPlmnInfo |
| |
pSMSCAddressInfo |
| |
pSMSOnIMSInfo |
|
typedef struct SMSMessageMode SMSMessageModeInfo |
This structure holds information related to message mode
messageMode |
|
typedef struct SMSMTMessage SMSMTMessageInfo |
This structure holds information related to MT SMS
storageType |
| |
messageIndex |
|
typedef struct SMSOnIMS SMSOnIMSInfo |
This structure holds information related to message mode
smsOnIMS |
|
typedef struct SMSTransferRouteMTMessage SMSTransferRouteMTMessageInfo |
This structure holds information related to transfer route MT SMS
ackIndicator |
| |
transactionID |
| |
format |
| |
length |
| |
data |
|
typedef void(* tFNActivationStatus)(ULONG activationStatus) |
Activation status callback function.
activationStatus |
|
typedef void(* tFNBandPreference)(ULONGLONG band_pref) |
Band Preference Callback function
pBandPref | - Bit mask representing the current band preference Bit position meanings:
|
typedef void(* tFNByteTotals)(ULONGLONG totalBytesTX, ULONGLONG totalBytesRX) |
RX/TX byte counts callback function.
totalBytesTX |
| |
totalBytesRX |
|
typedef void(* tFNCATEvent)(ULONG eventID, ULONG eventLen, BYTE *pEventData) |
CAT event callback function.
eventID |
| |
eventLen |
| |
pEventData |
|
typedef void(* tFNDataBearer)(ULONG dataBearer) |
Data bearer technology callback function.
dataBearer |
|
typedef void(* tFNDataCapabilities)(BYTE dataCapsSize, BYTE *pDataCaps) |
Serving system data capabilities callback function.
dataCapsSize |
| |
pDataCaps |
|
typedef void(* tFNDeviceStateChange)(eDevState device_state) |
Device State Change callback function prototype
device_state |
|
typedef void(* tFNDormancyStatus)(ULONG dormancyStatus) |
Dormancy status callback function.
dormancyStatus |
|
typedef void(* tFNFwDldCompletion)(ULONG fwdld_completion_status) |
Firmware Download Completion callback function prototype
error_code |
|
typedef void(* tFNLUReject)(ULONG serviceDomain, ULONG rejectCause) |
LU reject callback function.
serviceDomain |
| |
rejectCause |
|
typedef void(* tFNMobileIPStatus)(ULONG mipStatus) |
Mobile IP status callback function.
mipStatus |
|
typedef void(* tFNNewNMEA)(LPCSTR pNMEA) |
New NMEA sentence callback function.
pNMEA |
|
New SMS message callback function.
storageType |
| |
messageIndex |
|
typedef void(* tFNOMADMState)(ULONG sessionState, ULONG failureReason) |
OMA-DM state callback function
sessionState |
| |
failureReason |
|
typedef void(* tFNPacketsCount)(ULONG packetsCountTX, ULONG packetsCountRX) |
RX/TX packets counts callback function.
packetsCountTX |
| |
packetsCountRX |
|
typedef void(* tFNPDSState)(ULONG enabledStatus, ULONG trackingStatus) |
PDS session state callback function.
enabledStatus |
| |
trackingStatus |
|
Power operating mode callback function.
operatingMode |
|
RF information callback function.
radioInterface |
| |
activeBandClass |
| |
activeChannel |
|
typedef void(* tFNRoamingIndicator)(ULONG roaming) |
Roaming indicator callback function.
roaming |
|
typedef void(* tFNSDKTerminated)(BYTE *psReason) |
SDK terminated callback function prototype
psReason |
|
typedef void(* tFNServingSystem)(struct ServingSystemInfo *pServingSystem) |
Serving System callback function
pServingSystem |
|
typedef void(* tFNSessionState)(ULONG state, ULONG reconfiguration_required, ULONG sessionEndReason) |
Session state callback function.
state |
| |
reconfiguration_required |
| |
sessionEndReason |
|
typedef void(* tFNSignalStrength)(INT8 signalStrength, ULONG radioInterface) |
Signal strength callback function.
signalStrength |
| |
radioInterface |
|
typedef void(* tFNSLQSOMADMAlert)(ULONG sessionType, BYTE *psessionTypeFields) |
SWIOMA-DM network-initiated alert callback function
sessionType |
| |
psessionTypeFields |
|
typedef void(* tFNSLQSSignalStrengths)(struct SLQSSignalStrengthsInformation sSLQSSignalStrengthsInfo) |
Received Signal Strength Information callback function.
sSLQSSignalStrengthsInfo |
|
typedef void(* tFNSMSEvents)(SMSEventInfo *pSMSEventInfo) |
SMS event related callback function.
pSMSEventInfo[OUT] |
|
typedef void(* tFNSysSelectionPref)(sysSelectPrefInfo *pSysSelectPrefInfo) |
System Selection Preference Callback function
pSysSelectPrefInfo |
|
typedef void(* tFNtransLayerInfo)(transLayerNotification *pTransLayerNotification) |
Transport Layer Information callback.
transLayerNotification |
|
typedef void(* tFNtransNWRegInfo)(transNWRegInfoNotification *pTransNWRegInfoNotification) |
Transport Network Registration Information callback.
pTransNWRegInfoNotification |
|
typedef void(* tFNUSSDNotification)(ULONG type, BYTE *pNetworkInfo) |
SetUSSDNotificationCallback function prototype
type | - Notification type
| |
pNetworkInfo |
|
typedef void(* tFNUSSDRelease)(void) |
USSD releasecallback function prototype
typedef struct _transLayerInfoNotification transLayerNotification |
Contains the parameters passed for SLQSSetTransLayerInfoCallback by the device.
regInd |
| |
pTransLayerInfo |
|
typedef struct _transNWRegInfoNotification transNWRegInfoNotification |
Contains the parameters passed for SLQSSetTransNWRegInfoCallback by the device.
NWRegStat |
|
enum device_state_enum |
enum SMSEventType |
ULONG iSetByteTotalsCallback | ( | tFNByteTotals | pCallback | ) |
ULONG iSetCATEventCallback | ( | tFNCATEvent | pCallback | ) |
ULONG iSetPacketsCountCallback | ( | tFNPacketsCount | pCallback | ) |
ULONG iSetSignalStrengthCallback | ( | tFNSignalStrength | pCallback | ) |
ULONG iSLQSSetSignalStrengthsCallback | ( | tFNSLQSSignalStrengths | pCallback | ) |
ULONG SetActivationStatusCallback | ( | tFNActivationStatus | pCallback | ) |
Enables/disables the Activation Status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetByteTotalsCallback | ( | tFNByteTotals | pCallback, | |
BYTE | interval | |||
) |
Enables/disables the Byte Totals callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This function cannot be used with function SetPacketsCountCallback in the same time. It means that this callback function (if it is already set) need to be cleared when you want to SetPacketsCountCallback and vice versa.
pCallback[IN] |
| |
interval |
|
ULONG SetCATEventCallback | ( | tFNCATEvent | pCallback, | |
ULONG | eventMask, | |||
ULONG * | pErrorMask | |||
) |
Enables/disables the CAT event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
| |
eventMask |
| |
pErrorMask[OUT] |
|
ULONG SetDataBearerCallback | ( | tFNDataBearer | pCallback | ) |
Enables/disables the Data Bearer state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetDataCapabilitiesCallback | ( | tFNDataCapabilities | pCallback | ) |
Enables/disables the data capabilities callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetDeviceStateChangeCbk | ( | tFNDeviceStateChange | pCallback | ) |
Used by the client application to register a Callback function for Device State Change (DSC) event notifications. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetDormancyStatusCallback | ( | tFNDormancyStatus | pCallback | ) |
Enables/disables the Dormancy Status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetFwDldCompletionCbk | ( | tFNFwDldCompletion | pCallback | ) |
Used by the client application to register a Callback function for a Firmware Download Completion (FDC) event notification. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetLURejectCallback | ( | tFNLUReject | pCallback | ) |
Enables/disables the LU reject callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetMobileIPStatusCallback | ( | tFNMobileIPStatus | pCallback | ) |
Enables/disables the Mobile IP Status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
Enables/disables the new SMS callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetNMEACallback | ( | tFNNewNMEA | pCallback | ) |
Enables/disables the NMEA sentence callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetOMADMStateCallback | ( | tFNOMADMState | pCallback | ) |
Enables/disables the OMADM state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetPacketsCountCallback | ( | tFNPacketsCount | pCallback, | |
BYTE | interval | |||
) |
Enables/disables the Packets Count callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This function cannot be used with function SetByteTotalsCallback in the same time. It means that this callback function (if it is already set) need to be cleared when you want to SetByteTotalsCallback and vice versa.
pCallback[IN] |
| |
interval |
|
ULONG SetPDSStateCallback | ( | tFNPDSState | pCallback | ) |
Enables/disables the PDS service state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
Enables/disables the Operating Mode callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
Enables/disables the radio frequency information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetRoamingIndicatorCallback | ( | tFNRoamingIndicator | pCallback | ) |
Enables/disables the Roaming Indicator callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetSessionStateCallback | ( | tFNSessionState | pCallback | ) |
Enables/disables the session state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetSignalStrengthCallback | ( | tFNSignalStrength | pCallback, | |
BYTE | thresholdsSize, | |||
INT8 * | pThresholds | |||
) |
Enables/disables the Signal Strength callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
| |
thresholdsSize |
| |
pThresholds[IN] |
|
ULONG SetSLQSOMADMAlertCallback | ( | tFNSLQSOMADMAlert | pCallback | ) |
Enables/disables the SWIOMADM network-initiated alert callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetUSSDNotificationCallback | ( | tFNUSSDNotification | pCallback | ) |
Enables/disables the USSDNotification callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SetUSSDReleaseCallback | ( | tFNUSSDRelease | pCallback | ) |
Enables/disables the USSD release callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetBandPreferenceCbk | ( | tFNBandPreference | pCallback | ) |
Enables/disables the Band Preference callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetSDKTerminatedCallback | ( | tFNSDKTerminated | pCallback | ) |
Used by the client application to register a Callback function for SDK terminated event notifications. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
2 INT 4 ILL 5 TRAP 6 ABRT 7 BUS 8 FPE 11 SEGV 13 PIPE 15 TERM 31 SYS
ULONG SLQSSetServingSystemCallback | ( | tFNServingSystem | pCallback | ) |
Enables/disables the Serving System callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetSignalStrengthsCallback | ( | tFNSLQSSignalStrengths | pCallback, | |
struct SLQSSignalStrengthsIndReq * | pSLQSSignalStrengthsIndReq | |||
) |
Enables/disables the Received Signal Strength Information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
| |
pSLQSSignalStrengthsIndReq |
|
ULONG SLQSSetSMSEventCallback | ( | tFNSMSEvents | pCallback | ) |
Enables/disables the events related to SMS callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetSysSelectionPrefCallBack | ( | tFNSysSelectionPref | pCallback | ) |
Enables/disables the System Selection Preference callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetTransLayerInfoCallback | ( | tFNtransLayerInfo | pCallback | ) |
Enables/disables the Transport Layer information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|
ULONG SLQSSetTransNWRegInfoCallback | ( | tFNtransNWRegInfo | pCallback | ) |
Enables/disables the Transport Network Registration information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.
pCallback[IN] |
|