RHTTPHeaders Class Reference

#include <mw/http/rhttpheaders.h>

Link against: http.lib

class RHTTPHeaders

Public Member Functions
	RHTTPHeaders()
IMPORT_C TInt	FieldPartsL(RStringF)
IMPORT_C THTTPHdrFieldIter	Fields()
IMPORT_C TInt	GetField(RStringF, TInt, THTTPHdrVal &)
IMPORT_C TInt	GetParam(RStringF, RStringF, THTTPHdrVal &, TInt)
IMPORT_C TInt	GetRawField(RStringF, TPtrC8 &)
IMPORT_C void	GetRawFieldL(RStringF, TPtrC8 &)
IMPORT_C void	RemoveAllFields()
IMPORT_C TInt	RemoveField(RStringF)
IMPORT_C TInt	RemoveFieldPart(RStringF, TInt)
IMPORT_C TInt	SetField(RStringF, THTTPHdrVal)
IMPORT_C TInt	SetField(RStringF, THTTPHdrVal, RStringF, THTTPHdrVal)
IMPORT_C void	SetFieldL(RStringF, THTTPHdrVal)
IMPORT_C void	SetFieldL(RStringF, THTTPHdrVal, RStringF, THTTPHdrVal)
IMPORT_C void	SetParamL(RStringF, RStringF, THTTPHdrVal, TInt)
IMPORT_C TInt	SetRawField(RStringF, const TDesC8 &, const TDesC8 &)
IMPORT_C void	SetRawFieldL(RStringF, const TDesC8 &, const TDesC8 &)

Detailed Description

The collection of headers (or more correctly, header fields) associated with a message. Header (fields) can be created, read and modified. They may be composed of several parts (by repeated invocations of API methods, see below) and may be assigned one or more parameters. Individual field parts and parameters take values described using THTTPHdrVal.

Constructor & Destructor Documentation

RHTTPHeaders ( )

RHTTPHeaders

(

)

[inline]

Default constructor

Member Function Documentation

FieldPartsL ( RStringF )

IMPORT_C TInt

FieldPartsL

(

RStringF

aFieldName

)

const

Getter methods Methods for reading data. Obtain the number of parts in the named header field's value, Simple headers are created with a single part following one call to SetFieldL. Subsequent calls to SetFieldL create additional parts if the field exists already.

leave: KErrNoMemory

Parameter	Description
aFieldName	The header name

Returns: The number of parts, or zero if the field does not exist.

Fields ( )

IMPORT_C THTTPHdrFieldIter

Fields

(

)

const

Access the fields within this header collection, via an iterator. Each application of the iterator returns the name of the next field type. This may then be accessed via RHTTPHeaders methods.

Returns: The iterator.

GetField ( RStringF, TInt, THTTPHdrVal & )

IMPORT_C TInt	GetField	(	RStringF	aFieldName,
			TInt	aPartIdx,
			THTTPHdrVal &	aHeaderValue
		)	const

Obtain the named header field's value. The index of a part within the field must be specified. Parts are indexed from 0 and fields with only one part return the entire field for index 0

Parameter	Description
aFieldName	The header name
aPartIdx	The index of the part
aHeaderValue	The header field value

Returns: An error condition. Returns KErrNotFound if there is not a field with the specifed field name

GetParam ( RStringF, RStringF, THTTPHdrVal &, TInt )

IMPORT_C TInt	GetParam	(	RStringF	aFieldName,
			RStringF	aParamName,
			THTTPHdrVal &	aReturn,
			TInt	aPartIdx = 0
		)	const

Obtain the value of a named parameter, associated with the named header field. An optional index to a part within the header field may be supplied, if not it is assumed that it is the first part.

Parameter	Description
aFieldName	The header name
aParamName	The parameter name
aReturn	The returned value. Note that this must be Copy()d by the caller, if it wants to keep the value.
aPartIdx	The optional index of the part

Returns: An error condition. Returns KErrNotFound if there is not a field with the specifed field name

GetRawField ( RStringF, TPtrC8 & )

IMPORT_C TInt	GetRawField	(	RStringF	aFieldName,
			TPtrC8 &	aRawFieldData
		)	const

Obtain an Raw representation of the named header field's value. Note that general client use of this method is strongly discouraged since it exposes the Raw representation of particular headers. However it may be needed for some cases where received headers could not be decoded by HTTP. It will normally be used internally when preparing header data to be transmitted with a request. Note that this API may not return the field values for all the headers.

Parameter	Description
aFieldName	The field name, e.g, 'Content-Type'
aRawFieldData	The field's data content, in an appropriate Raw form

