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.
Public Member Functions | |
---|---|
RPositionServer() | |
IMPORT_C TInt | CancelRequest(TRequestId) |
IMPORT_C void | Close() |
IMPORT_C TInt | Connect() |
IMPORT_C void | EmptyLastKnownPositionStore(TRequestStatus &) |
IMPORT_C TInt | GetDefaultModuleId(TPositionModuleId &) |
IMPORT_C TInt | GetModuleInfoById(TPositionModuleId, TPositionModuleInfoBase &) |
IMPORT_C TInt | GetModuleInfoByIndex(TInt, TPositionModuleInfoBase &) |
IMPORT_C TInt | GetModuleStatus(TPositionModuleStatusBase &, TPositionModuleId) |
IMPORT_C TInt | GetNumModules(TUint &) |
IMPORT_C void | NotifyModuleStatusEvent(TPositionModuleStatusEventBase &, TRequestStatus &, const TPositionModuleId) |
IMPORT_C TVersion | Version() |
Private Member Functions | |
---|---|
void | ConstructL() |
void | Destruct() |
TInt | StartServer() |
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 |
IMPORT_C TInt | CancelRequest | ( | TRequestId | aRequestId | ) |
TRequestId aRequestId |
IMPORT_C void | EmptyLastKnownPositionStore | ( | TRequestStatus & | aStatus | ) |
TRequestStatus & aStatus |
IMPORT_C TInt | GetDefaultModuleId | ( | TPositionModuleId & | aModuleId | ) | const |
TPositionModuleId & aModuleId |
IMPORT_C TInt | GetModuleInfoById | ( | TPositionModuleId | aModuleId, |
TPositionModuleInfoBase & | aModuleInfo | |||
) | const |
TPositionModuleId aModuleId | |
TPositionModuleInfoBase & aModuleInfo |
IMPORT_C TInt | GetModuleInfoByIndex | ( | TInt | aModuleIndex, |
TPositionModuleInfoBase & | aModuleInfo | |||
) | const |
TInt aModuleIndex | |
TPositionModuleInfoBase & aModuleInfo |
IMPORT_C TInt | GetModuleStatus | ( | TPositionModuleStatusBase & | aPosModuleStatus, |
TPositionModuleId | aModuleId | |||
) | const |
TPositionModuleStatusBase & aPosModuleStatus | |
TPositionModuleId aModuleId |
IMPORT_C TInt | GetNumModules | ( | TUint & | aNumModules | ) | const |
TUint & aNumModules |
IMPORT_C void | NotifyModuleStatusEvent | ( | TPositionModuleStatusEventBase & | aStatusEvent, |
TRequestStatus & | aStatus, | |||
const TPositionModuleId | aModuleId = KPositionNullModuleId | |||
) | const |
TPositionModuleStatusEventBase & aStatusEvent | |
TRequestStatus & aStatus | |
const TPositionModuleId aModuleId = KPositionNullModuleId |
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.
EReqUnknown = 0 |
Unknown/undefined Id |
EReqNotifyModuleStatusEvent = 1 |
The id of the RPositionServer::NotifyModuleStatusEvent request |
EReqEmptyLastKnownPositionStore = 2 |
The id of the RPositionServer::EmptyLastKnownPositionStore request |