Symbian^3 Application Developer Library >

CAgentSubConnectionProvider Class Reference

class CAgentSubConnectionProvider : public CCoreSubConnectionProvider

Inherits from

Public Member Functions
~CAgentSubConnectionProvider ()
IMPORT_C CAgentSubConnectionProvider * NewL ( ESock::CSubConnectionProviderFactoryBase &)
void StartAgentL ()
void StopAgent ( TInt )
Protected Member Functions
CAgentSubConnectionProvider ( ESock::CSubConnectionProviderFactoryBase &, const MeshMachine::TNodeActivityMap &)
IMPORT_C const CAgentProvisionInfo * AgentProvisionInfo ()
IMPORT_C void CleanupProvisioningInfo ()
IMPORT_C void ConnectAgent ( TAgentConnectType )
IMPORT_C TInt NotificationToAgent ( TFlowToAgentEventType , TAny *)
IMPORT_C void ReceivedL (const Messages::TRuntimeCtxId &, const Messages::TNodeId &, Messages::TSignatureBase &)
Private Member Functions
void AuthenticateCompleteL ( TInt )
void CancelStartOrSendStopToSelf ( TInt )
void ConnectionDownL ()
void ConnectionUpL ()
void Error (const Elements::TStateChange &)
void NetworkAdaptorEvent ( TNetworkAdaptorEventType , TUint , const TDesC8 &, TAny *)
TInt NotificationFromAgent ( TAgentToFlowEventType , TAny *)
void NotificationFromFlow ( TFlowToAgentEventType )
TInt PostMessageToFlow (const Messages::TRuntimeCtxId &, const Messages::TSignatureBase &)
void ProgressL ( TInt )
void PromptForReconnectComplete ( TInt )
void ProvisionAgentInfoL ()
void ServiceStarted ()
void SetActivityIdForAdapter ( TUint )
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()
CCoreSubConnectionProvider::CCoreSubConnectionProvider(ESock::CSubConnectionProviderFactoryBase &)
CCoreSubConnectionProvider::CCoreSubConnectionProvider(ESock::CSubConnectionProviderFactoryBase &,const MeshMachine::TNodeActivityMap &)
CCoreSubConnectionProvider::Received(MeshMachine::TNodeContextBase &)
CCoreSubConnectionProvider::~CCoreSubConnectionProvider()
ESock::CCommsProviderBase::AccessPointConfig()const
ESock::CCommsProviderBase::~CCommsProviderBase()
ESock::CMMCommsProviderBase::AddClientL(const Messages::TNodeId &,const Messages::TClientType &,TAny *)
ESock::CMMCommsProviderBase::CMMCommsProviderBase(CCommsFactoryBase &,const MeshMachine::TNodeActivityMap &)
ESock::CMMCommsProviderBase::CreateParameterBundleL()
ESock::CMMCommsProviderBase::DestroyOrphanedDataClients()
ESock::CMMCommsProviderBase::FetchNodeInterfaceControlL(TInt)
ESock::CMMCommsProviderBase::GetOrCreateParameterBundleL()
ESock::CMMCommsProviderBase::GetParameterBundle()
ESock::CMMCommsProviderBase::Id()const
ESock::CMMCommsProviderBase::ReturnInterfacePtrL(MAccessPointConfigApi *&)
ESock::CMMCommsProviderBase::SetParametersL(const RCFParameterFamilyBundleC &)
ESock::CMMCommsProviderBase::~CMMCommsProviderBase()
ESock::CSubConnectionProviderBase::CSubConnectionProviderBase(CSubConnectionProviderFactoryBase &,const MeshMachine::TNodeActivityMap &)
ESock::CSubConnectionProviderBase::NotifyClientsL(const CSubConNotificationEvent &)
ESock::CSubConnectionProviderBase::~CSubConnectionProviderBase()
Private Attributes
TUint iActivityIdForAdapter
TBool iAuthenticateInProgress
Elements::TStateChange iLastProgress
TBuf < KCommsDbSvrMaxUserIdPassLength > iPassword
TBool iScprOwnedNotificationHandler
TBool iStopRequested
TInt iStoppingReason
TBuf < KCommsDbSvrMaxUserIdPassLength > iUsername
Inherited Attributes
ESock::CCommsProviderBase::iAccessPointConfig
ESock::CMMCommsProviderBase::iParameterBundle

Constructor & Destructor Documentation

CAgentSubConnectionProvider(ESock::CSubConnectionProviderFactoryBase &, const MeshMachine::TNodeActivityMap &)

IMPORT_C CAgentSubConnectionProvider ( ESock::CSubConnectionProviderFactoryBase & aFactory,
const MeshMachine::TNodeActivityMap & aActivityMap
) [protected]

Constructor for the Agent SubConnection Provider

Parameters

ESock::CSubConnectionProviderFactoryBase & aFactory The parent factory which created this SCPr
const MeshMachine::TNodeActivityMap & aActivityMap

~CAgentSubConnectionProvider()

IMPORT_C ~CAgentSubConnectionProvider ( )

D'tor

Member Functions Documentation

AgentProvisionInfo()

IMPORT_C const CAgentProvisionInfo * AgentProvisionInfo ( ) const [protected]