Returns: An error condition. Returns KErrNotFound if there is not a field with the specifed field name

GetRawFieldL ( RStringF, TPtrC8 & )

IMPORT_C void	GetRawFieldL	(	RStringF	aFieldName,
			TPtrC8 &	aRawFieldData
		)	const

RemoveAllFields ( )

IMPORT_C void

RemoveAllFields

(

)

Remove all the fields of this header collection

RemoveField ( RStringF )

IMPORT_C TInt

RemoveField

(

RStringF

aFieldName

)

Remove, entirely, the named header field from the header collection. All its parts and associated parameters (where they exist) are also removed.

Parameter	Description
aFieldName	The field name.

Returns: KErrNone if the removal is successful; KErrNotFound if the field didn't exist within the headers.

RemoveFieldPart ( RStringF, TInt )

IMPORT_C TInt	RemoveFieldPart	(	RStringF	aFieldName,
			TInt	aIndex
		)

Remove a single part of a header field. Just the part and any associated paramters are removed. If this results in no parts being present in the header then it will also be removed

Parameter	Description
aFieldName	The header name
aIndex	The particular part of the field to be removed

Returns: KErrNone if the removal is sucessful; KErrNotFound if the header didn't exist. No exception is raised if the particular value is not found as part of that header

SetField ( RStringF, THTTPHdrVal )

IMPORT_C TInt	SetField	(	RStringF	aFieldName,
			THTTPHdrVal	aFieldValue
		)

SetField ( RStringF, THTTPHdrVal, RStringF, THTTPHdrVal )

IMPORT_C TInt	SetField	(	RStringF	aFieldName,
			THTTPHdrVal	aFieldValue,
			RStringF	aParamName,
			THTTPHdrVal	aParamValue
		)

SetFieldL ( RStringF, THTTPHdrVal )

IMPORT_C void	SetFieldL	(	RStringF	aFieldName,
			THTTPHdrVal	aFieldValue
		)

Setter Methods Methods for writing data. Set a named field in the header. On the first instance that this API method is used for a given field name, the first will be created. On subsequent calls, the same field will be extended to have several parts, with a new part created to hold the supplied value.

Parameter	Description
aFieldName	The field name, e.g, 'Content-Type'
aFieldValue	The field value, e.g. 'text/html'

SetFieldL ( RStringF, THTTPHdrVal, RStringF, THTTPHdrVal )

IMPORT_C void	SetFieldL	(	RStringF	aFieldName,
			THTTPHdrVal	aFieldValue,
			RStringF	aParamName,
			THTTPHdrVal	aParamValue
		)

Set a named field in the header, and associate with it the supplied parameter. If the field doesn't already exist it will be created along with a parameter; if it does exist, then a new part will be created along with the parameter.

Parameter	Description
aFieldName	The field name, e.g. 'Accept'
aFieldValue	The field value. e.g. 'text/plain'
aParamName	The parameter name, e.g. 'q'
aParamValue	The parameter value, e.g. '0.3'

SetParamL ( RStringF, RStringF, THTTPHdrVal, TInt )

IMPORT_C void	SetParamL	(	RStringF	aFieldName,
			RStringF	aParamName,
			THTTPHdrVal	aParamValue,
			TInt	aPartIdx
		)

Set a parameter in an existing header.

leave: KErrNotFoud if the field, or the part within the field doesn't exist

Parameter	Description
aFieldName	The field name, e.g. 'Accept'
aParamName	The parameter name, e.g. 'q'
aParamValue	The parameter value, e.g. '0.3'
aPartIdx	The part of the header to add the parameter to

SetRawField ( RStringF, const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	SetRawField	(	RStringF	aFieldName,
			const TDesC8 &	aRawFieldData,
			const TDesC8 &	aFieldSeparator
		)

SetRawFieldL ( RStringF, const TDesC8 &, const TDesC8 & )

IMPORT_C void	SetRawFieldL	(	RStringF	aFieldName,
			const TDesC8 &	aRawFieldData,
			const TDesC8 &	aFieldSeparator
		)

Set a named field in the header to contain the supplied Raw header data. If the header already exists then a LF and the new data will be added to the existing data. This is used to indicate that there are multiple instances of this header

Note that general client use of this method is strongly discouraged since it exposes the raw representation of particular headers. However it may be needed for some cases where headers to be transmitted have no encoding known to HTTP. It will normally be used internally when receiving data from a service provider.

Parameter	Description
aFieldName	The field name, e.g, 'Content-Type'
aRawFieldData	The field's data content, in a raw form
aFieldSeparator	The header field separator