RPositionServer Class Reference

class RPositionServer : public RSessionBase

This is generally the first interface class used by all client applications. It is used to make the primary connection to the location server. After the primary connection has been established, its handle is passed as a parameter of the Open methods of RPositioner to create a "sub-session".

The RPositionServer class can also be used to discover what position technology "modules" are available. However, this is only required if a client application actually needs to use a particular module. It is also used for requests to clear(empty) the last known position store.

Asynchronous requests can be cancelled using the method CancelRequest() with a value from the enumeration _TReqestId corresponding to the particular operation being cancelled.

Inherits from

Public Member Functions
RPositionServer()
IMPORT_C TIntCancelRequest(TRequestId)
IMPORT_C voidClose()
IMPORT_C TIntConnect()
IMPORT_C voidEmptyLastKnownPositionStore(TRequestStatus &)
IMPORT_C TIntGetDefaultModuleId(TPositionModuleId &)
IMPORT_C TIntGetModuleInfoById(TPositionModuleId, TPositionModuleInfoBase &)
IMPORT_C TIntGetModuleInfoByIndex(TInt, TPositionModuleInfoBase &)
IMPORT_C TIntGetModuleStatus(TPositionModuleStatusBase &, TPositionModuleId)
IMPORT_C TIntGetNumModules(TUint &)
IMPORT_C voidNotifyModuleStatusEvent(TPositionModuleStatusEventBase &, TRequestStatus &, const TPositionModuleId)
IMPORT_C TVersionVersion()
Private Member Functions
voidConstructL()
voidDestruct()
TInt StartServer()
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Public Member Enumerations
enum_TRequestId { EReqUnknown = 0, EReqNotifyModuleStatusEvent = 1, EReqEmptyLastKnownPositionStore = 2 }
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Public Member Type Definitions
typedef TInt TRequestId
Private Attributes
CServerPositioningPtrHolder *iPtrHolder
TAny *iReserved
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RPositionServer()

IMPORT_CRPositionServer()

Member Functions Documentation

CancelRequest(TRequestId)

IMPORT_C TIntCancelRequest(TRequestIdaRequestId)

Parameters

TRequestId aRequestId

Close()

IMPORT_C voidClose()

Connect()

IMPORT_C TIntConnect()

ConstructL()

voidConstructL()[private]

Destruct()

voidDestruct()[private]

EmptyLastKnownPositionStore(TRequestStatus &)

IMPORT_C voidEmptyLastKnownPositionStore(TRequestStatus &aStatus)

Parameters

TRequestStatus & aStatus

GetDefaultModuleId(TPositionModuleId &)

IMPORT_C TIntGetDefaultModuleId(TPositionModuleId &aModuleId)const

Parameters

TPositionModuleId & aModuleId

GetModuleInfoById(TPositionModuleId, TPositionModuleInfoBase &)

IMPORT_C TIntGetModuleInfoById(TPositionModuleIdaModuleId,
TPositionModuleInfoBase &aModuleInfo
)const

Parameters

TPositionModuleId aModuleId
TPositionModuleInfoBase & aModuleInfo

GetModuleInfoByIndex(TInt, TPositionModuleInfoBase &)

IMPORT_C TIntGetModuleInfoByIndex(TIntaModuleIndex,
TPositionModuleInfoBase &aModuleInfo
)const

Parameters

TInt aModuleIndex
TPositionModuleInfoBase & aModuleInfo

GetModuleStatus(TPositionModuleStatusBase &, TPositionModuleId)

IMPORT_C TIntGetModuleStatus(TPositionModuleStatusBase &aPosModuleStatus,
TPositionModuleIdaModuleId
)const

Parameters

TPositionModuleStatusBase & aPosModuleStatus
TPositionModuleId aModuleId

GetNumModules(TUint &)

IMPORT_C TIntGetNumModules(TUint &aNumModules)const

Parameters

TUint & aNumModules

NotifyModuleStatusEvent(TPositionModuleStatusEventBase &, TRequestStatus &, const TPositionModuleId)

IMPORT_C voidNotifyModuleStatusEvent(TPositionModuleStatusEventBase &aStatusEvent,
TRequestStatus &aStatus,
const TPositionModuleIdaModuleId =  KPositionNullModuleId
)const

Parameters

TPositionModuleStatusEventBase & aStatusEvent
TRequestStatus & aStatus
const TPositionModuleId aModuleId =  KPositionNullModuleId

StartServer()

TInt StartServer()[private, static]

Version()

IMPORT_C TVersionVersion()const

Member Enumerations Documentation

Enum _TRequestId

Identification numbers used for cancelling requests. Note that the TRequestId enum may be extended in the future by adding more enumerated values. To maintain compatibility any unrecognized values must be handled as EReqUnknown.

Enumerators

EReqUnknown = 0

Unknown/undefined Id

EReqNotifyModuleStatusEvent = 1

The id of the RPositionServer::NotifyModuleStatusEvent request

EReqEmptyLastKnownPositionStore = 2

The id of the RPositionServer::EmptyLastKnownPositionStore request

Member Type Definitions Documentation

Typedef TRequestId

typedef TInt TRequestId

Type for values defined in _TRequestId

Member Data Documentation

CServerPositioningPtrHolder * iPtrHolder

CServerPositioningPtrHolder *iPtrHolder[private]

A pointer to a container that holds pointer descriptors, needed to point to the clients request data during asynchronous requests

TAny * iReserved

TAny *iReserved[private]

Variable for future expansion.