Collapse all Symbian^3 Application Developer Library

RPppOptionList Class Reference

class RPppOptionList : public RMBufPktQ

Inherits from

RPppOptionList
- RMBufPktQ

Public Member Functions
TInt	CopyL ( RMBufChain &, TInt )
void	Crc32 ( TPppFcs32 &, TBool )
void	CreateAndAddL ( TUint8 )
void	CreateAndAddL ( TUint8 , TUint8 )
void	CreateAndAddL ( TUint8 , TUint16 )
void	CreateAndAddL ( TUint8 , TUint32 )
void	CreateAndAddL ( TUint8 , const TUint8 *, TInt )
void	CreateAndAddL ( TUint8 , TPtrC8 &)
void	CreatePacketL ( RMBufPacket &, TUint , TUint8 , TUint8 , TBool )
TBool	EqualTo ( RPppOptionList &)
TBool	IsSubsetOf ( RPppOptionList &)
TInt	RemoveOption ( RPppOption &)
TInt	RemoveOptions ( RPppOptionList &)
TInt	ReplaceOption ( RPppOption &)
TInt	ReplaceOptions ( RPppOptionList &)
void	SetL ( RMBufChain &, TInt )

Inherited Functions
	RMBufPktQ::Append(RMBufChain &)
	RMBufPktQ::Append(RMBufPktQ &)
	RMBufPktQ::Assign(RMBufPktQ &)
	RMBufPktQ::First()const
	RMBufPktQ::Free()
	RMBufPktQ::Init()
	RMBufPktQ::IsEmpty()const
	RMBufPktQ::Last()const
	RMBufPktQ::Prepend(RMBufChain &)
	RMBufPktQ::Remove(RMBufChain &)

Inherited Attributes
	RMBufPktQ::iLast
	RMBufPktQ::iNext

Member Functions Documentation

CopyL(RMBufChain &, TInt)

TInt	CopyL	(	RMBufChain &	aPacket,
			TInt	aHdrLen = 0
		)	const

Build an MBuf chain by copying the underlying packet queue, leaving space on the front for a protocol header.

Parameters

RMBufChain & aPacket
TInt aHdrLen = 0

Crc32(TPppFcs32 &, TBool)

void	Crc32	(	TPppFcs32 &	aFcs,
			TBool	aInitFcs = ETrue
		)

Calculate the FCS of an Option list Used for detecting non-convergence

Parameters

TPppFcs32 & aFcs
TBool aInitFcs = ETrue

CreateAndAddL(TUint8)

void

CreateAndAddL

(

TUint8

aType

)

Parameters

TUint8 aType

CreateAndAddL(TUint8, TUint8)

void	CreateAndAddL	(	TUint8	aType,
			TUint8	aValue
		)

Parameters

TUint8 aType
TUint8 aValue

CreateAndAddL(TUint8, TUint16)

void	CreateAndAddL	(	TUint8	aType,
			TUint16	aValue
		)

Parameters

TUint8 aType
TUint16 aValue

CreateAndAddL(TUint8, TUint32)

void	CreateAndAddL	(	TUint8	aType,
			TUint32	aValue
		)

Parameters

TUint8 aType
TUint32 aValue

CreateAndAddL(TUint8, const TUint8 *, TInt)

void	CreateAndAddL	(	TUint8	aType,
			const TUint8 *	aBuf,
			TInt	aLen
		)

Parameters

TUint8 aType
const TUint8 * aBuf
TInt aLen

CreateAndAddL(TUint8, TPtrC8 &)

void	CreateAndAddL	(	TUint8	aType,
			TPtrC8 &	aValue
		)

Parameters

TUint8 aType
TPtrC8 & aValue

CreatePacketL(RMBufPacket &, TUint, TUint8, TUint8, TBool)

void	CreatePacketL	(	RMBufPacket &	aPacket,
			TUint	aPppId,
			TUint8	aType,
			TUint8	aId,
			TBool	aCreateEmptyPacket = EFalse
		)

Creates an options packet from an options list

RFC1661, 5. MPppFsm::NewPacket

Parameters

RMBufPacket & aPacket	Return value for the constructed packet
TUint aPppId	Protocol (e.g. LCP, IPCP etc).
TUint8 aType	Type field of packet (e.g. Config-Request etc).
TUint8 aId	Id field of packet
TBool aCreateEmptyPacket = EFalse	Set to ETrue if an empty packet is required.

EqualTo(RPppOptionList &)

TBool

EqualTo

(

RPppOptionList &

aList

)

Check if the current option list exactly matches that of the option list specified as argument.

The options in each list must have the same type in the same order and have the same value. If one option list has extra options at the end, then this also counts as a mismatch. Note that aList should really be a const, but this would require propagation of the constness to several related classes.

Parameters

RPppOptionList & aList

option list to compare against.

IsSubsetOf(RPppOptionList &)

TBool

IsSubsetOf

(

RPppOptionList &

aList

)

Check if the current option list is a subset of the OptionsList presented (aList).

All the options in the current list must be contained and must be in the same order as the options in aList All the option arguments must also be identical