Class RPositionerSubSessionBase

class RPositionerSubSessionBase : public RSubSessionBase;

Description

Abstract base class for all positioning sub-sessions, including RPositioner.

Derivation

• RSubSessionBase - Client-side handle to a sub-session.

• RPositionerSubSessionBase - Abstract base class for all positioning sub-sessions, including RPositioner.

Members

Defined in RPositionerSubSessionBase:

• CancelRequest(TInt)Cancels a previously issued asynchronous request. The TRequestStatus of the orig...
• CompleteRequest(TInt)Completes the outstanding request method identified by aRequestId. This results ...
• ExtendedInterface(TInt,TAny *,TAny *)This method is used to allow polymorphic extensions to the API without breaking ...
• RPositionerSubSessionBase()Constructor for the abstract base class RPositionerSubSessionBase

Inherited from RSubSessionBase:

• CloseSubSession(TInt)Closes the sub-session.
• CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session. The new sub-session takes ...
• CreateSubSession(const RSessionBase &,TInt)Creates a new sub-session within an existing session.
• CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session.
• Send(TInt)constSends a blind message to the server - no reply is expected.
• Send(TInt,const TIpcArgs &)constSends a blind message to the server - no reply is expected.
• SendReceive(TInt)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• SendReceive(TInt,const TIpcArgs &)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• Session()constReturns a copy of the session associated with this sub-session.
• SubSessionHandle()constGets the sub-session handle number.

See also:

• RPositionerThis class is used to create a sub-session with the server for the purpose of ob...

protected: IMPORT_C RPositionerSubSessionBase();

Description

Constructor for the abstract base class RPositionerSubSessionBase

IMPORT_C TInt CancelRequest(TInt aRequestId);

Description

Cancels a previously issued asynchronous request. The TRequestStatus of the original request will be set to KErrCancel if the cancellation request was successful, or any other Symbian OS error code if CancelRequest was called too late.

Parameters

TInt aRequestId A value that uniquely identifies the client side method to be cancelled. EPositionerNotifyPositionUpdate to cancel a call from RPositioner::NotifyPositionUpdate(TPositionInfoBase &,TRequestStatus &)const. EPositionerGetLastKnownPosition to cancel a call from RPositioner::GetLastKnownPosition(TPositionInfoBase &,TRequestStatus &)const.

Return value

TInt a Standard Symbian OS error code.

IMPORT_C TInt CompleteRequest(TInt aRequestId);

Description

Completes the outstanding request method identified by aRequestId. This results in the outstanding request being completed immediately. Any currently available information is returned to the application via the usual mechanism. This data may be different from what would be returned if the request had been allowed to finish under the normal circumstances.

Note in particular, RPositionerSubSessionBase::CompleteRequest(TInt) does not cancel the request.

The only currently supported request that can be completed early is RPositioner::NotifyPositionUpdate(TPositionInfoBase &,TRequestStatus &)const. The parameter aRequestId must be set to EPositionerNotifyPositionUpdate.

If the request has finished ealier than normal, the TRequestStatus of the completed request will hold the value KPositionEarlyComplete

Parameters

TInt aRequestId A value that uniquely identifies the client side method to be completed. Only EPositionerNotifyPositionUpdate is supported.

Return value

TInt KErrNone is returned if aRequestId specifies a request that will be completed early. KErrNotFound is returned if aRequestId specifies a request that is not currently active. KErrNotSupported is returned if the parameter aRequestId is invalid

protected: IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny *aPtr1, TAny *aPtr2);

Description

This method is used to allow polymorphic extensions to the API without breaking BC. See documentation for explanation.

Parameters

TInt aFunctionNumber contains the Id of the function to be invoked. TAny *aPtr1 a pointer to any data TAny *aPtr2 a pointer to any data.

Return value

TAny * TAny* a pointer to any function