TConnPrefList Class Reference

#include <connpref.h>

Link against: esock.lib

class TConnPrefList : public TConnPref, public TConnPref
Public Member Functions
TConnPrefList()
~TConnPrefList()
IMPORT_C voidAppendL(SMetaDataECom *)
IMPORT_C TIntCount()
IMPORT_C TIntLength()
IMPORT_C TIntLoad(TDesC8 &)
IMPORT_C TConnPrefList *LoadL(TDesC8 &)
IMPORT_C TConnPrefList *NewL()
IMPORT_C voidRemove(TInt)
IMPORT_C TIntStore(TDes8 &)
IMPORT_C SMetaData *operator[](TInt)
Inherited Attributes
TBuf8< KMaxConnPrefSize >::iBuf
TDes8::__DECLARE_TEST
TDes8::iMaxLength
Inherited Enumerations
TConnPref:@284
TConnPref:@8
Inherited Functions
TBuf8< KMaxConnPrefSize >::TBuf8()
TBuf8< KMaxConnPrefSize >::TBuf8(TInt)
TBuf8< KMaxConnPrefSize >::TBuf8(const TDesC8 &)
TBuf8< KMaxConnPrefSize >::TBuf8(const TUint8 *)
TBuf8< KMaxConnPrefSize >::operator=(const TBuf8< S > &)
TBuf8< KMaxConnPrefSize >::operator=(const TDesC8 &)
TBuf8< KMaxConnPrefSize >::operator=(const TUint8 *)
TBufBase8::TBufBase8(TInt)
TBufBase8::TBufBase8(TInt,TInt)
TBufBase8::TBufBase8(const TDesC8 &,TInt)
TBufBase8::TBufBase8(const TUint8 *,TInt)
TConnPref::ExtensionId()const
TConnPref::GetUserLen()
TConnPref::SetExtensionId(TInt)
TConnPref::SetUserLen(TInt)
TConnPref::TConnPref()
TConnPref::TConnPref(TInt)
TConnPref::UserPtr()const
TDes8::Append(TChar)
TDes8::Append(const TDesC16 &)
TDes8::Append(const TDesC8 &)
TDes8::Append(const TUint8 *,TInt)
TDes8::AppendFill(TChar,TInt)
TDes8::AppendFormat(TRefByValue< const TDesC8 >,...)
TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)
TDes8::AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)
TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)
TDes8::AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)
TDes8::AppendJustify(const TUint8 *,TInt,TAlign,TChar)
TDes8::AppendJustify(const TUint8 *,TInt,TInt,TAlign,TChar)
TDes8::AppendNum(TInt64)
TDes8::AppendNum(TReal,const TRealFormat &)
TDes8::AppendNum(TUint64,TRadix)
TDes8::AppendNumFixedWidth(TUint,TRadix,TInt)
TDes8::AppendNumFixedWidthUC(TUint,TRadix,TInt)
TDes8::AppendNumUC(TUint64,TRadix)
TDes8::Capitalize()
TDes8::Collapse()
TDes8::Collate()
TDes8::Copy(const TDesC16 &)
TDes8::Copy(const TDesC8 &)
TDes8::Copy(const TUint8 *)
TDes8::Copy(const TUint8 *,TInt)
TDes8::CopyC(const TDesC8 &)
TDes8::CopyCP(const TDesC8 &)
TDes8::CopyF(const TDesC8 &)
TDes8::CopyLC(const TDesC8 &)
TDes8::CopyUC(const TDesC8 &)
TDes8::Delete(TInt,TInt)
TDes8::DoAppendNum(TUint64,TRadix,TUint,TInt)
TDes8::DoPadAppendNum(TInt,TInt,const TUint8 *)
TDes8::Expand()
TDes8::Fill(TChar)
TDes8::Fill(TChar,TInt)
TDes8::FillZ()
TDes8::FillZ(TInt)
TDes8::Fold()
TDes8::Format(TRefByValue< const TDesC8 >,...)
TDes8::FormatList(const TDesC8 &,VA_LIST)
TDes8::Insert(TInt,const TDesC8 &)
TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)
TDes8::LeftTPtr(TInt)const
TDes8::LowerCase()
TDes8::MaxLength()const
TDes8::MaxSize()const
TDes8::MidTPtr(TInt)const
TDes8::MidTPtr(TInt,TInt)const
TDes8::Num(TInt64)
TDes8::Num(TReal,const TRealFormat &)
TDes8::Num(TUint64,TRadix)
TDes8::NumFixedWidth(TUint,TRadix,TInt)
TDes8::NumFixedWidthUC(TUint,TRadix,TInt)
TDes8::NumUC(TUint64,TRadix)
TDes8::PtrZ()
TDes8::Repeat(const TDesC8 &)
TDes8::Repeat(const TUint8 *,TInt)
TDes8::Replace(TInt,TInt,const TDesC8 &)
TDes8::RightTPtr(TInt)const
TDes8::SetLength(TInt)
TDes8::SetMax()
TDes8::Swap(TDes8 &)
TDes8::TDes8()
TDes8::TDes8(TInt,TInt,TInt)
TDes8::Trim()
TDes8::TrimAll()
TDes8::TrimLeft()
TDes8::TrimRight()
TDes8::UpperCase()
TDes8::WPtr()const
TDes8::Zero()
TDes8::ZeroTerminate()
TDes8::operator+=(const TDesC8 &)
TDes8::operator=(const TDes8 &)
TDes8::operator[](TInt)const
TDesC8::Alloc()const
TDesC8::AllocL()const
TDesC8::AllocLC()const
TDesC8::AtC(TInt)const
TDesC8::Compare(const TDesC8 &)const
TDesC8::CompareC(const TDesC8 &)const
TDesC8::CompareF(const TDesC8 &)const
TDesC8::DoSetLength(TInt)
TDesC8::Find(const TDesC8 &)const
TDesC8::Find(const TUint8 *,TInt)const
TDesC8::FindC(const TDesC8 &)const
TDesC8::FindC(const TUint8 *,TInt)const
TDesC8::FindF(const TDesC8 &)const
TDesC8::FindF(const TUint8 *,TInt)const
TDesC8::Left(TInt)const
TDesC8::Length()const
TDesC8::Locate(TChar)const
TDesC8::LocateF(TChar)const
TDesC8::LocateReverse(TChar)const
TDesC8::LocateReverseF(TChar)const
TDesC8::Match(const TDesC8 &)const
TDesC8::MatchC(const TDesC8 &)const
TDesC8::MatchF(const TDesC8 &)const
TDesC8::Mid(TInt)const
TDesC8::Mid(TInt,TInt)const
TDesC8::Ptr()const
TDesC8::Right(TInt)const
TDesC8::Size()const
TDesC8::TDesC8()
TDesC8::TDesC8(TInt,TInt)
TDesC8::Type()const
TDesC8::operator!=(const TDesC8 &)const
TDesC8::operator<(const TDesC8 &)const
TDesC8::operator<=(const TDesC8 &)const
TDesC8::operator==(const TDesC8 &)const
TDesC8::operator>(const TDesC8 &)const
TDesC8::operator>=(const TDesC8 &)const

