GlLppEngine Class Reference

Interface to GL LPP protocol stack. More...

#include <gllpp.h>

List of all members.

Public Member Functions

virtual void Dispose (void)=0
 Dispose of a GlLppEngine after use.
virtual void Abort (OSUINT32 sessionId)=0
 Abort LPP location session.
virtual void AbortAll (void)=0
 Abort all LPP location sessions.
virtual void SetRetransmissionTimer (unsigned long t)=0
 Allows to customize value for retransmission timer.
virtual void OnTimeout (void)=0
 Timer timeout.
virtual void OnDataReceived (OSUINT32 sessionId, const OSOCTET *data, size_t len)=0
 Pass data received from LPP server to GL LPP protocol stack.
virtual void OnWriteComplete (OSUINT32 requestId, OSUINT32 sessionId, bool success)=0
 Called when Write() finishes.
virtual void ProvidePrimaryCellId (const GLLPP_ECGI *pCellId)=0
 Provide Primary Cell Id for the GL LPP protocol stack.
virtual void ProvideGnssCapabilities (const GLLPP_A_GNSS_Capabilities *pCap)=0
 Provide GNSS capabilities to LPP server.
virtual void RequestGnssAssistanceData (const GLLPP_A_GNSS_RequestAssistanceData *pRequestAssistanceData)=0
 Requests GNSS assistance data from LPP server.
virtual void ProvideGnssMeasurementForOneConstellation (const GLLPP_GNSS_MeasurementForOneGNSS *pMeasurement)=0
 Provide GNSS measurements to LPP server.
virtual void ProvideGnssMeasurementReferenceTime (const GLLPP_MeasurementReferenceTime *pMeasurementReferenceTime)=0
 Provide GNSS measurements to LPP server.
virtual void ProvideGnssLocationInformation (const GLLPP_GNSS_LocationInformation *pLocationInformation, const GLLPP_CommonIEsLocationInformation *pCommonIEs)=0
 Provide GNSS location information to LPP server.
virtual void ProvideGnssError (const GLLPP_A_GNSS_Error *pError)=0
 Provide GNSS location information to LPP server.
virtual void ProvideOtdoaCapabilities (const GLLPP_OTDOA_Capabilities *pCap)=0
 Provide OTDOA capabilities to LPP server.
virtual void ProvideOtdoaLocationInformation (const GLLPP_OTDOA_LocationInformation *pLocationInformation)=0
 Provide OTDOA location information to LPP server.
virtual void RequestOtdoaAssistanceData (OSUINT16 physCellId)=0
 Requests OTDOA assistance data from LPP server.
virtual void ProvideEcidCapabilities (const GLLPP_ECID_Capabilities *pCap)=0
 Provide ECID capabilities to LPP server.
virtual void ProvideEcidLocationInformation (const GLLPP_ECID_LocationInformation *pLocationInformation)=0
 Provide ECID location information to LPP server.

Protected Member Functions

virtual ~GlLppEngine (void)

Detailed Description

Interface to GL LPP protocol stack.


Constructor & Destructor Documentation

virtual GlLppEngine::~GlLppEngine ( void  ) [inline, protected, virtual]
Note:
Do not call destructor directly. Call Dispose() instead.

Member Function Documentation

virtual void GlLppEngine::Abort ( OSUINT32  sessionId) [pure virtual]

Abort LPP location session.

Parameters:
sessionId- LPP location session identifier
virtual void GlLppEngine::OnDataReceived ( OSUINT32  sessionId,
const OSOCTET *  data,
size_t  len 
) [pure virtual]

Pass data received from LPP server to GL LPP protocol stack.

Parameters:
sessionId- LPP location session identifier
data- pointer to the buffer containing the bytes.
len- number of bytes received
virtual void GlLppEngine::OnWriteComplete ( OSUINT32  requestId,
OSUINT32  sessionId,
bool  success 
) [pure virtual]

Called when Write() finishes.

