Class CObexHeader

class CObexHeader : public CBase;

Description

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).

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CObexHeader - Encapsulates an Obex header.

Members

Defined in CObexHeader:

• AsByte()constReturns this header as a byte value.
• AsByteSeq()constReturns this header as a byte sequence.
• AsFourByte()constReturns this header as a four-byte value.
• AsUnicode()constReturns this header as an Unicode string.
• Attributes()constReturn the attibute set currently in force.
• CopyL()constReturn a pointer to a copy of this object. This must be used instead of merely c...
• EByte
• EByteSeq
• EDeleted
• EFourByte
• ESent
• ESuppressed
• EUnicode
• EncodedSize()const
• HI()constReturns the header identifier.
• NewL()
• Reset()Resets the contents of this header, discarding the underlying data. This is only...
• ResetContents()Resets and destroys all header attributes.
• Set(CObexHeader *)Sets this object to use the same underlying header as the parameter. This perfor...
• SetAttributes(TUint16)Sets the attibutes of this header.
• SetByte(const TUint8,const TUint8)Sets this header to represent a byte value. Forces header type to be a byte (whi...
• SetByteSeqL(const TUint8,const TDesC8 &)Sets this header to represent a byte sequence. Forces header type to be a byte s...
• SetFourByte(const TUint8,const TUint32)Sets this header to represent a four-byte value. Forces header type to be a four...
• SetUnicodeL(const TUint8,const TDesC16 &)Forces header type to be a byte (which may therefore change the HI value).
• THeaderAttr
• THeaderType
• Type()constReturn the type of this header.
• ~CObexHeader()Standard destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CObexBaseObjectObjects of this class are used to describe the objects to be transferred and tho...

IMPORT_C static CObexHeader* NewL();

Description

Return value

virtual ~CObexHeader();

Description

Standard destructor.

IMPORT_C CObexHeader* CopyL() const;

Description

Return a pointer to a copy of this object. This must be used instead of merely copying the pointer to the initial CObexHeader object as reference counting is used to keep track of instances of the header. The underlying data is not cloned, so any change to the data pointed to by this pointer could change the underlying data.

Return value

IMPORT_C void Set(CObexHeader *aHeader);

Description

Sets this object to use the same underlying header as the parameter. This performs essentially the same function as the CObexHeader::CopyL()const function, but does not allocate a new object. The underlying data is not cloned, so any change to the data pointed to by this pointer could change the underlying data.

Parameters

IMPORT_C void Reset();

Description

Resets the contents of this header, discarding the underlying data. This is only called by the last instance of the header.

IMPORT_C void ResetContents();

Description

Resets and destroys all header attributes.

IMPORT_C void SetAttributes(TUint16 aAttr);

Description

Sets the attibutes of this header.

Parameters

IMPORT_C TUint16 Attributes() const;

Description

Return the attibute set currently in force.

Return value

IMPORT_C THeaderType Type() const;

Description

Return the type of this header.

Return value

IMPORT_C TUint8 HI() const;

Description

Returns the header identifier.

Return value

IMPORT_C TUint8 AsByte() const;

Description

Returns this header as a byte value.

Return value

Panic codes

IMPORT_C TUint32 AsFourByte() const;

Description

Returns this header as a four-byte value.

Return value

Panic codes

IMPORT_C const TDesC8& AsByteSeq() const;

Description

Returns this header as a byte sequence.

Return value

Panic codes

IMPORT_C const TDesC16& AsUnicode() const;

Description

Returns this header as an Unicode string.

Return value

Panic codes

IMPORT_C void SetByte(const TUint8 aHI, const TUint8 aByte);

Description

Sets this header to represent a byte value. Forces header type to be a byte (which may therefore change the HI value).

Parameters

IMPORT_C void SetFourByte(const TUint8 aHI, const TUint32 aFourByte);

Description

Sets this header to represent a four-byte value. Forces header type to be a four-byte (which may therefore change the HI value).

Parameters

IMPORT_C void SetByteSeqL(const TUint8 aHI, const TDesC8 &aByteSeq);

Description

Sets this header to represent a byte sequence. Forces header type to be a byte sequence (which may therefore change the HI value).

Parameters

IMPORT_C void SetUnicodeL(const TUint8 aHI, const TDesC16 &aUnicode);

Description

Forces header type to be a byte (which may therefore change the HI value).

Parameters

IMPORT_C TInt EncodedSize() const;

Description

Return value

THeaderType

Description

THeaderAttr

Description