UpsMCprActivities::CUpsAuthorisationActivityBase Class Reference

class UpsMCprActivities::CUpsAuthorisationActivityBase : public MeshMachine::CNodeParallelActivityBase

Base class used for MCpr activities that need to issue authorisation requests to the NetUps.

Derives from MPolicyCheckRequestOriginator to receive NetUps callbacks when request has completed.

Contains Mesh Machine methods for interacting with the NetUps and also contains "node specific" virtual methods for retrieving information required by NetUps. These methods are intended to be overridden in the specific node to delineate node specific functions from the remaining MCpr generic functions held in this class:

GetServiceId() - retrieves the UPS ServiceId (a UID). Although the ServiceId is defined in the particular MCpr, a default implementation is provided that returns the TierId from the Access Point Config as the ServiceId.

GetUpsDestinationString() - forms a human readable destination address string. The operation of this function depends on the form of the destination address (e.g. IPv4/IPv6) which, in turn, depends on the MCpr.

Inherits from

Public Member Functions
NetUps::CNetUps * GetNetUpsL ( TInt32 )
IMPORT_C TInt GetServiceId (const ESock::CCommsProviderBase &, TInt32 &)
const TDesC & GetUpsAccessPointNameL ()
TInt GetUpsDestinationString ( TUpsDestinationAddrType , const TUpsDestinationAddr &, TDes &)
NetUps::CNetUps * NetUpsReference ()
IMPORT_C TInt ProcessPolicyCheckResponse ( NetUps::TNetUpsDecision , const Messages::TNodeId &)
IMPORT_C TInt ProcessPolicyCheckResponse ( TInt , const Messages::TNodeId &)
NetUps::TRequestId & RequestId ()
void ResetRequestId ()
void SetNetUpsReference ( NetUps::CNetUps *)
Protected Member Functions
CUpsAuthorisationActivityBase (const MeshMachine::TNodeActivity &, MeshMachine::AMMNodeBase &, TUint )
~CUpsAuthorisationActivityBase ()
IMPORT_C void PerformPolicyCheckRequestActionsL (const Messages::TNodeId &)
IMPORT_C void PerformPolicyCheckResponseActions ( NetUps::TNetUpsDecision , const Messages::TNodeId &)
Private Member Functions
CUpsAuthorisationActivityBase * 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()
MeshMachine::CNodeActivityBase::Abort(TNodeContextBase &,TBool)
MeshMachine::CNodeActivityBase::Accept(TNodeContextBase &,const TNodeActivity &,TInt)
MeshMachine::CNodeActivityBase::ActivitySigId()const
MeshMachine::CNodeActivityBase::AppendActivityL()
MeshMachine::CNodeActivityBase::AppendPreallocatedActivity()
MeshMachine::CNodeActivityBase::BorrowPreallocatedSpace(AMMNodeBase &,TUint)
MeshMachine::CNodeActivityBase::CNodeActivityBase(const TNodeActivity &,AMMNodeBase &)
MeshMachine::CNodeActivityBase::Cancel(TNodeContextBase &)
MeshMachine::CNodeActivityBase::ClearPostedTo()
MeshMachine::CNodeActivityBase::Destroy()
MeshMachine::CNodeActivityBase::DoFetchInterfaceControlL(TInt)
MeshMachine::CNodeActivityBase::Error()const
MeshMachine::CNodeActivityBase::FindOriginator(const Messages::RNodeInterface &)const
MeshMachine::CNodeActivityBase::FindOriginator(const Messages::TNodePeerId &)const
MeshMachine::CNodeActivityBase::FindOriginator(const Messages::TRuntimeCtxId &)const
MeshMachine::CNodeActivityBase::FirstOriginator()const
MeshMachine::CNodeActivityBase::InsertPreallocatedDestroyActivity()
MeshMachine::CNodeActivityBase::IsIdle()const
MeshMachine::CNodeActivityBase::KickOffMessageId()const
MeshMachine::CNodeActivityBase::MatchSender(const TNodeContextBase &)const
MeshMachine::CNodeActivityBase::Next(TNodeContextBase &)
MeshMachine::CNodeActivityBase::PostRequestTo(const Messages::RNodeInterface &,const Messages::TSignalBase &,const TBool)
MeshMachine::CNodeActivityBase::PostRequestTo(const Messages::TNodeId &,const Messages::TSignalBase &,const TBool)
MeshMachine::CNodeActivityBase::PostToOriginator(const Messages::TNodePeerId &,const Messages::TSignalBase &)const
MeshMachine::CNodeActivityBase::PostToOriginators(const Messages::TSignalBase &,TUint32,TUint32)
MeshMachine::CNodeActivityBase::PostedToNodeId()const
MeshMachine::CNodeActivityBase::PostedToPeer()const
MeshMachine::CNodeActivityBase::RemoveOriginator(TInt)
MeshMachine::CNodeActivityBase::ReturnPreallocatedSpace(TAny *)
MeshMachine::CNodeActivityBase::SetError(TInt)
MeshMachine::CNodeActivityBase::SetIdle()
MeshMachine::CNodeActivityBase::SetPostedTo(const Messages::RNodeInterface &)
MeshMachine::CNodeActivityBase::SetPostedTo(const Messages::TNodeId &)
MeshMachine::CNodeActivityBase::Signal(TNodeContextBase &)
MeshMachine::CNodeActivityBase::SoleOriginator()const
MeshMachine::CNodeActivityBase::StartL(TNodeContextBase &,const Messages::XNodePeerId &,const NetStateMachine::TStateTriple &)
MeshMachine::CNodeActivityBase::~CNodeActivityBase()
MeshMachine::CNodeParallelActivityBase::ActivityId()const
MeshMachine::CNodeParallelActivityBase::CNodeParallelActivityBase(const TNodeActivity &,AMMNodeBase &,TUint)
MeshMachine::CNodeParallelActivityBase::GetNextActivityCount(const TNodeActivity &,const AMMNodeBase &)
MeshMachine::CNodeParallelActivityBase::GetNextActivityCountL(const TNodeActivity &,const AMMNodeBase &)
MeshMachine::CNodeParallelActivityBase::NewL(const TNodeActivity &,AMMNodeBase &)
Public Member Type Definitions
typedef MeshMachine::TNodeContext < ESock::CMetaConnectionProviderBase , PRStates::TContext > TContext
Public Attributes
const TInt KUpsCompletionTag
Private Attributes
NetUps::CNetUps * iNetUpsReference
NetUps::TRequestId iRequestId
Inherited Attributes
MeshMachine::CNodeActivityBase::iNode
MeshMachine::CNodeActivityBase::iOriginators
MeshMachine::CNodeParallelActivityBase::iActivityId

