SwiApiGsmLbs.h

Go to the documentation of this file.

#ifndef __SWIAPI_GSM_LBS
#define __SWIAPI_GSM_LBS

#ifdef __cplusplus
extern "C" {
#endif

/* include files */
#include "SwiDataTypes.h"
#include "SwiRcodes.h"

#define MAX_NUM_LBS_SV        12 
#define LENGTH_LbsReqId       33 
#define LENGTH_LbsClientName  33 
enum SWI_TYPE_LbsPaErr
{
    SWI_LBSPAERR_NoError,
    SWI_LBSPAERR_InternalError,
    SWI_LBSPAERR_InvalidClientId,
    SWI_LBSPAERR_ErrorInParamToSet,
    SWI_LBSPAERR_ErrorInLockType,
    SWI_LBSPAERR_PhoneOffline,
    SWI_LBSPAERR_ParamCommandAlreadyActive,
    SWI_LBSPAERR_IncorrectAppSpecificInfo
};

struct SWI_STRUCT_LbsPaKeepWarmStart
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsPaErr eStatus;
};

struct SWI_STRUCT_LbsPaWarmBegin
{
    swi_uint32 sizeStruct; 
};

enum SWI_TYPE_LbsPaWarmStatus
{
    SWI_LBSPAWARMSTATUS_NotWarm,
    SWI_LBSPAWARMSTATUS_Warm
};

struct SWI_STRUCT_LbsPaWarmStatus
{
    swi_uint32 sizeStruct;
    
    swi_bool bEnabled;
    
    enum SWI_TYPE_LbsPaWarmStatus eStatus;
};

struct SWI_STRUCT_LbsPaWarmDone
{
    swi_uint32 sizeStruct; 
};

struct SWI_STRUCT_LbsPaKeepWarmStop
{
    swi_uint32 sizeStruct;      
    
    enum SWI_TYPE_LbsPaErr eStatus;
};


struct SWI_STRUCT_LbsUserOptions
{       
    swi_bool bReadable;
    
    swi_bool bWritable;
};

enum SWI_TYPE_LbsSettingStatus
{
    SWI_LBSSETTINGSTATUS_Success
};

struct SWI_STRUCT_LbsFixSettings
{
    swi_uint32 sizeStruct; 
    
    struct SWI_STRUCT_LbsUserOptions sFixTypeUserOp;
    
    enum SWI_TYPE_LbsFix eFixType;
    
    struct SWI_STRUCT_LbsUserOptions sPerformanceUserOp;
    
    swi_uint32 nPerformance;
    
    struct SWI_STRUCT_LbsUserOptions sAccuracyUserOp;
    
    swi_uint32 nAccuracy;
    
    struct SWI_STRUCT_LbsUserOptions sFixCountUserOp;
    
    swi_uint32 nFixCount;
    
    struct SWI_STRUCT_LbsUserOptions sFixRateUserOp;
    
    swi_uint32 nFixRate;
    
    enum SWI_TYPE_LbsSettingStatus eResult;
};

enum TYPE_LbsNiReqResp 
{
    LBSNIREQRESP_Reject,
    
    LBSNIREQRESP_Accept,
    
    LBSNIREQRESP_Cancel
};

enum TYPE_LbsNiReqErrCode 
{
    LBSNIREQERRCODE_NoError,
    
    LBSNIREQERRCODE_HandleMismatch,
    
    LBSNIREQERRCODE_UserRespTimeout,
    
    LBSNIREQERRCODE_NoUserRespReq
};

enum TYPE_LbsNiReqNotif 
{
    LBSNIREQNOTIF_NotifyOnly,
    
    LBSNIREQNOTIF_UserRespReq
};

enum TYPE_LbsNiReqId 
{
    LBSNIREQID_Unknown,
    LBSNIREQID_LogicalName,
    LBSNIREQID_Msisdn,
    LBSNIREQID_Email,
    LBSNIREQID_Url,
    LBSNIREQID_SipUrl,
    LBSNIREQID_ImsPublicId,
    LBSNIREQID_Min,
    LBSNIREQID_Mdn
};

enum TYPE_LbsNiReqClientName
{
    LBSNIREQCLIENTNAME_Unknown,
    LBSNIREQCLIENTNAME_LogicalName,
    LBSNIREQCLIENTNAME_Msisdn,
    LBSNIREQCLIENTNAME_Email,
    LBSNIREQCLIENTNAME_Url,
    LBSNIREQCLIENTNAME_SipUrl,
    LBSNIREQCLIENTNAME_ImsPublicId,
    LBSNIREQCLIENTNAME_Min,
    LBSNIREQCLIENTNAME_Mdn
}; 

struct SWI_STRUCT_LbsNiReq
{
    swi_uint32 sizeStruct;

    swi_uint32  nNiId;

    enum TYPE_LbsNiReqResp eReqResp; 

    enum TYPE_LbsNiReqErrCode eErrCode;

    swi_uint32  nTimeout;

    enum TYPE_LbsNiReqNotif eNotifType;

    enum TYPE_LbsNiReqId eReqIdType;

    swi_char szReqId[LENGTH_LbsReqId];

    enum TYPE_LbsNiReqClientName eClientName;

    swi_char szClientName[LENGTH_LbsClientName];
};

/* prototypes */
extern SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStart(
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetLbsPaWarmStatus(
    struct SWI_STRUCT_LbsPaWarmStatus *psLbsPaWarmStatus, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStop(
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetLbsFixSettings(
    struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetLbsFixSettings(
    struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetLbsNiReq(
    struct SWI_STRUCT_LbsNiReq *pLbsNiReq,
    swi_uint32 timeout);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __SWIAPI_GSM_LBS */
/* 
 * $Log: SwiApiGsmLbs.h,v $
 */