Interface to GL SUPL protocol stack. More...
#include <glsuplapi.h>
Public Member Functions | |
virtual void | Abort (void)=0 |
Abort any active SUPL session. | |
virtual void | AbortWithStatusCode (GLSUPL_StatusCode errorCode)=0 |
Abort any active SUPL session with specific staus code. | |
virtual void | SetVersion (unsigned char ucVersion)=0 |
Sets SUPL protocol version. | |
virtual void | SetMinorVersion (unsigned char ucMinorVersion)=0 |
Setting specific minor version for SUPL. | |
virtual void | SetHmacHash (GLSUPL_HmacHash hmacHash)=0 |
Sets HMAC hash algorithm Note: This function should be called before any SUPL requests. | |
virtual void | SetID (const GLSUPL_SetID *pSuplSetID)=0 |
Sets the SUPL ID in the GLL SUPL protocol stack. | |
virtual void | GetCapabilities (GLSUPL_SETCapabilities *pCap)=0 |
Gets capabilities from GLL SUPL protocol stack Note: This function can be called at any time. | |
virtual void | SetCapabilities (const GLSUPL_SETCapabilities *pCap)=0 |
Sets default capabilities for GLL SUPL protocol stack Note: This function can be called at any time. | |
virtual void | SetEnhancedAssisted (bool bEnhancedAssisted)=0 |
Sets EnhancedAssisted property. | |
virtual void | SetPreferCoarseTime (bool bPreferCoarseTime)=0 |
Sets PreferCoarseTime property. | |
virtual void | SetGuardTime (int nGuardTime)=0 |
Sets GuardTime property. | |
virtual void | SetTimers (unsigned long ut1, unsigned long ut2, unsigned long ut3, unsigned long ut5, unsigned long ut7, unsigned long ut8)=0 |
Allows to customize values for timers UT1, UT2, and UT3. | |
virtual bool | StartSuplSession (const GL_AID_REQUEST *const pAid, const GLSUPL_ApplicationID *const appID)=0 |
Start SET-initiated session. | |
virtual void | OnConnected (bool bSuccess)=0 |
Inform GL SUPL protocol stack that SUPL connection has been established (bSuccess = 1) or not (bSuccess = 0) | |
virtual void | OnDisconnected (void)=0 |
Inform GL SUPL protocol stack that SUPL connection has been terminated. | |
virtual void | OnNetworkRequest (const unsigned char *pucBuf, int nBytes, const unsigned char *pucKey, const GLSUPL_StatusCode *pCode)=0 |
Pass network request to GL SUPL protocol stack. | |
virtual void | OnDataReceived (const unsigned char *pucBuf, int nBytes)=0 |
Pass data received from SUPL server to GL SUPL protocol stack. | |
virtual void | OnTimeout (void)=0 |
Timer timeout. | |
virtual void | SetLocationId (const GLSUPL_LocationId *pLocationId)=0 |
Sets the Location Information for the LBS SUPL protocol stack. | |
virtual void | VerificationRsp (bool bAllow)=0 |
Respond to NotificationVerificationReq() | |
virtual void | ProvideOtdoaCapabilities (const GLLPP_OTDOA_Capabilities *pCap)=0 |
Provide OTDOA capabilities. | |
virtual void | ProvideOtdoaLocationInformation (const GLLPP_OTDOA_LocationInformation *pLocationInformation)=0 |
Provide OTDOA location information. | |
virtual void | RequestOtdoaAssistanceData (OSUINT16 physCellId)=0 |
Requests OTDOA assistance data. | |
virtual void | ProvideEcidCapabilities (const GLLPP_ECID_Capabilities *pCap)=0 |
Provide ECID capabilities. | |
virtual void | ProvideEcidLocationInformation (const GLLPP_ECID_LocationInformation *pLocationInformation)=0 |
Provide ECID location information. | |
virtual bool | HasTriggeredSession () const =0 |
Return true if trigged session exist. | |
virtual void | StopTriggeredSession ()=0 |
Stops triggered sesion. | |
virtual void | Abort (void)=0 |
Abort any active SUPL session. | |
virtual void | AbortWithStatusCode (GLSUPL_StatusCode errorCode)=0 |
Abort any active SUPL session with specific staus code. | |
virtual void | SetID (const GLSUPL_SetID *pSuplSetID)=0 |
Sets the SUPL ID in the GLL SUPL protocol stack. | |
virtual void | GetCapabilities (GLSUPL_SETCapabilities *pCap)=0 |
Gets capabilities from GLL SUPL protocol stack Note: This function can be called at any time. | |
virtual void | SetCapabilities (const GLSUPL_SETCapabilities *pCap)=0 |
Sets default capabilities for GLL SUPL protocol stack Note: This function can be called at any time. | |
virtual void | SetEnhancedAssisted (bool bEnhancedAssisted)=0 |
Sets EnhancedAssisted property. | |
virtual void | SetPreferCoarseTime (bool bPreferCoarseTime)=0 |
Sets PreferCoarseTime property. | |
virtual void | SetGuardTime (int nGuardTime)=0 |
Sets GuardTime property. | |
virtual void | SetMinorVersion (unsigned char ucMinorVersion)=0 |
Setting specific minor version for SUPL. | |
virtual void | SetTimers (unsigned long ut1, unsigned long ut2, unsigned long ut3)=0 |
Allows to customize values for timers UT1, UT2, and UT3. | |
virtual bool | StartSuplSession (const GL_AID_REQUEST *const pAid)=0 |
Start SET-initiated session. | |
virtual void | OnConnected (bool bSuccess)=0 |
Inform GL SUPL protocol stack that SUPL connection has been established (bSuccess = 1) or not (bSuccess = 0) | |
virtual void | OnDisconnected (void)=0 |
Inform GL SUPL protocol stack that SUPL connection has been terminated. | |
virtual void | OnNetworkRequest (const unsigned char *pucBuf, int nBytes, const unsigned char *pucKey)=0 |
Pass network request to GL SUPL protocol stack. | |
virtual void | OnDataReceived (const unsigned char *pucBuf, int nBytes)=0 |
Pass data received from SUPL server to GL SUPL protocol stack. | |
virtual void | OnTimeout (void)=0 |
Timer timeout. | |
virtual void | SetLocationId (const GLSUPL_LocationId *pLocationId)=0 |
Sets the Location Information for the LBS SUPL protocol stack. | |
virtual void | VerificationRsp (bool bAllow)=0 |
Respond to NotificationVerificationReq() | |
Methods to create and destroy an instance of the SUPL engine class | |
virtual void | Dispose (void)=0 |
Dispose of a GlSuplEngine after use. | |
virtual void | Dispose (void)=0 |
Dispose of a GlSuplEngine after use. | |
static GlSuplEngine * | Create (GlSuplHal *pSuplHal, GlEngine *pGlEngine) |
This method creates an instance of the SUPL engine. | |
static GlSuplEngine * | Create (GlSuplHal *pSuplHal, GlEngine *pGlEngine) |
This method creates an instance of the SUPL engine. |
Interface to GL SUPL protocol stack.
virtual void GlSuplEngine::AbortWithStatusCode | ( | GLSUPL_StatusCode | errorCode | ) | [pure virtual] |
Abort any active SUPL session with specific staus code.
errorCode | - error code |
virtual void GlSuplEngine::AbortWithStatusCode | ( | GLSUPL_StatusCode | errorCode | ) | [pure virtual] |
Abort any active SUPL session with specific staus code.
errorCode | - error code |
virtual void GlSuplEngine::GetCapabilities | ( | GLSUPL_SETCapabilities * | pCap | ) | [pure virtual] |
Gets capabilities from GLL SUPL protocol stack Note: This function can be called at any time.
virtual void GlSuplEngine::GetCapabilities | ( | GLSUPL_SETCapabilities * | pCap | ) | [pure virtual] |
Gets capabilities from GLL SUPL protocol stack Note: This function can be called at any time.
virtual void GlSuplEngine::OnConnected | ( | bool | bSuccess | ) | [pure virtual] |
Inform GL SUPL protocol stack that SUPL connection has been established (bSuccess = 1) or not (bSuccess = 0)
bSuccess | 0 - unsuccessful, 1 - successful Note: This function should be called after RequestConnection() to inform SUPL protocol stack about result of this request |
virtual void GlSuplEngine::OnConnected | ( | bool | bSuccess | ) | [pure virtual] |
Inform GL SUPL protocol stack that SUPL connection has been established (bSuccess = 1) or not (bSuccess = 0)
bSuccess | 0 - unsuccessful, 1 - successful Note: This function should be called after RequestConnection() to inform SUPL protocol stack about result of this request |
virtual void GlSuplEngine::OnDataReceived | ( | const unsigned char * | pucBuf, |
int | nBytes | ||
) | [pure virtual] |
Pass data received from SUPL server to GL SUPL protocol stack.
pucBuf | - pointer to the buffer containing the bytes. |
nBytes | - number of bytes received (may be zero) |
virtual void GlSuplEngine::OnDataReceived | ( | const unsigned char * | pucBuf, |
int | nBytes | ||
) | [pure virtual] |
Pass data received from SUPL server to GL SUPL protocol stack.
pucBuf | - pointer to the buffer containing the bytes. |
nBytes | - number of bytes received (may be zero) |
virtual void GlSuplEngine::OnNetworkRequest | ( | const unsigned char * | pucBuf, |
int | nBytes, | ||
const unsigned char * | pucKey, | ||
const GLSUPL_StatusCode * | pCode | ||
) | [pure virtual] |
Pass network request to GL SUPL protocol stack.
pucBuf | - pointer to a buffer with binary coded Network initiated message. |
nBytes | - size of this message. |
pucKey | - key-string for calculation HMAC of pucBuf(SUPL_INIT) inside SUPL stack. |
pCode | - pointer to error status code to be sent back to SUPL server, can be NULL. Note: Parameter 'ver' CAN NOT BE NULL. |
virtual void GlSuplEngine::OnNetworkRequest | ( | const unsigned char * | pucBuf, |
int | nBytes, | ||
const unsigned char * | pucKey | ||
) | [pure virtual] |
Pass network request to GL SUPL protocol stack.
pucBuf | - pointer to a buffer with binary coded Network initiated message. |
nBytes | - size of this message. |
pucKey | - key-string for calculation HMAC of pucBuf(SUPL_INIT) inside SUPL stack. Note: Parameter 'ver' CAN NOT BE NULL. |
virtual void GlSuplEngine::ProvideEcidCapabilities | ( | const GLLPP_ECID_Capabilities * | pCap | ) | [pure virtual] |
Provide ECID capabilities.
pCap | - ECID capabilities |
virtual void GlSuplEngine::ProvideEcidLocationInformation | ( | const GLLPP_ECID_LocationInformation * | pLocationInformation | ) | [pure virtual] |
Provide ECID location information.
pLocationInformation | - ECID location information |
virtual void GlSuplEngine::ProvideOtdoaCapabilities | ( | const GLLPP_OTDOA_Capabilities * | pCap | ) | [pure virtual] |
Provide OTDOA capabilities.
pCap | - OTDOA capabilities |
virtual void GlSuplEngine::ProvideOtdoaLocationInformation | ( | const GLLPP_OTDOA_LocationInformation * | pLocationInformation | ) | [pure virtual] |
Provide OTDOA location information.
pLocationInformation | - OTDOA location information |
virtual void GlSuplEngine::RequestOtdoaAssistanceData | ( | OSUINT16 | physCellId | ) | [pure virtual] |
Requests OTDOA assistance data.
physCellId | - physical cell identity of the assistance data reference cell |
virtual void GlSuplEngine::SetCapabilities | ( | const GLSUPL_SETCapabilities * | pCap | ) | [pure virtual] |
Sets default capabilities for GLL SUPL protocol stack Note: This function can be called at any time.
virtual void GlSuplEngine::SetCapabilities | ( | const GLSUPL_SETCapabilities * | pCap | ) | [pure virtual] |
Sets default capabilities for GLL SUPL protocol stack Note: This function can be called at any time.
virtual void GlSuplEngine::SetID | ( | const GLSUPL_SetID * | pSuplSetID | ) | [pure virtual] |
Sets the SUPL ID in the GLL SUPL protocol stack.
pSuplSetID | - pointer to structure defining SUPL SET ID Note: This function should be called before any SUPL requests |
virtual void GlSuplEngine::SetID | ( | const GLSUPL_SetID * | pSuplSetID | ) | [pure virtual] |
Sets the SUPL ID in the GLL SUPL protocol stack.
pSuplSetID | - pointer to structure defining SUPL SET ID Note This function should be called before any SUPL requests |
virtual void GlSuplEngine::SetLocationId | ( | const GLSUPL_LocationId * | pLocationId | ) | [pure virtual] |
Sets the Location Information for the LBS SUPL protocol stack.
pLocationId | - pointer to a location information structure. Note: 1. If the location information data is available right away, this function can be called from the RequestLocationId(). 2. The location information is requested periodically to cover the case of a roaming mobile station. 3. pLocationId->cellInfo.t should be 4 (GLSUPL_CELL_INFO_CDMA + 1) when location information is not available in this case SUPL session will be terminated |
virtual void GlSuplEngine::SetLocationId | ( | const GLSUPL_LocationId * | pLocationId | ) | [pure virtual] |
Sets the Location Information for the LBS SUPL protocol stack.
pLocationId | - pointer to a location information structure. Note: 1. If the location information data is available right away, this function can be called from the RequestLocationId(). 2. The location information is requested periodically to cover the case of a roaming mobile station. 3. pLocationId->cellInfo.t should be 4 (GLSUPL_CELL_INFO_CDMA + 1) when location information is not available in this case SUPL session will be terminated |
virtual void GlSuplEngine::SetMinorVersion | ( | unsigned char | ucMinorVersion | ) | [pure virtual] |
Setting specific minor version for SUPL.
ucMinorVersion | - protocol minor version for SUPL 2.0 |
virtual void GlSuplEngine::SetTimers | ( | unsigned long | ut1, |
unsigned long | ut2, | ||
unsigned long | ut3, | ||
unsigned long | ut5, | ||
unsigned long | ut7, | ||
unsigned long | ut8 | ||
) | [pure virtual] |
Allows to customize values for timers UT1, UT2, and UT3.
ut1 | - UT1 timer in milliseconds, default value is 10000 ms. |
ut2 | - UT2 timer in milliseconds, default value is 10000 ms. |
ut3 | - UT3 timer in milliseconds, default value is 10000 ms. |
ut5 | - UT5 timer in milliseconds, default value is 10000 ms. |
ut7 | - UT7 timer in milliseconds, default value is 10000 ms. |
ut8 | - UT8 timer in milliseconds, default value is 10000 ms. Note: Setting timer value to 0 means that this timer should not be changed. Must be called as a part of GLL initialization procedure. Please refer to SUPL specification for more information |
virtual void GlSuplEngine::SetTimers | ( | unsigned long | ut1, |
unsigned long | ut2, | ||
unsigned long | ut3 | ||
) | [pure virtual] |
Allows to customize values for timers UT1, UT2, and UT3.
ut1 | - UT1 timer in milliseconds, default value is 10000 ms. |
ut2 | - UT2 timer in milliseconds, default value is 10000 ms. |
ut3 | - UT3 timer in milliseconds, default value is 10000 ms. Note: Setting timer value to 0 means that this timer should not be changed. Must be called as a part of GLL initialization procedure. Please refer to SUPL specification for more information |
virtual void GlSuplEngine::SetVersion | ( | unsigned char | ucVersion | ) | [pure virtual] |
Sets SUPL protocol version.
This function allows to restrict functionality of GLL SUPL protocol stack to SUPL 1.0.
ucVersion | - protocol version (either 1 or 2) Note: This function should be called before any SUPL requests Note: This function resets HMAC hash algorithm to default value |
virtual bool GlSuplEngine::StartSuplSession | ( | const GL_AID_REQUEST *const | pAid, |
const GLSUPL_ApplicationID *const | appID | ||
) | [pure virtual] |
Start SET-initiated session.
pAid | - Aiding status from the GLL. |
appID | - Pointer to the application ID. |
virtual bool GlSuplEngine::StartSuplSession | ( | const GL_AID_REQUEST *const | pAid | ) | [pure virtual] |
Start SET-initiated session.
pAid | - Aiding status from the GLL. |
virtual void GlSuplEngine::VerificationRsp | ( | bool | bAllow | ) | [pure virtual] |
Respond to NotificationVerificationReq()
bAllow | 1 - allow positioning info, 0 - deny Note: This function should be called in response to NotificationVerificationReq() |
virtual void GlSuplEngine::VerificationRsp | ( | bool | bAllow | ) | [pure virtual] |
Respond to NotificationVerificationReq()
bAllow | 1 - allow positioning info, 0 - deny Note: This function should be called in response to NotificationVerificationReq() |