GlSuplHal Class Reference

SUPL HAL interface. More...

#include <glsuplapi.h>

List of all members.

Public Member Functions

virtual void * MemAlloc (size_t size)=0
 Allocate memory buffer.
virtual void MemFree (void *p)=0
 Deallocate memory buffer.
virtual void Log (int sev, OSUINT32 mod_mask, const char *fmt, OSVALIST argptr)=0
 Log message.
virtual void ExceptionAssert (const char *file, unsigned int line, const char *msg)=0
 Exception Assert.
virtual unsigned long GetMsTime (void) const =0
 Get Time.
virtual void RequestConnection (void)=0
 Request connection to SUPL server.
virtual void CloseConnection (void)=0
 Inform that connection to SUPL server can be closed.
virtual void Write (const unsigned char *data, size_t nBytes)=0
 Write the encoded bytes to the network.
virtual bool Arm (unsigned long msec)=0
 Arm timer.
virtual bool Disarm (void)=0
 Disarm timer.
virtual void RequestLocationId (void)=0
 Request the Cell Information.
virtual void RequestOtdoaCapabilities (void)=0
 Request OTDOA capabilities.
virtual void RequestOtdoaLocationInformation (const GLLPP_OTDOA_RequestLocationInformation *pReqLoc, const GLLPP_CommonIEs *pCommonIEs)=0
 Request OTDOA location information.
virtual void ProvideOtdoaAssistanceData (const GLLPP_OTDOA_AssistanceData *pAssistanceData, bool endTransaction)=0
 Provide OTDOA assistance data.
virtual void RequestEcidCapabilities (void)=0
 Request ECID capabilities.
virtual void RequestEcidLocationInformation (const GLLPP_ECID_requestedMeasurements *pReqMeas, const GLLPP_CommonIEs *pCommonIEs)=0
 Request ECID measurements.
virtual void NotificationVerificationReq (const GLSUPL_Notification *notif)=0
 Called by the SUPL engine after receiving SUPL-INIT message.
virtual void OnAidingReceived (bool success)=0
 Called by the SUPL engine after receiving aiding data or if failed to receive AD.
virtual void SaveLto (const unsigned char *buf, int size)=0
 SUPL2: Save GPS Extened Ephemeris (LTO) to file.
virtual INetReporterGetNetReporter ()=0
 NetReporter produces NMEA $PGLOR,NET sentences to indicate network related activities.
virtual void * MemAlloc (size_t size)=0
 Allocate memory buffer.
virtual void MemFree (void *p)=0
 Deallocate memory buffer.
virtual void Log (int sev, OSUINT32 mod_mask, const char *fmt, OSVALIST argptr)=0
 Log message.
virtual void ExceptionAssert (const char *file, unsigned int line, const char *msg)=0
 Exception Assert.
virtual void RequestConnection (void)=0
 Request connection to SUPL server.
virtual void CloseConnection (void)=0
 Inform that connection to SUPL server can be closed.
virtual void Write (const unsigned char *data, size_t nBytes)=0
 Write the encoded bytes to the network.
virtual bool Arm (unsigned long msec)=0
 Arm timer.
virtual bool Disarm (void)=0
 Disarm timer.
virtual void RequestLocationId (void)=0
 Request the Cell Information.
virtual void NotificationVerificationReq (const GLSUPL_Notification *notif)=0
 Called by the SUPL engine after receiving SUPL-INIT message.
virtual void OnAidingReceived (bool success)=0
 Called by the SUPL engine after receiving aiding data or if failed to receive AD.
virtual INetReporterGetNetReporter ()=0
 NetReporter produces NMEA $PGLOR,NET sentences to indicate network related activities.

Detailed Description

SUPL HAL interface.


Member Function Documentation

virtual unsigned long GlSuplHal::GetMsTime ( void  ) const [pure virtual]

Get Time.

Returns:
monotonically increasing value scaled to milliseconds that may roll over (2^32 -> 0).
virtual void GlSuplHal::Log ( int  sev,
OSUINT32  mod_mask,
const char *  fmt,
OSVALIST  argptr 
) [pure virtual]

Log message.

Parameters:
sev- log level
mod_mask- module mask
fmt- printf format
argptr- variables for printf formating
virtual void GlSuplHal::Log ( int  sev,
OSUINT32  mod_mask,
const char *  fmt,
OSVALIST  argptr 
) [pure virtual]

Log message.

Parameters:
sev- log level
mod_mask- module mask
fmt- printf format
argptr- variables for printf formating
virtual void* GlSuplHal::MemAlloc ( size_t  size) [pure virtual]

Allocate memory buffer.

Note: Returned pointer should be properly aligned.

