Collapse all Symbian^3 Product Developer Library

CAknCommonNotifierWrapper Class Reference

class CAknCommonNotifierWrapper : public CAknNotifierWrapper

Inherits from

CAknCommonNotifierWrapper
- CAknNotifierWrapper
  - CAknNotifierWrapperLight
    - CBase

Nested Classes and Structures

CAknCommonNotifierWrapper::TPendingMsg

Public Member Functions
	~CAknCommonNotifierWrapper()
void	AppServerConnectedL()
const TUid &	AppServerUid()
void	CancelNotifier(TUid)
IMPORT_C CAknCommonNotifierWrapper *	NewL(TUid, TUid, TInt, const TDesC &, TUint, TBool)
TBool	PreLoadLibrary()
IMPORT_C void	PreLoadLibraryL()
TNotifierInfo	RegisterL()
IMPORT_C void	SetCustomSecurityHandler(MAknNotifierCustomSecurityCheck *)
void	StartNotifierL(TUid, const TDesC8 &, TInt, const RMessagePtr2 &)
TPtrC8	StartNotifierL(TUid, const TDesC8 &)

Private Member Functions
	CAknCommonNotifierWrapper(TUid, TUid, TInt, TBool)
void	ConstructL(const TDesC &, TUint)
void	HandleServerAppExit(TInt)

Inherited Functions
	CAknNotifierWrapper::AsyncMessageCompleted(CAknNotifierMessageObserver *)
	CAknNotifierWrapper::CAknNotifierWrapper(TUid,TUid,TInt)
	CAknNotifierWrapper::Client()
	CAknNotifierWrapper::CreateNewQueueEntryL(TUid,const TDesC8 &,TInt,const RMessagePtr2 &)
	CAknNotifierWrapper::DoNotifierControllerCommand(TInt)
	CAknNotifierWrapper::NewL(TUid,TUid,TInt,TUid,TUint)
	CAknNotifierWrapper::SetSynchReplybuf(HBufC8 *)
	CAknNotifierWrapper::SynchronousReplyBuf()
	CAknNotifierWrapper::UpdateNotifierL(TUid,const TDesC8 &)
	CAknNotifierWrapper::UpdateNotifierL(TUid,const TDesC8 &,TInt,const RMessagePtr2 &)
	CAknNotifierWrapper::~CAknNotifierWrapper()
	CAknNotifierWrapperLight::CAknNotifierWrapperLight(MAknNotifierWrapper &,TUid,TUid,TInt)
	CAknNotifierWrapperLight::Cancel()
	CAknNotifierWrapperLight::Info()const
	CAknNotifierWrapperLight::NotifierCapabilites()
	CAknNotifierWrapperLight::Release()
	CAknNotifierWrapperLight::StartL(const TDesC8 &)
	CAknNotifierWrapperLight::StartL(const TDesC8 &,TInt,const RMessagePtr2 &)
	CAknNotifierWrapperLight::UpdateL(const TDesC8 &)
	CAknNotifierWrapperLight::UpdateL(const TDesC8 &,TInt,const RMessagePtr2 &)
	CAknNotifierWrapperLight::~CAknNotifierWrapperLight()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Private Attributes
MAknNotifierCustomSecurityCheck *	iCustomSecurityCheck
CIdle *	iIdle
HBufC *	iLibraryName
CApaServerAppExitMonitor *	iMonitor
RArray< TPendingMsg >	iPendingArray
TBool	iPreLoad

Constructor & Destructor Documentation

CAknCommonNotifierWrapper(TUid, TUid, TInt, TBool)

CAknCommonNotifierWrapper	(	TUid	aNotifierUid,
		TUid	aChannel,
		TInt	aPriority,
		TBool	aPreLoad
	)	[private]

Parameters

TUid aNotifierUid
TUid aChannel
TInt aPriority
TBool aPreLoad

~CAknCommonNotifierWrapper()

~CAknCommonNotifierWrapper

(

)

Member Functions Documentation

AppServerConnectedL()

void

AppServerConnectedL

(

)

AppServerUid()

const TUid &

AppServerUid

(

)

const [inline]

CancelNotifier(TUid)

void

CancelNotifier

(

TUid

aNotifierUid

)

Parameters

TUid aNotifierUid

ConstructL(const TDesC &, TUint)

void	ConstructL	(	const TDesC &	aLibraryName,
			TUint	aReplyBufSize
		)	[private]

Parameters

const TDesC & aLibraryName
TUint aReplyBufSize

HandleServerAppExit(TInt)

void

HandleServerAppExit

(

TInt

aReason

)

[private]

Parameters

TInt aReason

NewL(TUid, TUid, TInt, const TDesC &, TUint, TBool)

IMPORT_C CAknCommonNotifierWrapper *	NewL	(	TUid	aNotifierUid,
			TUid	aChannel,
			TInt	aPriority,
			const TDesC &	aLibraryName,
			TUint	aReplyBufSize,
			TBool	aPreload = EFalse
		)	[static]

Static constructor. This does not connect (nor create) app server, but the server is created when RegisterL is being called by Symbian FW. Real connection to app server is formed during first actual notifier request.

Since: 3.1

Parameters

TUid aNotifierUid	Uid of this notifier, returned in Info().
TUid aChannel	Channel uid of this notifier, returned in Info().
TInt aPriority	Priority of this notifier, see declaration of MEikSrvNotifierBase2, returned in Info().
const TDesC & aLibraryName
TUint aReplyBufSize	Size of a reply buffer used in synchrouns notifier requests.
TBool aPreload = EFalse

PreLoadLibrary()

TBool

PreLoadLibrary

(

)

PreLoadLibraryL()

IMPORT_C void

PreLoadLibraryL

(

)

Loads the notifier plugin once app server is available. Keeps this plugin (aLibraryName in constructor). always loaded

Since: 3.1

RegisterL()

TNotifierInfo

RegisterL

(

)

SetCustomSecurityHandler(MAknNotifierCustomSecurityCheck *)

IMPORT_C void

SetCustomSecurityHandler

(

MAknNotifierCustomSecurityCheck *

aHandler

)

Sets custom security checking object, ownership taken. When ever notifier wrapper receives a command with actual message message is first passed to given object.

If callback (CustomSecurityCheckL()) does not leave, it is assumed that security checking was successfully passed.

Since: 3.1

Parameters

MAknNotifierCustomSecurityCheck * aHandler

StartNotifierL(TUid, const TDesC8 &, TInt, const RMessagePtr2 &)

void	StartNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer,
			TInt	aReplySlot,
			const RMessagePtr2 &	aMessage
		)

Parameters

TUid aNotifierUid
const TDesC8 & aBuffer
TInt aReplySlot
const RMessagePtr2 & aMessage

StartNotifierL(TUid, const TDesC8 &)

TPtrC8	StartNotifierL	(	TUid	aNotifierUid,
			const TDesC8 &	aBuffer
		)

Parameters

TUid aNotifierUid
const TDesC8 & aBuffer

Member Data Documentation

MAknNotifierCustomSecurityCheck * iCustomSecurityCheck

MAknNotifierCustomSecurityCheck *

iCustomSecurityCheck

[private]

CIdle * iIdle

CIdle *

iIdle

[private]

HBufC * iLibraryName

HBufC *

iLibraryName

[private]

CApaServerAppExitMonitor * iMonitor

CApaServerAppExitMonitor *

iMonitor

[private]

RArray< TPendingMsg > iPendingArray

RArray< TPendingMsg >

iPendingArray

[private]

TBool iPreLoad

TBool

iPreLoad

[private]