Collapse all Symbian^3 Application Developer Library

CAgentNotificationHandler Class Reference

class CAgentNotificationHandler : public CBase

Base class for notification handlers for Agents

Inherits from

CAgentNotificationHandler
- CBase

Public Member Functions
IMPORT_C void	ConnectCompleteL ()
void	Initialise ( CAgentSubConnectionProvider *)
IMPORT_C TInt	NotificationFromAgent ( TAgentToFlowEventType , TAny *)
IMPORT_C TInt	NotificationFromFlow ( TFlowToAgentEventType )
IMPORT_C void	ServiceStarted ()

Protected Member Functions
	CAgentNotificationHandler ()
IMPORT_C TInt	AnonPostMessageToFlow (const Messages::TSignatureBase &)
IMPORT_C const Meta::SMetaData *	GetExtension (const Meta::STypeId &)
IMPORT_C TInt	NotificationToAgent ( TFlowToAgentEventType , TAny *)
IMPORT_C TInt	PostMessageToFlow (const Messages::TRuntimeCtxId &, Messages::TSignatureBase &)
IMPORT_C TInt	QueryIsDialIn ()
IMPORT_C TInt	ReadIfNetworks ( TDes &)
IMPORT_C TInt	ReadIfParams ( TDes &)
IMPORT_C TInt	ReadNifName ( TDes &)
IMPORT_C TInt	ReadPortName ( TDes &)

Private Member Functions
CAgentNotificationHandler *	NewL ()

Inherited Functions
	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()

Constructor & Destructor Documentation

CAgentNotificationHandler()

IMPORT_C

CAgentNotificationHandler

(

)

[protected]

C'tor

Member Functions Documentation

AnonPostMessageToFlow(const Messages::TSignatureBase &)

IMPORT_C TInt

AnonPostMessageToFlow

(

const Messages::TSignatureBase &

aMessage

)

[protected]

Parameters

const Messages::TSignatureBase & aMessage

ConnectCompleteL()

IMPORT_C void

ConnectCompleteL

(

)

[virtual]

Default implementation of ConnectCompleteL does nothing

GetExtension(const Meta::STypeId &)

IMPORT_C const Meta::SMetaData *

GetExtension

(

const Meta::STypeId &

aType

)

const [protected]

Gets an extension from the SCPrs iAccessPointConfig member

Parameters

const Meta::STypeId & aType

Initialise(CAgentSubConnectionProvider *)

void

Initialise

(

CAgentSubConnectionProvider *

aAgentSCPr

)

Initialises the CAgentNotificationHandler with the Agent SCPr it should use to communicate with the Agent

Parameters

CAgentSubConnectionProvider * aAgentSCPr

NewL()

CAgentNotificationHandler *

NewL

(

)

[private, static]

Used internally by the AgentSCPr when the MCPr has not provided a CAgentNotificationHandler

NotificationFromAgent(TAgentToFlowEventType, TAny *)

IMPORT_C TInt	NotificationFromAgent	(	TAgentToFlowEventType	aEvent,
			TAny *	aInfo
		)	[virtual]

Parameters

TAgentToFlowEventType aEvent
TAny * aInfo

NotificationFromFlow(TFlowToAgentEventType)

IMPORT_C TInt

NotificationFromFlow

(

TFlowToAgentEventType

aEvent

)

[virtual]

Default implementation of NotificationFromFlow will forward the notification to the agent passing a NULL pointer for the aInfo. If a pointer is really needed by the agent for the type of event received this method must be overidden. The overiding method MUST make the call to NotificationToAgent()

Parameters

TFlowToAgentEventType aEvent

NotificationToAgent(TFlowToAgentEventType, TAny *)

IMPORT_C TInt	NotificationToAgent	(	TFlowToAgentEventType	aEvent,
			TAny *	aInfo
		)	[protected]

Parameters

TFlowToAgentEventType aEvent
TAny * aInfo

PostMessageToFlow(const Messages::TRuntimeCtxId &, Messages::TSignatureBase &)

IMPORT_C TInt	PostMessageToFlow	(	const Messages::TRuntimeCtxId &	aSender,
			Messages::TSignatureBase &	aMessage
		)	[protected]

Sends a message to the Flow. The NodeChannelId will be overwritten properly (taking it from the AgentSCPr) before sending the message to the Flow.

Parameters

const Messages::TRuntimeCtxId & aSender
Messages::TSignatureBase & aMessage

QueryIsDialIn()

IMPORT_C TInt

QueryIsDialIn

(

)

[protected]

ReadIfNetworks(TDes &)

IMPORT_C TInt

ReadIfNetworks

(

TDes &

aIfNetworks

)

[protected]

Parameters

TDes & aIfNetworks

ReadIfParams(TDes &)

IMPORT_C TInt

ReadIfParams

(

TDes &

aIfParams

)

[protected]

Parameters

TDes & aIfParams

ReadNifName(TDes &)

IMPORT_C TInt

ReadNifName

(

TDes &

aNifName

)

[protected]

Reads information via the Agent

Parameters

TDes & aNifName

ReadPortName(TDes &)

IMPORT_C TInt

ReadPortName

(

TDes &

aPortName

)

[protected]

Reads information via the Agent

Parameters

TDes & aPortName

ServiceStarted()

IMPORT_C void

ServiceStarted

(

)

[virtual]

Default implementation of ServiceStarted does nothing