Parameters:
size- size of required memory
virtual void* GlSuplHal::MemAlloc ( size_t  size) [pure virtual]

Allocate memory buffer.

Note: Returned pointer should be properly aligned.

Parameters:
size- size of required memory
virtual void GlSuplHal::MemFree ( void *  p) [pure virtual]

Deallocate memory buffer.

Parameters:
p- pointer to previously allocated buffer
virtual void GlSuplHal::MemFree ( void *  p) [pure virtual]

Deallocate memory buffer.

Parameters:
p- pointer to previously allocated buffer
virtual void GlSuplHal::NotificationVerificationReq ( const GLSUPL_Notification notif) [pure virtual]

Called by the SUPL engine after receiving SUPL-INIT message.

Inform that SLP requests for Notification & Verification

Parameters:
notif- Describes the notification/verification mechanism to be applied. Note: Application should respond with VerificationRsp() only if notification types are: GLSUPL_notificationAndVerficationAllowedNA or GLSUPL_notificationAndVerficationDeniedNA
virtual void GlSuplHal::NotificationVerificationReq ( const GLSUPL_Notification notif) [pure virtual]

Called by the SUPL engine after receiving SUPL-INIT message.

Inform that SLP requests for Notification & Verification

Parameters:
notif- Describes the notification/verification mechanism to be applied. Note: Application should respond with VerificationRsp() only if notification types are: GLSUPL_notificationAndVerficationAllowedNA or GLSUPL_notificationAndVerficationDeniedNA
virtual void GlSuplHal::OnAidingReceived ( bool  success) [pure virtual]

Called by the SUPL engine after receiving aiding data or if failed to receive AD.

Parameters:
success- Indicates if AD was received successfuly
virtual void GlSuplHal::OnAidingReceived ( bool  success) [pure virtual]

Called by the SUPL engine after receiving aiding data or if failed to receive AD.

Parameters:
success- Indicates if AD was received successfuly
virtual void GlSuplHal::ProvideOtdoaAssistanceData ( const GLLPP_OTDOA_AssistanceData *  pAssistanceData,
bool  endTransaction 
) [pure virtual]

Provide OTDOA assistance data.

Parameters:
pAssistanceData- received assistance data. This parameter could be NULL
endTransaction- indicate that there are no more assistance data
virtual void GlSuplHal::RequestConnection ( void  ) [pure virtual]

Request connection to SUPL server.

Note: SUPL Protocol stack will wait for OnConnected() call which will inform about the result of this request.

virtual void GlSuplHal::RequestConnection ( void  ) [pure virtual]

Request connection to SUPL server.

Note: SUPL Protocol stack will wait for OnConnected() call which will inform about the result of this request.

virtual void GlSuplHal::RequestEcidCapabilities ( void  ) [pure virtual]

Request ECID capabilities.

Note:
Stack will be waiting until ProvideEcidCapabilities() is called
virtual void GlSuplHal::RequestEcidLocationInformation ( const GLLPP_ECID_requestedMeasurements *  pReqMeas,
const GLLPP_CommonIEs pCommonIEs 
) [pure virtual]

Request ECID measurements.

Parameters:
pReqMeas- indicate what measurements are requested. If this parameter is NULL then measurements are no longer needed.
pCommonIEs- common IEs for a Request Location Information
Note:
If measurements were requested on cell change, then SUPL engine will call this function with pReqMeas parameter set to NULL in order to stop reporting of measurements.
Stack will be waiting until ProvideEcidLocationInformation() is called
virtual void GlSuplHal::RequestOtdoaCapabilities ( void  ) [pure virtual]

Request OTDOA capabilities.

Note:
Stack will be waiting until ProvideOtdoaCapabilities() is called
virtual void GlSuplHal::RequestOtdoaLocationInformation ( const GLLPP_OTDOA_RequestLocationInformation *  pReqLoc,
const GLLPP_CommonIEs pCommonIEs 
) [pure virtual]

Request OTDOA location information.

Parameters:
pReqLoc- indicates if Assistance can be requested If this parameter is NULL then location information is no longer needed.
pCommonIEs- common IEs for a Request Location Information
Note:
Stack will be waiting until ProvideOtdoaLocationInformation() is called
virtual void GlSuplHal::Write ( const unsigned char *  data,
size_t  nBytes 
) [pure virtual]

Write the encoded bytes to the network.

Parameters:
data- [in] address of buffer for send.
nBytes- [in] length of buffer.
virtual void GlSuplHal::Write ( const unsigned char *  data,
size_t  nBytes 
) [pure virtual]

Write the encoded bytes to the network.

Parameters:
data- [in] address of buffer for send.
nBytes- [in] length of buffer.

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