Collapse all Symbian^3 Application Developer Library

RHTTPFilterCollection Class Reference

class RHTTPFilterCollection

A Handle on the filter collection in a session. It provides facilities for adding and deleting filters and for querying what filters are installed. RHTTPSession::FilterCollection MHTTPFilter::TPositions

Public Member Functions
	RHTTPFilterCollection ()
IMPORT_C void	AddFilterL ( MHTTPFilter &, THTTPEvent , RStringF , TInt , TInt , RStringF )
IMPORT_C void	AddFilterL ( MHTTPFilter &, THTTPEvent , TInt , RStringF )
IMPORT_C TBool	CanChangeFilters ()
IMPORT_C THTTPFilterIterator	Query ( RStringF )
IMPORT_C void	RemoveFilter ( RStringF )
RHTTPSession	Session ()

Private Attributes
CHTTPSession *	iImplementation

Constructor & Destructor Documentation

RHTTPFilterCollection()

RHTTPFilterCollection

(

)

[inline]

Constructor

Member Functions Documentation

AddFilterL(MHTTPFilter &, THTTPEvent, RStringF, TInt, TInt, RStringF)

IMPORT_C void	AddFilterL	(	MHTTPFilter &	aFilter,
			THTTPEvent	aEvent,
			RStringF	aHeader,
			TInt	aStatusCode,
			TInt	aPosition,
			RStringF	aName
		)

Adds a filter to the session's filter queue.

Note: This function only adds filters; it doesn't replace or otherwise affect any pre-existing filters.

Pre-condition: The session is open and no transactions have been created yet.

See MHTTPFilter::TPositions

Parameters

MHTTPFilter & aFilter	The filter to add
THTTPEvent aEvent	The event that triggers this filter (or all)
RStringF aHeader	The header whose presence triggers this filter (or KNullDesC for any)
TInt aStatusCode	The status code that triggers this filter (or -1 for all)
TInt aPosition	The position of the filter in the queue. Standard values are documented in the documentation for the supplied filters, and are based on the standard defines in MHTTPFilter::TPositions
RStringF aName	the name of the Filter to add

AddFilterL(MHTTPFilter &, THTTPEvent, TInt, RStringF)

IMPORT_C void	AddFilterL	(	MHTTPFilter &	aFilter,
			THTTPEvent	aEvent,
			TInt	aPosition,
			RStringF	aName
		)

Adds a filter to the session's filter queue. Intended Usage: This variant takes no status code or header. It is intended for filters that are only interested in events. For example session events.

Pre-condition: The session is open and no transactions have been created yet

See MHTTPFilter::TPositions

Parameters

MHTTPFilter & aFilter	The filter to add
THTTPEvent aEvent	The event that triggers this filter (or all)
TInt aPosition	The position of the filter in the queue. Standard values are documented in the documentation for the supplied filters, and are based on the standard defines in MHTTPFilter::TPositions
RStringF aName	the name of the Filter to add

CanChangeFilters()

IMPORT_C TBool

CanChangeFilters

(

)

const

Query(RStringF)

IMPORT_C THTTPFilterIterator

Query

(

RStringF

aName = RStringF ()

)

An iterator to look at all filter registrations of a particular name. By default it will find all filters.

Parameters

RStringF aName = RStringF ()

The name of the filter to find. (All filters will be found if the default parameter is used)

RemoveFilter(RStringF)

IMPORT_C void

RemoveFilter

(

RStringF

aFilter

)

Removes all filter registrations of the specified name.

Parameters

RStringF aFilter

Filter name to remove.

Session()

RHTTPSession

Session

(

)

const [inline]

Member Data Documentation

CHTTPSession * iImplementation

CHTTPSession *

iImplementation

[private]