Class THTTPHdrVal

class THTTPHdrVal;

Description

A representation of a value found in an HTTP header field. Three fundamental types are used in HTTP - integers, strings (which may be free text, 'enumeration values', URIs, etc. or date/times.

The class allows any of the three values to be held and the current value (as well as its type) to be determined.

THTTPHdrVal instances are used to assign values to header fields, their parts and their associated parameters.

Members

Defined in THTTPHdrVal:

• Copy()constObtain a copy of this header value. This is critical when the header contains a ...
• DateTime()constObtain the (date/time) value held within. Panics if the value is of the wrong ty...
• Int()constObtain the (integer) value held within Panics if the value is of the wring type
• KDateValthe value is a date/time
• KNoTypeno value has yet been set
• KStrFValthe value is a case-insensitive string
• KStrValthe value is a case-sensitive string
• KTIntValthe value is an integer
• SetDateTime(TDateTime)Set the header value to be the supplied date/time. Any previous value, or its ty...
• SetInt(TInt)Set the header value to be the supplied integer.
• SetStr(RString)Set the header value to be the supplied string. Any previous value, or its type,...
• SetStrF(RStringF)Set the header value to be the supplied string.
• Str()const
• StrF()constObtain the (string) value held within Panics if the value is of the wring type
• THTTPHdrVal()Default constructor Used when constructing an empty header value that is to be f...
• THTTPHdrVal(RString)Constructor for an string value
• THTTPHdrVal(RStringF)Constructor for an string value
• THTTPHdrVal(TDateTime)Constructor for an date/time value
• THTTPHdrVal(TInt)Constructor for an integer field value
• THTTPValType
• TQConv
• Type()constDetermine the type of this header field value
• operator RString()constCast operator to obtain the HTTP value as a string. Note this doesn't convert fr...
• operator RStringF()constCast operator to obtain the HTTP value as a string. Note this doesn't convert fr...
• operator TDateTime()constCast operator to obtain the HTTP value as an date/time. Note this doesn't conver...
• operator TInt()constCast operator to obtain the HTTP value as an integer. Note this doesn't convert ...
• operator!=(THTTPHdrVal)constComparison operator. Does a comparison based on the current type.
• operator==(THTTPHdrVal)constComparison operator. Does a comparison based on the current type.

See also:

• RHTTPHeadersThe collection of headers (or more correctly, header fields) associated with a m...

IMPORT_C THTTPHdrVal();

Description

Default constructor Used when constructing an empty header value that is to be filled in by a call to a function. e.g. RHTTPHeaders::GetField(RStringF,TInt,THTTPHdrVal &)const

IMPORT_C THTTPHdrVal(TInt aIntVal);

Description

Constructor for an integer field value

Parameters

TInt aIntVal The integer value

IMPORT_C THTTPHdrVal(RStringF aStrVal);

Description

Constructor for an string value

Parameters

RStringF aStrVal The string value

IMPORT_C THTTPHdrVal(RString aStrVal);

Description

Constructor for an string value

Parameters

RString aStrVal The string value

IMPORT_C THTTPHdrVal(TDateTime aDateVal);

Description

Constructor for an date/time value

Parameters

TDateTime aDateVal The date/time value

IMPORT_C THTTPHdrVal Copy() const;

Description

Obtain a copy of this header value. This is critical when the header contains a string, since a new string reference must be created

Return value

THTTPHdrVal The copied header value

IMPORT_C THTTPValType Type() const;

Description

Determine the type of this header field value

Return value

THTTPHdrVal::THTTPValType A THTTPValType enumeration describing the value's type

IMPORT_C TInt Int() const;

Pre-Condition

Requires that the object was previously set to hold a TInt

Description

Obtain the (integer) value held within Panics if the value is of the wring type

Return value

TInt An integer value

inline operator TInt() const;

Pre-Condition

Requires that the object was previously set to hold a TInt

Description

Cast operator to obtain the HTTP value as an integer. Note this doesn't convert from a different form to integer! Panics if the value is of the wrong type

Return value

IMPORT_C RStringF StrF() const;

Pre-Condition

Requires that the object was previously set to hold a string

Description

Obtain the (string) value held within Panics if the value is of the wring type

Return value

RStringF A string

IMPORT_C RString Str() const;

Description

Return value

RString

inline operator RStringF() const;

Pre-Condition

Requires that the object was previously set to hold a string

Description

Cast operator to obtain the HTTP value as a string. Note this doesn't convert from a different form to string! Panics if the value is of the wring type

Return value

inline operator RString() const;

Pre-Condition

Requires that the object was previously set to hold a string

Description

Cast operator to obtain the HTTP value as a string. Note this doesn't convert from a different form to string! Panics if the value is of the wring type

Return value

IMPORT_C TDateTime DateTime() const;

Pre-Condition

Requires that the object was previously set to hold a TDateTime

Description

Obtain the (date/time) value held within. Panics if the value is of the wrong type

Return value

TDateTime An date/time value

inline operator TDateTime() const;

Pre-Condition

Requires that the object was previously set to hold a TDateTime

Description

Cast operator to obtain the HTTP value as an date/time. Note this doesn't convert from a different form to date! Panics if the value is of the wring type

Return value

IMPORT_C void SetInt(TInt aIntVal);

Description

Set the header value to be the supplied integer.

Parameters

TInt aIntVal The integer value

IMPORT_C void SetStrF(RStringF aStrVal);

Description

Set the header value to be the supplied string.

Parameters

RStringF aStrVal The string value

IMPORT_C void SetStr(RString aStrVal);

Description

Set the header value to be the supplied string. Any previous value, or its type, are lost.

Parameters

RString aStrVal The string value

IMPORT_C void SetDateTime(TDateTime aDateVal);

Description

Set the header value to be the supplied date/time. Any previous value, or its type, are lost.

Parameters

TDateTime aDateVal The date/time value

IMPORT_C TBool operator==(THTTPHdrVal aVal) const;

Description

Comparison operator. Does a comparison based on the current type.

Parameters

THTTPHdrVal aVal The header value to compare.

Return value

TBool

IMPORT_C TBool operator!=(THTTPHdrVal aVal) const;

Description

Comparison operator. Does a comparison based on the current type.

Parameters

THTTPHdrVal aVal The string to compare.

Return value

TBool

class TQConv;

Description

Members

Defined in THTTPHdrVal::TQConv:

• TQConv(TInt)Construct from a fixed-point representation of 'q'.
• TQConv(TReal)Construct from a real number representation of 'q'.
• operator TInt()constInteger cast operator to get the fixed-point representation.
• operator TReal()constTReal cast operator to get the real number representation.

Construction and destruction

---

TQConv(TReal)

inline TQConv(TReal aQ);

Description

Construct from a real number representation of 'q'.

Parameters

TReal aQ

---

TQConv(TInt)

inline TQConv(TInt aQ);

Description

Construct from a fixed-point representation of 'q'.

Parameters

TInt aQ

Member functions

---

operator TInt()const

inline operator TInt() const;

Description

Integer cast operator to get the fixed-point representation.

Return value

---

operator TReal()const

inline operator TReal() const;

Description

TReal cast operator to get the real number representation.

Return value

THTTPValType

Description

KTIntVal the value is an integer KStrVal the value is a case-sensitive string KDateVal the value is a date/time KStrFVal the value is a case-insensitive string KNoType no value has yet been set