| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

QmiWDS.h
1 /*===========================================================================
2 FILE:
3 GobiNASAPI.h
4
5 DESCRIPTION:
6 Gobi Wireless Data Service APIs
7
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9 Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11
12 #ifndef __GOBI_WDS_API_H__
13 #define __GOBI_WDS_API_H__
14 /*=========================================================================*/
15 // Definitions
16 /*=========================================================================*/
17
22
23 /*=========================================================================*/
24 // Structs
25 /*=========================================================================*/
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /*=========================================================================*/
31 // Callbacks
32 /*=========================================================================*/
33
34 #ifdef __cplusplus
35 };
36 #endif
37
38 /*=========================================================================*/
39 // Prototypes
40 /*=========================================================================*/
52 IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference( ULONG prefIPFamily );
53
64 IMPORTGOBI ULONG GOBICMAPI SetDormancyStatusCallback(
65 tFNDormancyStatus pCallback );
66
67
80 IMPORTGOBI ULONG GOBICMAPI SetByteTotalsCallback(
81 tFNByteTotals pCallback,
82 BYTE interval );
83
99 IMPORTGOBI ULONG GOBICMAPI SetSessionStateCallback( tFNSessionState pCallback );
100
101
112 IMPORTGOBI ULONG GOBICMAPI SetMobileIPStatusCallback(
113 tFNMobileIPStatus pCallback );
114
115
127 IMPORTGOBI ULONG GOBICMAPI SetDataBearerCallback( tFNDataBearer pCallback );
128
140 IMPORTGOBI ULONG GOBICMAPI GetDataBearerTechnology( ULONG * pDataBearer );
141
153 IMPORTGOBI ULONG GOBICMAPI GetSessionState( ULONG * pState );
154
165 IMPORTGOBI ULONG GOBICMAPI GetSessionDuration( ULONGLONG * pDuration );
166
177 IMPORTGOBI ULONG GOBICMAPI GetDormancyState( ULONG * pState );
178
190 IMPORTGOBI ULONG GOBICMAPI GetAutoconnect( ULONG * pSetting );
191
202
203 IMPORTGOBI ULONG GOBICMAPI SetAutoconnect( ULONG setting );
204
216 IMPORTGOBI ULONG GOBICMAPI GetEnhancedAutoconnect(
217 ULONG * pSetting,
218 ULONG * pRoamSetting );
219
230 IMPORTGOBI ULONG GOBICMAPI SetEnhancedAutoconnect(
231 ULONG setting,
232 ULONG * pRoamSetting );
233
252 IMPORTGOBI ULONG GOBICMAPI SetDefaultProfile(
253 ULONG profileType,
254 ULONG * pPDPType,
255 ULONG * pIPAddress,
256 ULONG * pPrimaryDNS,
257 ULONG * pSecondaryDNS,
258 ULONG * pAuthentication,
259 CHAR * pName,
260 CHAR * pAPNName,
261 CHAR * pUsername,
262 CHAR * pPassword );
263
292
293 IMPORTGOBI ULONG GOBICMAPI GetDefaultProfile(
294 ULONG profileType,
295 ULONG * pPDPType,
296 ULONG * pIPAddress,
297 ULONG * pPrimaryDNS,
298 ULONG * pSecondaryDNS,
299 ULONG * pAuthentication,
300 BYTE nameSize,
301 CHAR * pName,
302 BYTE apnSize,
303 CHAR * pAPNName,
304 BYTE userSize,
305 CHAR * pUsername );
306
321 IMPORTGOBI ULONG GOBICMAPI SetDefaultIPv6Profile(
322 ULONG profileType,
323 USHORT * pIPAddress,
324 USHORT * pPrimaryDNS,
325 USHORT * pSecondaryDNS );
326
341 IMPORTGOBI ULONG GOBICMAPI GetDefaultIPv6Profile(
342 ULONG profileType,
343 USHORT * pIPAddress,
344 USHORT * pPrimaryDNS,
345 USHORT * pSecondaryDNS );
346
379 IMPORTGOBI ULONG GOBICMAPI StartDataSession2(
380 ULONG * pTechnology,
381 ULONG * pPrimaryDNS,
382 ULONG * pSecondaryDNS,
383 ULONG * pPrimaryNBNS,
384 ULONG * pSecondaryNBNS,
385 CHAR * pAPNName,
386 ULONG * pIPAddress,
387 ULONG * pAuthentication,
388 CHAR * pUsername,
389 CHAR * pPassword,
390 ULONG * pSessionId,
391 ULONG * pFailureReason );
392
413 IMPORTGOBI ULONG GOBICMAPI StartDataSession(
414 ULONG * pTechnology,
415 ULONG * pPrimaryDNS,
416 ULONG * pSecondaryDNS,
417 ULONG * pPrimaryNBNS,
418 ULONG * pSecondaryNBNS,
419 CHAR * pAPNName,
420 ULONG * pIPAddress,
421 ULONG * pAuthentication,
422 CHAR * pUsername,
423 CHAR * pPassword,
424 ULONG * pSessionId );
425
434 IMPORTGOBI ULONG GOBICMAPI CancelDataSession();
435
446 IMPORTGOBI ULONG GOBICMAPI StopDataSession( ULONG sessionId );
447
458 IMPORTGOBI ULONG GOBICMAPI GetIPAddress( ULONG * pIPAddress );
459
472 IMPORTGOBI ULONG GOBICMAPI GetConnectionRate(
473 ULONG * pCurrentChannelTXRate,
474 ULONG * pCurrentChannelRXRate,
475 ULONG * pMaxChannelTXRate,
476 ULONG * pMaxChannelRXRate );
477
492 IMPORTGOBI ULONG GOBICMAPI GetPacketStatus(
493 ULONG * pTXPacketSuccesses,
494 ULONG * pRXPacketSuccesses,
495 ULONG * pTXPacketErrors,
496 ULONG * pRXPacketErrors,
497 ULONG * pTXPacketOverflows,
498 ULONG * pRXPacketOverflows );
499
510
511 IMPORTGOBI ULONG GOBICMAPI GetByteTotals(
512 ULONGLONG * pTXTotalBytes,
513 ULONGLONG * pRXTotalBytes );
514
524 IMPORTGOBI ULONG GOBICMAPI SetMobileIP( ULONG mode );
525
536 IMPORTGOBI ULONG GOBICMAPI GetMobileIP( ULONG * pMode );
537
548 IMPORTGOBI ULONG GOBICMAPI SetActiveMobileIPProfile(
549 CHAR * pSPC,
550 BYTE index );
551
561 IMPORTGOBI ULONG GOBICMAPI GetActiveMobileIPProfile( BYTE * pIndex );
562
595
596 IMPORTGOBI ULONG GOBICMAPI SetMobileIPProfile(
597 CHAR * pSPC,
598 BYTE index,
599 BYTE * pEnabled,
600 ULONG * pAddress,
601 ULONG * pPrimaryHA,
602 ULONG * pSecondaryHA,
603 BYTE * pRevTunneling,
604 CHAR * pNAI,
605 ULONG * pHASPI,
606 ULONG * pAAASPI,
607 CHAR * pMNHA,
608 CHAR * pMNAAA );
609
630 IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile2(
631 BYTE index,
632 BYTE * pEnabled,
633 ULONG * pAddress,
634 ULONG * pPrimaryHA,
635 ULONG * pSecondaryHA,
636 BYTE * pRevTunneling,
637 BYTE naiSize,
638 CHAR * pNAI,
639 ULONG * pHASPI,
640 ULONG * pAAASPI,
641 ULONG * pHAState,
642 ULONG * pAAAState );
643
672 IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile(
673 BYTE index,
674 BYTE * pEnabled,
675 ULONG * pAddress,
676 ULONG * pPrimaryHA,
677 ULONG * pSecondaryHA,
678 BYTE * pRevTunneling,
679 BYTE naiSize,
680 CHAR * pNAI,
681 ULONG * pHASPI,
682 ULONG * pAAASPI );
683
700 IMPORTGOBI ULONG GOBICMAPI SetMobileIPParameters(
701 CHAR * pSPC,
702 ULONG * pMode,
703 BYTE * pRetryLimit,
704 BYTE * pRetryInterval,
705 BYTE * pReRegPeriod,
706 BYTE * pReRegTraffic,
707 BYTE * pHAAuthenticator,
708 BYTE * pHA2002bis );
709
725 IMPORTGOBI ULONG GOBICMAPI GetMobileIPParameters(
726 ULONG * pMode,
727 BYTE * pRetryLimit,
728 BYTE * pRetryInterval,
729 BYTE * pReRegPeriod,
730 BYTE * pReRegTraffic,
731 BYTE * pHAAuthenticator,
732 BYTE * pHA2002bis );
733
743 IMPORTGOBI ULONG GOBICMAPI GetLastMobileIPError( ULONG * pError );
744
756 IMPORTGOBI ULONG GOBICMAPI SetDNSSettings(
757 ULONG * pPrimaryDNS,
758 ULONG * pSecondaryDNS );
759
771 IMPORTGOBI ULONG GOBICMAPI GetDNSSettings(
772 ULONG * pPrimaryDNS,
773 ULONG * pSecondaryDNS );
774
787 IMPORTGOBI ULONG GOBICMAPI SetDNSIPv6Settings(
788 USHORT * pPrimaryDNS,
789 USHORT * pSecondaryDNS );
790
802 IMPORTGOBI ULONG GOBICMAPI GetDNSIPv6Settings(
803 USHORT * pPrimaryDNS,
804 USHORT * pSecondaryDNS );
805
816 IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference( ULONG prefIPFamily );
817
828 QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(
829 tFNPacketTotals pCallback,
830 BYTE interval ); // End of WDS group
832 #endif
GetMobileIP
IMPORTGOBI ULONG GOBICMAPI GetMobileIP(ULONG *pMode)
tFNPacketTotals
void(SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX)
API Return Codes.
Definition: SwiWwanCmApi.h:60
GetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetActiveMobileIPProfile(BYTE *pIndex)
GetAutoconnect
IMPORTGOBI ULONG GOBICMAPI GetAutoconnect(ULONG *pSetting)
StartDataSession
IMPORTGOBI ULONG GOBICMAPI StartDataSession(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId)
StartDataSession2
IMPORTGOBI ULONG GOBICMAPI StartDataSession2(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId, ULONG *pFailureReason)
SetDNSIPv6Settings
IMPORTGOBI ULONG GOBICMAPI SetDNSIPv6Settings(USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
GetEnhancedAutoconnect
IMPORTGOBI ULONG GOBICMAPI GetEnhancedAutoconnect(ULONG *pSetting, ULONG *pRoamSetting)
GetSessionState
IMPORTGOBI ULONG GOBICMAPI GetSessionState(ULONG *pState)
SetMobileIP
IMPORTGOBI ULONG GOBICMAPI SetMobileIP(ULONG mode)
SetPacketTotalsCallback
QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(tFNPacketTotals pCallback, BYTE interval)
GetDataBearerTechnology
IMPORTGOBI ULONG GOBICMAPI GetDataBearerTechnology(ULONG *pDataBearer)
CancelDataSession
IMPORTGOBI ULONG GOBICMAPI CancelDataSession()
SetDormancyStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetDormancyStatusCallback(tFNDormancyStatus pCallback)
GetConnectionRate
IMPORTGOBI ULONG GOBICMAPI GetConnectionRate(ULONG *pCurrentChannelTXRate, ULONG *pCurrentChannelRXRate, ULONG *pMaxChannelTXRate, ULONG *pMaxChannelRXRate)
SetDNSSettings
IMPORTGOBI ULONG GOBICMAPI SetDNSSettings(ULONG *pPrimaryDNS, ULONG *pSecondaryDNS)
GetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI)
GetByteTotals
IMPORTGOBI ULONG GOBICMAPI GetByteTotals(ULONGLONG *pTXTotalBytes, ULONGLONG *pRXTotalBytes)
GetDormancyState
IMPORTGOBI ULONG GOBICMAPI GetDormancyState(ULONG *pState)
GetMobileIPProfile2
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile2(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, ULONG *pHAState, ULONG *pAAAState)
SetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetMobileIPProfile(CHAR *pSPC, BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, CHAR *pMNHA, CHAR *pMNAAA)
SetAutoconnect
IMPORTGOBI ULONG GOBICMAPI SetAutoconnect(ULONG setting)
GetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI GetMobileIPParameters(ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
SetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetActiveMobileIPProfile(CHAR *pSPC, BYTE index)
GetDNSSettings
IMPORTGOBI ULONG GOBICMAPI GetDNSSettings(ULONG *pPrimaryDNS, ULONG *pSecondaryDNS)
GetDefaultIPv6Profile
IMPORTGOBI ULONG GOBICMAPI GetDefaultIPv6Profile(ULONG profileType, USHORT *pIPAddress, USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
SetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI SetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, CHAR *pName, CHAR *pAPNName, CHAR *pUsername, CHAR *pPassword)
SetDefaultIPv6Profile
IMPORTGOBI ULONG GOBICMAPI SetDefaultIPv6Profile(ULONG profileType, USHORT *pIPAddress, USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
GetIPAddress
IMPORTGOBI ULONG GOBICMAPI GetIPAddress(ULONG *pIPAddress)
SetMobileIPStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetMobileIPStatusCallback(tFNMobileIPStatus pCallback)
SetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI SetMobileIPParameters(CHAR *pSPC, ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
GetDNSIPv6Settings
IMPORTGOBI ULONG GOBICMAPI GetDNSIPv6Settings(USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
SetClientIPFamilyPreference
IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference(ULONG prefIPFamily)
SetEnhancedAutoconnect
IMPORTGOBI ULONG GOBICMAPI SetEnhancedAutoconnect(ULONG setting, ULONG *pRoamSetting)
GetPacketStatus
IMPORTGOBI ULONG GOBICMAPI GetPacketStatus(ULONG *pTXPacketSuccesses, ULONG *pRXPacketSuccesses, ULONG *pTXPacketErrors, ULONG *pRXPacketErrors, ULONG *pTXPacketOverflows, ULONG *pRXPacketOverflows)
GetSessionDuration
IMPORTGOBI ULONG GOBICMAPI GetSessionDuration(ULONGLONG *pDuration)
GetLastMobileIPError
IMPORTGOBI ULONG GOBICMAPI GetLastMobileIPError(ULONG *pError)
StopDataSession
IMPORTGOBI ULONG GOBICMAPI StopDataSession(ULONG sessionId)
SetSessionStateCallback
IMPORTGOBI ULONG GOBICMAPI SetSessionStateCallback(tFNSessionState pCallback)
SetByteTotalsCallback
IMPORTGOBI ULONG GOBICMAPI SetByteTotalsCallback(tFNByteTotals pCallback, BYTE interval)
GetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI GetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, BYTE nameSize, CHAR *pName, BYTE apnSize, CHAR *pAPNName, BYTE userSize, CHAR *pUsername)
SetDataBearerCallback
IMPORTGOBI ULONG GOBICMAPI SetDataBearerCallback(tFNDataBearer pCallback)