Collapse all Symbian^3 Application Developer Library

RApaAppServiceBase Class Reference

class RApaAppServiceBase : public RSessionBase

Server app connection and lifetime monitoring functionality.

This is the base class for all server application service client support implementations.

The class is derived from by the UI framework and is further derived from by service implementations.

Clients of these server application services will use these derived classes as the interface to the server application implementations of the services.

REikAppServiceBase

Inherits from

RApaAppServiceBase
- RSessionBase
  - RHandleBase

Public Member Functions
IMPORT_C void	CancelNotifyServerExit ()
IMPORT_C void	Close ()
IMPORT_C void	ConnectExistingAppL (const RApaAppServiceBase &)
IMPORT_C void	ConnectExistingAppL (const RApaAppServiceBase &, const TSecurityPolicy &)
IMPORT_C void	ConnectExistingByNameL (const TDesC &)
IMPORT_C void	ConnectExistingByNameL (const TDesC &, const TSecurityPolicy &)
IMPORT_C void	NotifyServerExit ( TRequestStatus &)
IMPORT_C TPtrC	ServerName ()
IMPORT_C void	TransferExistingSessionL ( RApaAppServiceBase &)

Protected Member Functions
	RApaAppServiceBase ()

Private Member Functions
void	ConnectL ()
void	ConnectL (const TSecurityPolicy &)
IMPORT_C void	ExtensionInterface ( TUid , TAny *&)
IMPORT_C void	RApaAppServiceBase_Reserved1 ()
IMPORT_C void	RApaAppServiceBase_Reserved2 ()
TUid	ServiceUid ()

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	TApaAppServiceBaseCmdConstants { KSystemGuiCmdBase = 0x100, KServiceCmdBase = 0x200 }

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TInt	iApaReserved1
TInt	iApaReserved2
HBufC *	iServerName

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RApaAppServiceBase()

IMPORT_C

RApaAppServiceBase

(

)

[protected]

Protected constructor, instantiable services must derive from this class.

Member Functions Documentation

CancelNotifyServerExit()

IMPORT_C void

CancelNotifyServerExit

(

)

const

Cancels the request for notification of server application exit.

Close()

IMPORT_C void

(

)

Closes the service and the connection to the server app.

ConnectExistingAppL(const RApaAppServiceBase &)

IMPORT_C void

ConnectExistingAppL

(

const RApaAppServiceBase &

aClient

)

Connects to an already running server application, through an already connected service.

Parameters

const RApaAppServiceBase & aClient

A service which is already connected.

ConnectExistingAppL(const RApaAppServiceBase &, const TSecurityPolicy &)

IMPORT_C void	ConnectExistingAppL	(	const RApaAppServiceBase &	aClient,
			const TSecurityPolicy &	aSecurityPolicy
		)

Connects to an already running server application, through an already connected service. TSecurityPolicy

Parameters

const RApaAppServiceBase & aClient	A service which is already connected.
const TSecurityPolicy & aSecurityPolicy	The TSecurityPolicy which should be matched with the TSecurityPolicy of the app to be connected.

ConnectExistingByNameL(const TDesC &)

IMPORT_C void

ConnectExistingByNameL

(

const TDesC &

aName

)

Connects to an already running server application, by name.

Parameters

const TDesC & aName

The name of the server hosted by the server app.

ConnectExistingByNameL(const TDesC &, const TSecurityPolicy &)

IMPORT_C void	ConnectExistingByNameL	(	const TDesC &	aServerName,
			const TSecurityPolicy &	aSecurityPolicy
		)

Connects to an already running server application, by name. TSecurityPolicy

Parameters

const TDesC & aServerName
const TSecurityPolicy & aSecurityPolicy	The TSecurityPolicy which should be matched with the TSecurityPolicy of the app to be connected.

ConnectL()

void

ConnectL

(

)

[private]

ConnectL(const TSecurityPolicy &)

void

ConnectL

(

const TSecurityPolicy &

aSecurityPolicy

)

[private]

Parameters

const TSecurityPolicy & aSecurityPolicy

ExtensionInterface(TUid, TAny *&)

IMPORT_C void	ExtensionInterface	(	TUid	aInterfaceId,
			TAny *&	aImplementaion
		)	[private, virtual]

Extension mechanism - for internal BC proofing.

Parameters

TUid aInterfaceId
TAny *& aImplementaion

NotifyServerExit(TRequestStatus &)

IMPORT_C void

NotifyServerExit

(

TRequestStatus &

aStatus

)

const

Requests notification of server application exit. CApaServerAppExitMonitor

Parameters

TRequestStatus & aStatus

On completion, this contains the exit code of the server application.

RApaAppServiceBase_Reserved1()

IMPORT_C void

RApaAppServiceBase_Reserved1

(

)

[private, virtual]

RApaAppServiceBase_Reserved2()

IMPORT_C void

RApaAppServiceBase_Reserved2

(

)

[private, virtual]

ServerName()

IMPORT_C TPtrC

ServerName

(

)

const

Gets the name of the server hosted by the server application.

ServiceUid()

TUid

ServiceUid

(

)

const [private, pure virtual]

Returns the UID of the service that this session provides an interface for. Client side service implementations must implement this function to return the UID for the service that they implement.

TransferExistingSessionL(RApaAppServiceBase &)

IMPORT_C void

TransferExistingSessionL

(

RApaAppServiceBase &

aClient

)

Transfers the ownership of the session passed to self.

leave: KErrArgument The session passed is not connected.

panic: ApaAppClient 3 The client getting the ownership already has a connected session. Debug builds only.

Parameters

RApaAppServiceBase & aClient

A service which is already connected. On return, this service will be reset.

Member Enumerations Documentation

Enum TApaAppServiceBaseCmdConstants

Constants defining the base IPC command ids usable by the system GUI and services.

Enumerators

KSystemGuiCmdBase = 0x100	System GUI server app command IDs must start from this base.
KServiceCmdBase = 0x200	Service specific command IDs must start from this base.

Member Data Documentation

TInt iApaReserved1

TInt

iApaReserved1

[private]

TInt iApaReserved2

TInt

iApaReserved2

[private]

HBufC * iServerName

HBufC *

iServerName

[private]