Collapse all Symbian^3 Application Developer Library

CApaAppServiceBase Class Reference

class CApaAppServiceBase : public CSession2

Base class for all service implementations. Provides the basic IPC and security framework that server applications can use to receive messages from their clients. In a typical service implementation, a service support class will be derived from this class, and the service implementation will then be derived from the service support class.

Instances of this class are created by the server application in its override of CApaAppServer::CreateServiceL() .

CApaAppServer CPolicyServer

Inherits from

CApaAppServiceBase
- CSession2
  - CBase

Public Member Functions
	CApaAppServiceBase ()
	~CApaAppServiceBase ()
IMPORT_C CPolicyServer::TCustomResult	SecurityCheckL (const RMessage2 &, TInt &, TSecurityInfo &)
void	SendAppServerExitNotification ( TInt )

Protected Member Functions
IMPORT_C TInt	CountResources ()
IMPORT_C void	CreateL ()
IMPORT_C void	Disconnect (const RMessage2 &)
IMPORT_C void	ServiceError (const RMessage2 &, TInt )
IMPORT_C void	ServiceL (const RMessage2 &)

Private Member Functions
IMPORT_C void	CApaAppServiceBase_Reserved1 ()
IMPORT_C void	CApaAppServiceBase_Reserved2 ()
void	CancelNotifyServerExit (const RMessage2 &)
IMPORT_C void	ExtensionInterface ( TUid , TAny *&)
void	NotifyServerExit (const RMessage2 &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CSession2::CSession2()
	CSession2::Extension_(TUint,TAny &,TAny )
	CSession2::ResourceCountMarkEnd(const RMessage2 &)
	CSession2::ResourceCountMarkStart()
	CSession2::Server()const
	CSession2::SetServer(const CServer2 *)
	CSession2::~CSession2()

Inherited Enumerations
	CSession2:TPanicNo

Private Attributes
TInt	iApaReserved2
TInt	iExitReason
RMessagePtr2	iNotifyExitMsg

Constructor & Destructor Documentation

CApaAppServiceBase()

IMPORT_C

CApaAppServiceBase

(

)

Constructor.

~CApaAppServiceBase()

IMPORT_C

~CApaAppServiceBase

(

)

Destructor.

Member Functions Documentation

CApaAppServiceBase_Reserved1()

IMPORT_C void

CApaAppServiceBase_Reserved1

(

)

[private, virtual]

CApaAppServiceBase_Reserved2()

IMPORT_C void

CApaAppServiceBase_Reserved2

(

)

[private, virtual]

CancelNotifyServerExit(const RMessage2 &)

void

CancelNotifyServerExit

(

const RMessage2 &

aMessage

)

const [private]

Parameters

const RMessage2 & aMessage

CountResources()

IMPORT_C TInt

CountResources

(

)

[protected, virtual]

CreateL()

IMPORT_C void

CreateL

(

)

[protected, virtual]

An implementation of the CreateL() method from CSession2 . This can be further overridden by derived classes, but such implementations should also base-call.

Disconnect(const RMessage2 &)

IMPORT_C void

Disconnect

(

const RMessage2 &

aMessage

)

[protected, virtual]

Parameters

const RMessage2 & aMessage

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(const RMessage2 &)

void

NotifyServerExit

(

const RMessage2 &

aMessage

)

[private]

Parameters

const RMessage2 & aMessage

SecurityCheckL(const RMessage2 &, TInt &, TSecurityInfo &)

IMPORT_C CPolicyServer::TCustomResult	SecurityCheckL	(	const RMessage2 &	aMsg,
			TInt &	aAction,
			TSecurityInfo &	aMissing
		)	[virtual]

Virtual framework function that is called on receipt of a message from the client. This allows the service implementation to define a security policy for messages from the client. The default behaviour of this function is to pass security checks. CPolicyServer

Parameters

const RMessage2 & aMsg	The message to check.
TInt & aAction	A reference to the action to take if the security check fails. This is either a value from TFailureAction or a negative value which has meaning to the CustomFailureActionL() method of a derived class. The policy server framework gives this value a default of EFailClient. If a derived implementation wishes a different value, then it should change this.
TSecurityInfo & aMissing	A reference to the list of security attributes missing from the checked process. The policy server initialises this object to zero (that is a sid of 0, a vid of 0, and no capabilities). If derived implementations wish to take advantage of a list of missing attributes in their implementation of CustomFailureActionL(), then they should set those missing attributes here in CustomSecurityCheckL().

SendAppServerExitNotification(TInt)

void

SendAppServerExitNotification

(

TInt

aExitReason

)

Parameters

TInt aExitReason

ServiceError(const RMessage2 &, TInt)

IMPORT_C void	ServiceError	(	const RMessage2 &	aMessage,
			TInt	aError
		)	[protected, virtual]

Handle leave errors from ServiceL() .

Parameters

const RMessage2 & aMessage	The client message that was being processed when the leave occured.
TInt aError	The leave code.

ServiceL(const RMessage2 &)

IMPORT_C void

ServiceL

(

const RMessage2 &

aMessage

)

[protected, virtual]

Framework function to handle client messages. Derived classes should override this method to receive messages from the client. These messages should have function ids starting from REikAppServiceBase::KServiceCmdBase. The behaviour for any unrecognised messages must be to base-call.

panic: ApaAppServer 0 If this function does not recognise the function ID.

Parameters

const RMessage2 & aMessage

The clients request message.

Member Data Documentation

TInt iApaReserved2

TInt

iApaReserved2

[private]

TInt iExitReason

TInt

iExitReason

[private]

RMessagePtr2 iNotifyExitMsg

RMessagePtr2

iNotifyExitMsg

[private]