Retrieves the Agent Provider specific provisioning information as given by the MCPr transition.

AuthenticateCompleteL(TInt)

void AuthenticateCompleteL ( TInt aStatus ) [private]

Called from the CAgentAdapter . Indicates that the agent has finished getting authentication data by whatever means it chooses.

Parameters

TInt aStatus

CancelStartOrSendStopToSelf(TInt)

void CancelStartOrSendStopToSelf ( TInt aError ) [private]

Issue a TCFDataClient::TStop message to ourselves.

Used to initiate the stop activity internally when requested from an Agent.

Parameters

TInt aError error code in TCFDataClient::TStop message.

CleanupProvisioningInfo()

IMPORT_C void CleanupProvisioningInfo ( ) [protected]

ConnectAgent(TAgentConnectType)

IMPORT_C void ConnectAgent ( TAgentConnectType aConnectType ) [protected]

Starts the agent connection process

Parameters

TAgentConnectType aConnectType

ConnectionDownL()

void ConnectionDownL ( ) [private]

Called from the CAgentAdapter . Indicates that the agent is now disconnected.

ConnectionUpL()

void ConnectionUpL ( ) [private]

Called from the CAgentAdapter . Gets information required by flow into a TCommsBinder and posts it into this node's mesh machine with a TStarted message

Error(const Elements::TStateChange &)

void Error ( const Elements::TStateChange & aProgress ) [private]

Posts the error to the control clients (Up)

Parameters

const Elements::TStateChange & aProgress

NetworkAdaptorEvent(TNetworkAdaptorEventType, TUint, const TDesC8 &, TAny *)

void NetworkAdaptorEvent ( TNetworkAdaptorEventType aEventType,
TUint aEvent,
const TDesC8 & aEventData,
TAny * aSource = NULL
) [private]

Parameters

TNetworkAdaptorEventType aEventType
TUint aEvent
const TDesC8 & aEventData
TAny * aSource = NULL

NewL(ESock::CSubConnectionProviderFactoryBase &)

IMPORT_C CAgentSubConnectionProvider * NewL ( ESock::CSubConnectionProviderFactoryBase & aFactory ) [static]

Creates an Agent SubConnection Provider

Parameters

ESock::CSubConnectionProviderFactoryBase & aFactory The parent factory which has created the SCPr

NotificationFromAgent(TAgentToFlowEventType, TAny *)

TInt NotificationFromAgent ( TAgentToFlowEventType aEvent,
TAny * aInfo = NULL
) [private]

Parameters

TAgentToFlowEventType aEvent
TAny * aInfo = NULL

NotificationFromFlow(TFlowToAgentEventType)

void NotificationFromFlow ( TFlowToAgentEventType aEvent ) [private]

Parameters

TFlowToAgentEventType aEvent

NotificationToAgent(TFlowToAgentEventType, TAny *)

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

Notifies an event to the AgentSCpr's Agent via the AgentAdapter

Parameters

TFlowToAgentEventType aEvent
TAny * aInfo

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

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

Parameters

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

ProgressL(TInt)

void ProgressL ( TInt aStage ) [private]

Posts the progress to the Control Client (SCPr above). There should only ever be one Control Client for this SCPr.

Parameters

TInt aStage

PromptForReconnectComplete(TInt)

void PromptForReconnectComplete ( TInt aStatus ) [private]

Called from the CAgentAdapter . Indicates that the agent has had a response from the user deciding whether or not to reconnect

Parameters

TInt aStatus

ProvisionAgentInfoL()

void ProvisionAgentInfoL ( ) [private]

ReceivedL(const Messages::TRuntimeCtxId &, const Messages::TNodeId &, Messages::TSignatureBase &)

IMPORT_C void ReceivedL ( const Messages::TRuntimeCtxId & aSender,
const Messages::TNodeId & aRecipient,
Messages::TSignatureBase & aMessage
) [protected, virtual]

Mesh machine message entry point

Parameters

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

ServiceStarted()

void ServiceStarted ( ) [private]

Upcall from the agent

SetActivityIdForAdapter(TUint)

void SetActivityIdForAdapter ( TUint aActivityId ) [private, inline]

Parameters

TUint aActivityId

StartAgentL()

void StartAgentL ( )

Called from the StartAgent state transition

StopAgent(TInt)

void StopAgent ( TInt aReason )

Called from the StopAgent state transition

Parameters

TInt aReason

Member Data Documentation

TUint iActivityIdForAdapter

TUint iActivityIdForAdapter [private]

TBool iAuthenticateInProgress

TBool iAuthenticateInProgress [private]

Elements::TStateChange iLastProgress

Elements::TStateChange iLastProgress [private]

TBuf< KCommsDbSvrMaxUserIdPassLength > iPassword

TBuf < KCommsDbSvrMaxUserIdPassLength > iPassword [private]

TBool iScprOwnedNotificationHandler

TBool iScprOwnedNotificationHandler [private]

TBool iStopRequested

TBool iStopRequested [private]

TInt iStoppingReason

TInt iStoppingReason [private]

TBuf< KCommsDbSvrMaxUserIdPassLength > iUsername

TBuf < KCommsDbSvrMaxUserIdPassLength > iUsername [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.