Detailed Description

This class is used to send a collection of connection preferences expressed as SMetaData objects between RConnection and Comms server which uses them to construct it stack.

Each tier will look up the preferences it understands, act of them, consume them if applicable (see individual preferences) and pass the rest down to the next tier.

RConnection conn;
User::LeaveIfError(conn.Open(sockSvr));
CleanupClosePushL(conn);

TConnPrefList* prefs = TConnPrefList::NewL();
CleanupStack::PushL(prefs);
TConnAPPref* APPref = TConnAPPref::NewL(aPara->iAp);
CleanupStack::PushL(APPref);
prefs->AppendL(APPref);

error = conn.Start(pref);

See also: TConnAPPref TConnAutoStartPref TConnSnapPref RConnection::Start

Constructor & Destructor Documentation

TConnPrefList ( )

IMPORT_CTConnPrefList()

Constructor for TConnPrefList

~TConnPrefList ( )

IMPORT_C~TConnPrefList()

Destrcutor - closes iPrefs deleting the pointers but not the objects they point at. These should be deleted explicitly.

Member Function Documentation

AppendL ( SMetaDataECom * )

IMPORT_C voidAppendL(SMetaDataECom *aFamily)

This adds the pointer supplied to the list. Also see TConnAPPref Only one instance of TConnAPPref can be appended to the list and passed to RConnection::Start. More than one will force RConnection::Start to return KErrArgument

Count ( )

IMPORT_C TIntCount()

This returns an integer value representing the number of objects in the list

Return Value
- integer representing the number of objects in the list

Length ( )

IMPORT_C TIntLength()

Returns the size of the desciptor needed to store the object using the store function

Return Value
Integer representing the length of descriptor need to store the object

Load ( TDesC8 & )

IMPORT_C TIntLoad(TDesC8 &aDes)

This function loads an instance of TConnPrefList from the given descriptor into the object its called on. It returns an integer error on failiure

Return Value
- KErrNone if successful otherwise KErrArgument

LoadL ( TDesC8 & )

IMPORT_C TConnPrefList *LoadL(TDesC8 &aDes)[static]

This function loads an instance of TConnPrefList from the given descriptor and returns a pointer to that oject in memory is possible, otherwise leaves

Parameters
aDes- a descriptor containing a serialized form of TConnPrefList
Return Value
TConnPrefList* to the instance of the object in memory

NewL ( )

IMPORT_C TConnPrefList *NewL()[static]

Remove ( TInt )

IMPORT_C voidRemove(TIntaIndex)

This removes the objet at the given index from the list

Store ( TDes8 & )

IMPORT_C TIntStore(TDes8 &aDes)

This puts a serilized form of the object that the function is called on into the descriptor supplied

Return Value
- KErrNone if successfulKErrOverflow if the descriptor is too shortotherwise one of the standard error codes

operator[] ( TInt )

IMPORT_C SMetaData *operator[](TIntaIndex)

Reimplemented from TDes8::operator[](TInt)

This retrieves a pointer to the object at the given index

Return Value
a pointer to the object in memory