CProtocolBase Class Reference

class CProtocolBase : public CBase

Protocols created by protocol families must be instances of sub-classes of the abstract CProtocolBase. Since v5.0

Inherits from

Public Member Functions
CProtocolBase()
~CProtocolBase()
IMPORT_C voidBindL(CProtocolBase *, TUint)
IMPORT_C voidBindToL(CProtocolBase *)
IMPORT_C voidClose()
IMPORT_C voidCloseNow()
IMPORT_C voidError(TInt, CProtocolBase *)
IMPORT_C TIntGetOption(TUint, TUint, TDes8 &, CProtocolBase *)
voidIdentify(TServerProtocolDesc *)
IMPORT_C voidInitL(TDesC &)
IMPORT_C CHostResolvProvdBase *NewHostResolverL()
IMPORT_C CNetDBProvdBase *NewNetDatabaseL()
IMPORT_C CServProviderBase *NewSAPL(TUint)
IMPORT_C CServiceResolvProvdBase *NewServiceResolverL()
IMPORT_C voidOpen()
IMPORT_C voidProcess(RMBufChain &, CProtocolBase *)
IMPORT_C voidProcess(TDes8 &, TSockAddr *, TSockAddr *, CProtocolBase *)
CProtocolFamilyBase *ProtocolFamily()
TInt RefCount()
IMPORT_C TIntSend(RMBufChain &, CProtocolBase *)
IMPORT_C TIntSend(TDes8 &, TSockAddr *, TSockAddr *, CProtocolBase *)
IMPORT_C TIntSetOption(TUint, TUint, const TDesC8 &, CProtocolBase *)
IMPORT_C voidStartL()
IMPORT_C voidStartSending(CProtocolBase *)
IMPORT_C TPtrCTag()
Protected Member Functions
IMPORT_C voidCanClose()
Private Member Functions
voidTryDelete()
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()
Private Attributes
CProtocolRef *iManagerRef
TInt iRefCount

Constructor & Destructor Documentation

CProtocolBase()

IMPORT_CCProtocolBase()

~CProtocolBase()

IMPORT_C~CProtocolBase()[virtual]

Member Functions Documentation

BindL(CProtocolBase *, TUint)

IMPORT_C voidBindL(CProtocolBase *protocol,
TUintid
)[virtual]

Parameters

CProtocolBase * protocol
TUint id

BindToL(CProtocolBase *)

IMPORT_C voidBindToL(CProtocolBase *protocol)[virtual]

Parameters

CProtocolBase * protocol

CanClose()

IMPORT_C voidCanClose()[protected]

Close()

IMPORT_C voidClose()[virtual]

CloseNow()

IMPORT_C voidCloseNow()[virtual]

Error(TInt, CProtocolBase *)

IMPORT_C voidError(TIntanError,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

TInt anError
CProtocolBase * aSourceProtocol = NULL

GetOption(TUint, TUint, TDes8 &, CProtocolBase *)

IMPORT_C TIntGetOption(TUintlevel,
TUintname,
TDes8 &option,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

TUint level
TUint name
TDes8 & option
CProtocolBase * aSourceProtocol = NULL

Identify(TServerProtocolDesc *)

voidIdentify(TServerProtocolDesc *aProtocolDesc)const [pure virtual]

Fills in the passed TServerProtocolDesc with data describing the protocol.

Parameters

TServerProtocolDesc * aProtocolDescProtocol description object to fill in

InitL(TDesC &)

IMPORT_C voidInitL(TDesC &aTag)[virtual]

Parameters

TDesC & aTag

NewHostResolverL()

IMPORT_C CHostResolvProvdBase *NewHostResolverL()[virtual]

NewNetDatabaseL()

IMPORT_C CNetDBProvdBase *NewNetDatabaseL()[virtual]

NewSAPL(TUint)

IMPORT_C CServProviderBase *NewSAPL(TUintaProtocol)[virtual]

Parameters

TUint aProtocol

NewServiceResolverL()

IMPORT_C CServiceResolvProvdBase *NewServiceResolverL()[virtual]

Open()

IMPORT_C voidOpen()[virtual]

Process(RMBufChain &, CProtocolBase *)

IMPORT_C voidProcess(RMBufChain &,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

RMBufChain &
CProtocolBase * aSourceProtocol = NULL

Process(TDes8 &, TSockAddr *, TSockAddr *, CProtocolBase *)

IMPORT_C voidProcess(TDes8 &aPDU,
TSockAddr *from,
TSockAddr *to = NULL,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

TDes8 & aPDU
TSockAddr * from
TSockAddr * to = NULL
CProtocolBase * aSourceProtocol = NULL

ProtocolFamily()

CProtocolFamilyBase *ProtocolFamily()

RefCount()

TInt RefCount()const [inline]

Reference counting by protocols created by protocol families.

number of protocols

Send(RMBufChain &, CProtocolBase *)

IMPORT_C TIntSend(RMBufChain &aPDU,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

RMBufChain & aPDU
CProtocolBase * aSourceProtocol = NULL

Send(TDes8 &, TSockAddr *, TSockAddr *, CProtocolBase *)

IMPORT_C TIntSend(TDes8 &aPDU,
TSockAddr *to,
TSockAddr *from = NULL,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

TDes8 & aPDU
TSockAddr * to
TSockAddr * from = NULL
CProtocolBase * aSourceProtocol = NULL

SetOption(TUint, TUint, const TDesC8 &, CProtocolBase *)

IMPORT_C TIntSetOption(TUintlevel,
TUintname,
const TDesC8 &option,
CProtocolBase *aSourceProtocol = NULL
)[virtual]

Parameters

TUint level
TUint name
const TDesC8 & option
CProtocolBase * aSourceProtocol = NULL

StartL()

IMPORT_C voidStartL()[virtual]

StartSending(CProtocolBase *)

IMPORT_C voidStartSending(CProtocolBase *aProtocol)[virtual]

Parameters

CProtocolBase * aProtocol

Tag()

IMPORT_C TPtrCTag()

TryDelete()

voidTryDelete()[private]

Member Data Documentation

CProtocolRef * iManagerRef

CProtocolRef *iManagerRef[private]

TInt iRefCount

TInt iRefCount[private]
© Nokia 2010.