Symbian^3 Product Developer Library >

RPppOptionList Class Reference

class RPppOptionList : public RMBufPktQ

Inherits from

Public Member Functions
TInt CopyL(RMBufChain &, TInt)
voidCrc32(TPppFcs32 &, TBool)
voidCreateAndAddL(TUint8)
voidCreateAndAddL(TUint8, TUint8)
voidCreateAndAddL(TUint8, TUint16)
voidCreateAndAddL(TUint8, TUint32)
voidCreateAndAddL(TUint8, const TUint8 *, TInt)
voidCreateAndAddL(TUint8, TPtrC8 &)
voidCreatePacketL(RMBufPacket &, TUint, TUint8, TUint8, TBool)
TBool EqualTo(RPppOptionList &)
TBool IsSubsetOf(RPppOptionList &)
TInt RemoveOption(RPppOption &)
TInt RemoveOptions(RPppOptionList &)
TInt ReplaceOption(RPppOption &)
TInt ReplaceOptions(RPppOptionList &)
voidSetL(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,
TIntaHdrLen = 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)

voidCrc32(TPppFcs32 &aFcs,
TBoolaInitFcs = ETrue
)

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

Parameters

TPppFcs32 & aFcs
TBool aInitFcs = ETrue

CreateAndAddL(TUint8)

voidCreateAndAddL(TUint8aType)

Parameters

TUint8 aType

CreateAndAddL(TUint8, TUint8)

voidCreateAndAddL(TUint8aType,
TUint8aValue
)

Parameters

TUint8 aType
TUint8 aValue

CreateAndAddL(TUint8, TUint16)

voidCreateAndAddL(TUint8aType,
TUint16aValue
)

Parameters

TUint8 aType
TUint16 aValue

CreateAndAddL(TUint8, TUint32)

voidCreateAndAddL(TUint8aType,
TUint32aValue
)

Parameters

TUint8 aType
TUint32 aValue

CreateAndAddL(TUint8, const TUint8 *, TInt)

voidCreateAndAddL(TUint8aType,
const TUint8 *aBuf,
TIntaLen
)

Parameters

TUint8 aType
const TUint8 * aBuf
TInt aLen

CreateAndAddL(TUint8, TPtrC8 &)

voidCreateAndAddL(TUint8aType,
TPtrC8 &aValue
)

Parameters

TUint8 aType
TPtrC8 & aValue

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

voidCreatePacketL(RMBufPacket &aPacket,
TUintaPppId,
TUint8aType,
TUint8aId,
TBoolaCreateEmptyPacket = EFalse
)

Creates an options packet from an options list

RFC1661, 5. MPppFsm::NewPacket

Parameters

RMBufPacket & aPacketReturn value for the constructed packet
TUint aPppIdProtocol (e.g. LCP, IPCP etc).
TUint8 aTypeType field of packet (e.g. Config-Request etc).
TUint8 aIdId field of packet
TBool aCreateEmptyPacket = EFalseSet 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 & aListoption 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

Parameters

RPppOptionList & aListoption list to compare against.

RemoveOption(RPppOption &)

TInt RemoveOption(RPppOption &aOption)

Parameters

RPppOption & aOption

RemoveOptions(RPppOptionList &)

TInt RemoveOptions(RPppOptionList &aRejectList)

For each option in aRejectList, delete the original in this list

Parameters

RPppOptionList & aRejectList

ReplaceOption(RPppOption &)

TInt ReplaceOption(RPppOption &aOption)

Parameters

RPppOption & aOption

ReplaceOptions(RPppOptionList &)

TInt ReplaceOptions(RPppOptionList &aReplaceList)

For each option in aReplaceList, delete the original in this list and replace it with the given one.

Parameters

RPppOptionList & aReplaceList

SetL(RMBufChain &, TInt)

voidSetL(RMBufChain &aList,
TIntaLength = 0
)

Parameters

RMBufChain & aList
TInt aLength = 0

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.