CObexHeader Class Reference

class CObexHeader : public CBase

Encapsulates an Obex header.

This class provides the ability to hold a header of any of the Obex supported types as a native Symbian OS type.

A header may also have one or more attributes set. These are used by the object which owns the header collection so that it can keep track of which headers should be sent (!(ESuppressed || EDeleted)), which have been sent (ESent), and whether the header should be deleted (EDeleted). Deletion is a special case---any operation on the Object which causes a scan of the headers will trigger deletion of any marked headers. This is required as they are owned by the Object, but can be accessed seperately (including through the creator keeping a pointer to the header).

CObexBaseObject

Inherits from

Public Member Functions
~CObexHeader()
IMPORT_C TUint8AsByte()
IMPORT_C const TDesC8 &AsByteSeq()
IMPORT_C TUint32AsFourByte()
IMPORT_C const TDesC16 &AsUnicode()
IMPORT_C TUint16Attributes()
IMPORT_C CObexHeader *CopyL()
IMPORT_C TIntEncodedSize()
IMPORT_C TUint8HI()
IMPORT_C CObexHeader *NewL()
IMPORT_C voidReset()
IMPORT_C voidResetContents()
IMPORT_C voidSet(CObexHeader *)
IMPORT_C voidSetAttributes(TUint16)
IMPORT_C voidSetByte(const TUint8, const TUint8)
IMPORT_C voidSetByteSeqL(const TUint8, const TDesC8 &)
IMPORT_C voidSetFourByte(const TUint8, const TUint32)
IMPORT_C voidSetUnicodeL(const TUint8, const TDesC16 &)
IMPORT_C THeaderTypeType()
Private Member Functions
CObexHeader()
CObexHeader(CObexUnderlyingHeader *)
voidConstructL()
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()
Public Member Enumerations
enumTHeaderAttr { ESuppressed = 0x01, ESent = 0x02, EDeleted = 0x04 }
enumTHeaderType { EUnicode = 0x00, EByteSeq = 0x01, EByte = 0x02, EFourByte = 0x03 }
Private Attributes
CObexUnderlyingHeader *iHeader

Constructor & Destructor Documentation

CObexHeader()

CObexHeader()[private]

CObexHeader(CObexUnderlyingHeader *)

CObexHeader(CObexUnderlyingHeader *aHeader)[private]

Parameters

CObexUnderlyingHeader * aHeader

~CObexHeader()

~CObexHeader()[virtual]

Member Functions Documentation

AsByte()

IMPORT_C TUint8AsByte()const

AsByteSeq()

IMPORT_C const TDesC8 &AsByteSeq()const

AsFourByte()

IMPORT_C TUint32AsFourByte()const

AsUnicode()

IMPORT_C const TDesC16 &AsUnicode()const

Attributes()

IMPORT_C TUint16Attributes()const

ConstructL()

voidConstructL()[private]

CopyL()

IMPORT_C CObexHeader *CopyL()const

EncodedSize()

IMPORT_C TIntEncodedSize()const

HI()

IMPORT_C TUint8HI()const

NewL()

IMPORT_C CObexHeader *NewL()[static]

Reset()

IMPORT_C voidReset()

ResetContents()

IMPORT_C voidResetContents()

Set(CObexHeader *)

IMPORT_C voidSet(CObexHeader *aHeader)

Parameters

CObexHeader * aHeader

SetAttributes(TUint16)

IMPORT_C voidSetAttributes(TUint16aAttr)

Parameters

TUint16 aAttr

SetByte(const TUint8, const TUint8)

IMPORT_C voidSetByte(const TUint8aHI,
const TUint8aByte
)

Parameters

const TUint8 aHI
const TUint8 aByte

SetByteSeqL(const TUint8, const TDesC8 &)

IMPORT_C voidSetByteSeqL(const TUint8aHI,
const TDesC8 &aByteSeq
)

Parameters

const TUint8 aHI
const TDesC8 & aByteSeq

SetFourByte(const TUint8, const TUint32)

IMPORT_C voidSetFourByte(const TUint8aHI,
const TUint32aFourByte
)

Parameters

const TUint8 aHI
const TUint32 aFourByte

SetUnicodeL(const TUint8, const TDesC16 &)

IMPORT_C voidSetUnicodeL(const TUint8aHI,
const TDesC16 &aUnicode
)

Parameters

const TUint8 aHI
const TDesC16 & aUnicode

Type()

IMPORT_C THeaderTypeType()const

Member Enumerations Documentation

Enum THeaderAttr

Enumerators

ESuppressed = 0x01
ESent = 0x02
EDeleted = 0x04

Enum THeaderType

Enumerators

EUnicode = 0x00
EByteSeq = 0x01
EByte = 0x02
EFourByte = 0x03

Member Data Documentation

CObexUnderlyingHeader * iHeader

CObexUnderlyingHeader *iHeader[private]