Class RHeaderField

class RHeaderField;

Description

An proxy object for a single field in an HTTP header. The class is used by implementations of CHeaderCodec in order to manipulate the header at the part and parameter level, or to obtain raw data, during a header encode/decode operation.

Members

Defined in RHeaderField:
BeginRawDataL(), Collection(), CommitRawData(), Name(), PartsL(), RHeaderField(), RawDataL(), SetPartL(), WriteRawDataL(), WriteRawDataL()

inline RHeaderField(CHeaderField &aHeaderField);

Description

Parameters

CHeaderField &aHeaderField

IMPORT_C RStringF Name() const;

Description

Obtain the name of the header field, e.g. Accept

Return value

RStringF The header field name as a string

IMPORT_C THeaderFieldPartIter PartsL();

Description

Access the header value parts via an iterator

Return value

THeaderFieldPartIter An iterator constructed to point at the first part

Leave codes

KErrNotSupported - if decoding when counting parts fails

IMPORT_C void RawDataL(TPtrC8 &aRawData);

Description

Get the header field's raw data representation. This will flip the internal state of the header, if it's not already in Raw form. Requires a Codec to be set. May leave due to decode failures with an error code from <httperr.h>

Post-Condition

The header field is in either its 'raw' state (following a successful conversion) or in a 'corrupt' state if decoding failed.

Parameters

TPtrC8 &aRawData (inout) An 8-bit pointer descriptor that is set during the call to point at the data buffer representing the header in its raw form.

Leave codes

KErrNotSupported - if decoding when counting parts fails

IMPORT_C RHTTPHeaders Collection();

Description

Get a handle to the headers collection that this field belongs to

Return value

RHTTPHeaders The header collection handle.

IMPORT_C void SetPartL(CHeaderFieldPart *aPart, TInt aIndex);

Description

Set a part in the header. It replaces any existing part at the specified index. Note this is for use only by the header codec, when converting Raw data into parsed header parts.

Parameters

CHeaderFieldPart *aPart (in) The part to be added. The header takes ownership of the new part. TInt aIndex (in) The index within the header of field of the part.

IMPORT_C void BeginRawDataL(TInt aChunkSize=KDefaultRawChunkSize);

Pre-Condition

The header field is in the 'parsed' state

Description

When the header codec starts converting parsed header data into the raw form, it must first call this method to indicate that the raw data is being generated. Memory allocations are done in chunks set at the specified size. Note this method is for use only by the header codec.

Post-Condition

The header field is still in the 'parsed' state

Parameters

TInt aChunkSize (in) (optional) The size to be used for raw data chunk allocation.

IMPORT_C void WriteRawDataL(const TDesC8 &aData);

Pre-Condition

The header field is in the 'parsed' state

Description

Add more Raw data, supplied as a descriptor. The data is appended to the existing contents of the field's internal raw data buffer, which is extended as necessary. Note this method is for use only by the header codec.

Post-Condition

The header field is still in the 'parsed' state

Parameters

const TDesC8 &aData (in) The data to append to the buffer.

IMPORT_C void WriteRawDataL(TChar aData);

Pre-Condition

The header field is in the 'parsed' state

Description

Add more Raw data, supplied as a single character. The data is appended to the existing contents of the field's internal raw data buffer, which is extended as necessary. Note this method is for use only by the header codec.

Post-Condition

The header field is still in the 'parsed' state

Parameters

TChar aData (in) The character data to append to the buffer.

IMPORT_C void CommitRawData();

Pre-Condition

The header field is in the 'parsed' state

Description

Commits the Raw data. The parsed header parts and parameters are removed, leaving the field in a the raw data form. Note this method is for use only by the header codec.

Post-Condition

The header field is in the 'raw' state