Collapse all Symbian^3 Application Developer Library

MHtiDispatcher Class Reference

class MHtiDispatcher

Interface to the HTI dispatcher used by service plug-ins for message sending.

Public Member Functions
void	AddMemoryObserver ( MHtiMemoryObserver *)
TInt	DispatchOutgoingErrorMessage ( TInt , const TDesC8 &, const TUid )
TInt	DispatchOutgoingMessage ( TDesC8 *, const TUid , TBool , THtiMessagePriority )
TInt	DispatchOutgoingMessage ( TDesC8 *, const TUid )
CConsoleBase *	GetConsole ()
TInt	GetFreeMemory ()
void	Notify ( TInt )
void	RemoveMemoryObserver ( MHtiMemoryObserver *)
void	ShutdownAndRebootDeviceL ()

Member Functions Documentation

AddMemoryObserver(MHtiMemoryObserver *)

void

AddMemoryObserver

(

MHtiMemoryObserver *

anObserver

)

[pure virtual]

Adds memory observer.

Parameters

MHtiMemoryObserver * anObserver

memory observer

DispatchOutgoingErrorMessage(TInt, const TDesC8 &, const TUid)

TInt	DispatchOutgoingErrorMessage	(	TInt	aErrorCode,
			const TDesC8 &	aErrorDescription,
			const TUid	aTargetServiceUid
		)	[pure virtual]

Parameters

TInt aErrorCode
const TDesC8 & aErrorDescription
const TUid aTargetServiceUid

DispatchOutgoingMessage(TDesC8 *, const TUid, TBool, THtiMessagePriority)

TInt	DispatchOutgoingMessage	(	TDesC8 *	aMessage,
			const TUid	aTargetServiceUid,
			TBool	aWrappedFlag,
			THtiMessagePriority	aPriority
		)	[pure virtual]

Send message from the service back to host client. Transfer ownership of aMessage. The function adds messages to the outgoing queue. Message will be actualy sent later. Function can return KErrNoMemory if there is not enough memory to add it to the queue. Plug-in use AddMemoryObserver to be notified later when memory will be available to continue data transfer.

Parameters

TDesC8 * aMessage	contain server-specific data
const TUid aTargetServiceUid	service UID
TBool aWrappedFlag	shoud set to ETrue if message should be wrapped by security manager
THtiMessagePriority aPriority	message priority

DispatchOutgoingMessage(TDesC8 *, const TUid)

TInt	DispatchOutgoingMessage	(	TDesC8 *	aMessage,
			const TUid	aTargetServiceUid
		)	[pure virtual]

Parameters

TDesC8 * aMessage
const TUid aTargetServiceUid

GetConsole()

CConsoleBase *

GetConsole

(

)

[pure virtual]

GetFreeMemory()

TInt

GetFreeMemory

(

)

[pure virtual]

Returns tha amount of currenly available memory for messages.

Notify(TInt)

void

Notify

(

TInt

anError

)

[pure virtual]

Notifis dispatcher that some async request is over. Should be used when plug-in uses async services and enters in a busy state (IsBusy() returns true) Should be called when plug-in is able to process new messages again

Parameters

TInt anError

RemoveMemoryObserver(MHtiMemoryObserver *)

void

RemoveMemoryObserver

(

MHtiMemoryObserver *

anObserver

)

[pure virtual]

Removes memory observer.

Parameters

MHtiMemoryObserver * anObserver

memory observer

ShutdownAndRebootDeviceL()

void

ShutdownAndRebootDeviceL

(

)

[pure virtual]