RHeaderField Class Reference
#include
<mw/http/framework/rheaderfield.h>
Detailed 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.
Constructor & Destructor Documentation
RHeaderField ( CHeaderField & )
Member Function Documentation
BeginRawDataL ( TInt )
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.
- Pre-condition
- The header field is in the 'parsed' state
- Post-condition
- The header field is still in the 'parsed' state
| Parameter | Description | | aChunkSize | (in) (optional) The size to be used for raw data chunk allocation. |
Collection ( )
Get a handle to the headers collection that this field belongs to
Returns: The header collection handle.
CommitRawData ( )
| IMPORT_C void | CommitRawData | ( | ) | |
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.
- Pre-condition
- The header field is in the 'parsed' state
- Post-condition
- The header field is in the 'raw' state
Name ( )
Obtain the name of the header field, e.g. Accept
Returns: The header field name as a string
PartsL ( )
Access the header value parts via an iterator
- leave
- KErrNotSupported - if decoding when counting parts fails
Returns: An iterator constructed to point at the first part
RawDataL ( TPtrC8 & )
| IMPORT_C void | RawDataL | ( | TPtrC8 & | aRawData | ) | |
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.
- leave
- KErrNotSupported - if decoding when counting parts fails
| Parameter | Description | | 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. |
SetPartL ( CHeaderFieldPart *, TInt )
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.
| Parameter | Description | | aPart | (in) The part to be added. The header takes ownership of the new part. |
| aIndex | (in) The index within the header of field of the part. |
WriteRawDataL ( const TDesC8 & )
| IMPORT_C void | WriteRawDataL | ( | const TDesC8 & | aData | ) | |
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.
- Pre-condition
- The header field is in the 'parsed' state
- Post-condition
- The header field is still in the 'parsed' state
| Parameter | Description | | aData | (in) The data to append to the buffer. |
WriteRawDataL ( TChar )
| IMPORT_C void | WriteRawDataL | ( | TChar | aData | ) | |
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.
- Pre-condition
- The header field is in the 'parsed' state
- Post-condition
- The header field is still in the 'parsed' state
| Parameter | Description | | aData | (in) The character data to append to the buffer. |