Collapse all Symbian^3 Product Developer Library

MFlowManager Class Reference

class MFlowManager : public MInetBase

The flow manager interface.

The use of MFlowManager is mostly hidden behind the RFlowContext, but the upper layer must be aware of its existence. Currently, the MFlowManager interface is included into the MnetworkService (and is implemented by the IP6 protocol instance), which must be used whenever an instance of MFlowManager is required.

Since: v7.0

Inherits from

MFlowManager
- MInetBase

Public Member Functions
void	DecUsers()
TInt	FlowSetupHooks(CFlowInternalContext &)
void	FlowStartRefresh(CFlowInternalContext &)
TInt	GetFlowOption(TUint, TUint, TDes8 &, const CFlowContext &)
void	IncUsers()
CFlowContext *	NewFlowL(const void *, TUint)
CFlowContext *	NewFlowL(const void *, CFlowContext &)
TInt	SetChanged()
TInt	SetFlowOption(TUint, TUint, const TDesC8 &, CFlowContext &)

Inherited Functions
	MInetBase::GetApiL(const TDesC8 &,TUint *)
	MInetBase::GetApiL(const TDesC8 &,TUint)

Member Functions Documentation

DecUsers()

void

DecUsers

(

)

[pure virtual]

Decrease the "users" counter. For details, see IncUsers().

FlowSetupHooks(CFlowInternalContext &)

TInt

FlowSetupHooks

(

CFlowInternalContext &

aFlow

)

[pure virtual]

Internal API between flow and flow manager.

Parameters

CFlowInternalContext & aFlow

FlowStartRefresh(CFlowInternalContext &)

void

FlowStartRefresh

(

CFlowInternalContext &

aFlow

)

[pure virtual]

Internal API between flow and flow manager.

Parameters

CFlowInternalContext & aFlow

GetFlowOption(TUint, TUint, TDes8 &, const CFlowContext &)

TInt	GetFlowOption	(	TUint	aLevel,
			TUint	aName,
			TDes8 &	aOption,
			const CFlowContext &	aFlow
		)	const [pure virtual]

Internal API between flow and flow manager.

Parameters

TUint aLevel
TUint aName
TDes8 & aOption
const CFlowContext & aFlow

IncUsers()

void

IncUsers

(

)

[pure virtual]

Increase the "users" counter.

The count of current "users" is used in determining whether to keep or release resources. This in turn, may cause the disconnect of a data connection.

The stack leaves it up to the upper layers to decide what is counted as a "user". IncUsers() and DecUsers() should be used to give this information to the underlying system. By default, each opened socket is counted as one user.

NewFlowL(const void *, TUint)

CFlowContext *	NewFlowL	(	const void *	aOwner,
			TUint	aProtocol
		)	[pure virtual]

Creates a new (empty) instance of a CFlowContext.

Parameters

const void * aOwner	Identifies the flow's owner (typically an RFlowContext handle)
TUint aProtocol	Protocol ID

NewFlowL(const void *, CFlowContext &)

CFlowContext *	NewFlowL	(	const void *	aOwner,
			CFlowContext &	aFlow
		)	[pure virtual]

Creates a copy of an instance of a CFlowContext.

Parameters

const void * aOwner	Identifies the flow's owner (typically an RFlowContext handle)
CFlowContext & aFlow	Object to copy

SetChanged()

TInt

SetChanged

(

)

const [pure virtual]

Sets the connect information changed flag on all flows.

SetFlowOption(TUint, TUint, const TDesC8 &, CFlowContext &)

TInt	SetFlowOption	(	TUint	aLevel,
			TUint	aName,
			const TDesC8 &	aOption,
			CFlowContext &	aFlow
		)	[pure virtual]

Internal API between flow and flow manager.

Parameters

TUint aLevel
TUint aName
const TDesC8 & aOption
CFlowContext & aFlow