THTTPHdrVal Class Reference

#include <mw/http/thttphdrval.h>

Link against: http.lib

class THTTPHdrVal

Nested Classes and Structures

THTTPHdrVal::TQConv

Public Member Enumerations
enum	THTTPValType { KTIntVal, KStrVal, KDateVal, KStrFVal, KNoType }

Public Member Functions
	THTTPHdrVal()
	THTTPHdrVal(TInt)
	THTTPHdrVal(RStringF)
	THTTPHdrVal(RString)
	THTTPHdrVal(TDateTime)
IMPORT_C THTTPHdrVal	Copy()
IMPORT_C TDateTime	DateTime()
IMPORT_C TInt	Int()
IMPORT_C void	SetDateTime(TDateTime)
IMPORT_C void	SetInt(TInt)
IMPORT_C void	SetStr(RString)
IMPORT_C void	SetStrF(RStringF)
IMPORT_C RString	Str()
IMPORT_C RStringF	StrF()
IMPORT_C THTTPValType	Type()
	operator RString()
	operator RStringF()
	operator TDateTime()
	operator TInt()
IMPORT_C TBool	operator!=(THTTPHdrVal)
IMPORT_C TBool	operator==(THTTPHdrVal)

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

Member Enumeration Documentation

Enum THTTPValType

Enumerator	Value	Description
KTIntVal	0x00	the value is an integer
KStrVal	0x01	the value is a case-sensitive string
KDateVal	0x02	the value is a date/time
KStrFVal	0x03	the value is a case-insensitive string
KNoType	0x04	no value has yet been set

Constructor & Destructor Documentation

THTTPHdrVal ( )

IMPORT_C

THTTPHdrVal

(

)

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

THTTPHdrVal ( TInt )

IMPORT_C

THTTPHdrVal

(

TInt

aIntVal

)

Constructor for an integer field value

Parameter	Description
aIntVal	The integer value

THTTPHdrVal ( RStringF )

IMPORT_C

THTTPHdrVal

(

RStringF

aStrVal

)

Constructor for an string value

Parameter	Description
aStrVal	The string value

THTTPHdrVal ( RString )

IMPORT_C

THTTPHdrVal

(

RString

aStrVal

)

Constructor for an string value

Parameter	Description
aStrVal	The string value

THTTPHdrVal ( TDateTime )

IMPORT_C

THTTPHdrVal

(

TDateTime

aDateVal

)

Constructor for an date/time value

Parameter	Description
aDateVal	The date/time value

Member Function Documentation

Copy ( )

IMPORT_C THTTPHdrVal

Copy

(

)

const

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

Returns: The copied header value

DateTime ( )

IMPORT_C TDateTime

DateTime

(

)

const

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

Pre-condition: Requires that the object was previously set to hold a TDateTime

Returns: An date/time value

Int ( )

IMPORT_C TInt

Int

(

)

const

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

Pre-condition: Requires that the object was previously set to hold a TInt

Returns: An integer value

SetDateTime ( TDateTime )

IMPORT_C void

SetDateTime

(

TDateTime

aDateVal

)

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

Parameter	Description
aDateVal	The date/time value

SetInt ( TInt )

IMPORT_C void

SetInt

(

TInt

aIntVal

)

Set the header value to be the supplied integer.

CAUTION:

Any previous value, or its type, are lost.

Parameter	Description
aIntVal	The integer value

SetStr ( RString )

IMPORT_C void

SetStr

(

RString

aStrVal

)

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

Parameter	Description
aStrVal	The string value

SetStrF ( RStringF )

IMPORT_C void

SetStrF

(

RStringF

aStrVal

)

Set the header value to be the supplied string.

CAUTION:

Any previous value, or its type, are lost.

Parameter	Description
aStrVal	The string value

Str ( )

IMPORT_C RString

Str

(

)

const

StrF ( )

IMPORT_C RStringF

StrF

(

)

const

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

Pre-condition: Requires that the object was previously set to hold a string

Returns: A string

Type ( )

IMPORT_C THTTPValType

Type

(

)

const

Determine the type of this header field value

Returns: A THTTPValType enumeration describing the value's type

operator RString ( )

operator RString

(

)

const [inline]

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

Pre-condition: Requires that the object was previously set to hold a string

operator RStringF ( )

operator RStringF

(

)

const [inline]

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

Pre-condition: Requires that the object was previously set to hold a string

operator TDateTime ( )

operator TDateTime

(

)

const [inline]

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

Pre-condition: Requires that the object was previously set to hold a TDateTime

operator TInt ( )

operator TInt

(

)

const [inline]

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

Pre-condition: Requires that the object was previously set to hold a TInt

operator!= ( THTTPHdrVal )

IMPORT_C TBool

operator!=

(

THTTPHdrVal

aVal

)

const

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

Parameter	Description
aVal	The string to compare.

operator== ( THTTPHdrVal )

IMPORT_C TBool

operator==

(

THTTPHdrVal

aVal

)

const

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

Parameter	Description
aVal	The header value to compare.