Constructor & Destructor Documentation

CUpsAuthorisationActivityBase(const MeshMachine::TNodeActivity &, MeshMachine::AMMNodeBase &, TUint)

IMPORT_C CUpsAuthorisationActivityBase ( const MeshMachine::TNodeActivity & aActivitySig,
MeshMachine::AMMNodeBase & aNode,
TUint aNextActivityCount
) [protected]

Parameters

const MeshMachine::TNodeActivity & aActivitySig
MeshMachine::AMMNodeBase & aNode
TUint aNextActivityCount

~CUpsAuthorisationActivityBase()

IMPORT_C ~CUpsAuthorisationActivityBase ( ) [protected]

Member Functions Documentation

GetNetUpsL(TInt32)

NetUps::CNetUps * GetNetUpsL ( TInt32 aServiceId ) [pure virtual]

Parameters

TInt32 aServiceId

GetServiceId(const ESock::CCommsProviderBase &, TInt32 &)

IMPORT_C TInt GetServiceId ( const ESock::CCommsProviderBase & aNode,
TInt32 & aServiceId
) const [virtual]

Get the UPS ServiceId for the current activity.

Called before issuing a request to NetUps. This default implementation returns the TierId in the Access Point Config structure as the UPS ServiceId.

PREQ1116 - should we make this leaving insteadof returning an error?

Parameters

const ESock::CCommsProviderBase & aNode Node corresponding to this activity.
TInt32 & aServiceId Variable populated with ServiceId.

GetUpsAccessPointNameL()

const TDesC & GetUpsAccessPointNameL ( ) [pure virtual]

GetUpsDestinationString(TUpsDestinationAddrType, const TUpsDestinationAddr &, TDes &)

TInt GetUpsDestinationString ( TUpsDestinationAddrType aDestinationType,
const TUpsDestinationAddr & aDestination,
TDes & aOutputString
) [pure virtual]

Parameters

TUpsDestinationAddrType aDestinationType
const TUpsDestinationAddr & aDestination
TDes & aOutputString

NetUpsReference()

NetUps::CNetUps * NetUpsReference ( ) [inline]

NewL()

CUpsAuthorisationActivityBase * NewL ( ) [private, static]

PerformPolicyCheckRequestActionsL(const Messages::TNodeId &)

IMPORT_C void PerformPolicyCheckRequestActionsL ( const Messages::TNodeId & aCommsId ) [protected, virtual]

Parameters

const Messages::TNodeId & aCommsId

PerformPolicyCheckResponseActions(NetUps::TNetUpsDecision, const Messages::TNodeId &)

IMPORT_C void PerformPolicyCheckResponseActions ( NetUps::TNetUpsDecision aNetUpsDecision,
const Messages::TNodeId & aCommsId
) [protected, virtual]

Parameters

NetUps::TNetUpsDecision aNetUpsDecision
const Messages::TNodeId & aCommsId

ProcessPolicyCheckResponse(NetUps::TNetUpsDecision, const Messages::TNodeId &)

IMPORT_C TInt ProcessPolicyCheckResponse ( NetUps::TNetUpsDecision aNetUpsDecision,
const Messages::TNodeId & aCommsId
)

Callback from NetUps with the result of a previous authorisation request.

Parameters

NetUps::TNetUpsDecision aNetUpsDecision Authorisation decision from UPS
const Messages::TNodeId & aCommsId CommsId passed in the original NetUps request

ProcessPolicyCheckResponse(TInt, const Messages::TNodeId &)

IMPORT_C TInt ProcessPolicyCheckResponse ( TInt aError,
const Messages::TNodeId & aCommsId
)

Callback from NetUps if an error occurred in the processing of a previous authorisation request (note that this is not the same as a successfully completed authorisation request that resulted in denial).

Parameters

TInt aError error return from NetUps
const Messages::TNodeId & aCommsId

RequestId()

NetUps::TRequestId & RequestId ( ) [inline]

ResetRequestId()

void ResetRequestId ( ) [inline]

SetNetUpsReference(NetUps::CNetUps *)

void SetNetUpsReference ( NetUps::CNetUps * aNetUps ) [inline]

Parameters

NetUps::CNetUps * aNetUps

Member Type Definitions Documentation

Member Data Documentation

const TInt KUpsCompletionTag

const TInt KUpsCompletionTag [static]

NetUps::CNetUps * iNetUpsReference

NetUps::CNetUps * iNetUpsReference [private]

NetUps::TRequestId iRequestId

NetUps::TRequestId iRequestId [private]