Parameters:
requestId- identify which Write() this function is responding to
sessionId- LPP location session identifier
success- indicate was data sent or not
Note:
This should be response on Write()
virtual void GlLppEngine::ProvideEcidCapabilities ( const GLLPP_ECID_Capabilities pCap) [pure virtual]

Provide ECID capabilities to LPP server.

Parameters:
pCap- ECID capabilities
virtual void GlLppEngine::ProvideEcidLocationInformation ( const GLLPP_ECID_LocationInformation *  pLocationInformation) [pure virtual]

Provide ECID location information to LPP server.

Parameters:
pLocationInformation- ECID location information
virtual void GlLppEngine::ProvideGnssCapabilities ( const GLLPP_A_GNSS_Capabilities pCap) [pure virtual]

Provide GNSS capabilities to LPP server.

Parameters:
pCap- GNSS capabilities
virtual void GlLppEngine::ProvideGnssError ( const GLLPP_A_GNSS_Error pError) [pure virtual]

Provide GNSS location information to LPP server.

Parameters:
pError- GNSS location error This parameter should be NULL if there was no GNSS location error
Note:
Stack will be waiting this function to be called before sending GNSS location information to LPP server.
virtual void GlLppEngine::ProvideGnssLocationInformation ( const GLLPP_GNSS_LocationInformation pLocationInformation,
const GLLPP_CommonIEsLocationInformation pCommonIEs 
) [pure virtual]

Provide GNSS location information to LPP server.

Parameters:
pLocationInformation- GNSS location information This parameter can be NULL.
pCommonIEs- common IEs for a Provide Location Information This parameter can be NULL.
Note:
Stack will be waiting this function to be called before sending GNSS location information to LPP server.

Provide GNSS measurements to LPP server.

Parameters:
pMeasurement- GNSS measurements
Note:
Stack will be waiting for more measurements until ProvideGnssMeasurementReferenceTime() is called.
virtual void GlLppEngine::ProvideGnssMeasurementReferenceTime ( const GLLPP_MeasurementReferenceTime pMeasurementReferenceTime) [pure virtual]

Provide GNSS measurements to LPP server.

Parameters:
pMeasurementReferenceTime- timestamp for GNSS measurements This parameter should be NULL if no GNSS measurements are available.
Note:
Stack will be waiting this function to be called before sending GNSS location information to LPP server.
virtual void GlLppEngine::ProvideOtdoaCapabilities ( const GLLPP_OTDOA_Capabilities pCap) [pure virtual]

Provide OTDOA capabilities to LPP server.

Parameters:
pCap- OTDOA capabilities
virtual void GlLppEngine::ProvideOtdoaLocationInformation ( const GLLPP_OTDOA_LocationInformation *  pLocationInformation) [pure virtual]

Provide OTDOA location information to LPP server.

Parameters:
pLocationInformation- OTDOA location information
virtual void GlLppEngine::ProvidePrimaryCellId ( const GLLPP_ECGI pCellId) [pure virtual]

Provide Primary Cell Id for the GL LPP protocol stack.

Parameters:
pCellId- primary cell id
Note:
This should be response on RequestPrimaryCellId()
virtual void GlLppEngine::RequestGnssAssistanceData ( const GLLPP_A_GNSS_RequestAssistanceData pRequestAssistanceData) [pure virtual]

Requests GNSS assistance data from LPP server.

Parameters:
pRequestAssistanceData- what AD is requested
virtual void GlLppEngine::RequestOtdoaAssistanceData ( OSUINT16  physCellId) [pure virtual]

Requests OTDOA assistance data from LPP server.

Parameters:
physCellId- physical cell identity of the assistance data reference cell
virtual void GlLppEngine::SetRetransmissionTimer ( unsigned long  t) [pure virtual]

Allows to customize value for retransmission timer.

Parameters:
t- retransmission timer in milliseconds, default value is 1000 ms.

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines