CWspHeaderEncoder Class Reference
| class CWspHeaderEncoder : public CBase |
Detailed Description
This class can be used to encode one header field at a time, with all its values and parameters.
It has no knowledge of encoding the BNF of a particular header field, but the functions provided can be used in combination, producing an 8-bit buffer containing the encoded header.
Intended usage would be to call a series of functions. The first one being StartHeader, The final one being EndHeader, which would return a buffer containing the complete encoded header field. eg: encoder->DeprecatedStartHeaderL(); encoder->AddLongIntL(); encoder->AddTextStringL(); HBufC8* output = encoder->EndHeaderL();
Constructor & Destructor Documentation
~CWspHeaderEncoder ( )
| IMPORT_C | ~CWspHeaderEncoder | ( | ) | [virtual] |
Member Function Documentation
AddDataL ( const TDesC8 & )
| IMPORT_C void | AddDataL | ( | const TDesC8 & | aData | ) | |
Encodes input and adds it to the encoded field. Adds value as-is to the encoded field.
| Parameters |
|---|
| aData | value to be encoded. |
AddDateL ( const TDateTime )
Encodes input and adds it to the encoded field.Encodes parameter value using WSP Date method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aDate | value to be encoded. |
AddIntegerL ( const TUint )
| IMPORT_C void | AddIntegerL | ( | const TUint | aInt | ) | |
Encodes input Integer value and adds it to the encoded field. Choice of encoded form dependent on the size of the input.Either ShortInt or LongInt method chosen.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aInt | Integer value to be encoded. |
AddLongIntL ( const TUint32 )
| IMPORT_C void | AddLongIntL | ( | const TUint32 | aValue | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP LongInt method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aValue | value to be encoded. |
AddShortIntL ( const TUint8 )
| IMPORT_C void | AddShortIntL | ( | const TUint8 | aValue | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP ShortInt method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aValue | value to be encoded. |
AddShortLengthL ( const TUint8 )
| IMPORT_C void | AddShortLengthL | ( | const TUint8 | aValue | ) | |
Encodes input and adds it to the encoded field. For short length the value must be between octet 0 - 31.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aValue | value to be encoded. |
| Leave Codes |
|---|
| KErrNoMemory, | KErrOverflow if the value is greater than 31 |
AddTextStringL ( const RString & )
| IMPORT_C void | AddTextStringL | ( | const RString & | aText | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP TextString method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aText | value to be encoded. |
AddTextStringL ( const TDesC8 & )
| IMPORT_C void | AddTextStringL | ( | const TDesC8 & | aText | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP TextString method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aText | value to be encoded. |
AddTokenL ( const TUint8 )
| IMPORT_C void | AddTokenL | ( | const TUint8 | aToken | ) | |
Encodes input and adds it to the encoded field. Adds value as-is to the encoded field.
- Pre-condition
- StartHeaderL and StartValueLengthL should have been called.
- Post-condition
- EndValueLengthL needs to be called subsequently.
| Parameters |
|---|
| aToken | parameter added without encodeing. Should be a valid WSP token, a 8 bit number > 0x7F (i.e. top bit set). |
AddTokenTextL ( const TDesC8 & )
| IMPORT_C void | AddTokenTextL | ( | const TDesC8 & | aTokenText | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP TokenText method.
| Parameters |
|---|
| aTokenText | value to be encoded. |
AddUintVarL ( const TUint )
| IMPORT_C void | AddUintVarL | ( | const TUint | aInt | ) | |
Encodes input and adds it to the encoded field. Encodes parameter value using WSP UIntVar method.
- Pre-condition
- StartHeaderL needs to have been called.
| Parameters |
|---|
| aInt | value to be encoded. |
EndHeaderL ( )
Completes and returns encoded field 8 bit buffer. This method will panic if an EndValueLengthL() is not called after a StartValueLength().
Note: The final buffer containing the entire encoded header is constructed. Returns buffer containing the encoded field constructed from the first call to StartHeaderL.
- Pre-condition
- The function StartHeaderL should have been called.
- Post-condition
- Encoder is reset ready to be used again.
- Return Value
- Pointer to buffer containing the entire encoded field. Responsibility for deallocating the memory is also passed.
EndValueLengthL ( )
| IMPORT_C void | EndValueLengthL | ( | ) | |
Needs to be called at the point in the construction of a header when ValueLength can be calculated.
- Pre-condition
- StartHeaderL and StartValueLengthL should have been called.
- Post-condition
- ValueLength has been calculated and added, together with the encoded header, to the internal representation of the header buffer.
NewL ( )
Static factory constructor.
- Return Value
- returns a Pointer to fully constructed CWspHeaderEncoder object.
NewLC ( )
Static factory constructor.
- Return Value
- returns a Pointer to fully constructed CWspHeaderEncoder object on the Heap.
StartHeaderL ( TUint8 )
| IMPORT_C void | StartHeaderL | ( | TUint8 | aToken | ) | |
Starts a new encoded header.
| Parameters |
|---|
| aToken | field name being encoded as a Token value. |
StartHeaderL ( const TDesC8 & )
| IMPORT_C void | StartHeaderL | ( | const TDesC8 & | aString | ) | |
Starts a new encoded header.
| Parameters |
|---|
| aString | Fieldname parameter is encoded as a TextString. |
StartHeaderL ( const RStringF )
| IMPORT_C void | StartHeaderL | ( | const RStringF | aString | ) | |
Starts a new encoded header.
| Parameters |
|---|
| aString | Fieldname parameter is encoded as a TextString. |
| Leave Codes |
|---|
| KErrNotSupported | |
StartValueLengthL ( )
| IMPORT_C void | StartValueLengthL | ( | ) | |
From calling this function, the length in bytes of all encodings added subsequently will be calculated and stored as part of the encoded string, as specified in WSP spec.Can be nested. i.e.
encoder->StartHeaderL();
encoder->StartValueLengthL();
encoder->StartValueLengthL();
encoder->AddLongIntL();
encoder->EndValueLengthL();
encoder->AddTextStringL();
encoder->EndValueLengthL();
HBufC8* output = encoder->EndHeaderL();
- Pre-condition
- StartHeaderL should have been called.
- Post-condition
- EndValueLengthL needs to be called subsequently.