RHTTPFilterCollection Class Reference

#include <mw/http/rhttpfiltercollection.h>

Link against: http.lib

class RHTTPFilterCollection

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()

Detailed Description

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

Constructor & Destructor Documentation

RHTTPFilterCollection ( )

RHTTPFilterCollection

(

)

[inline]

Constructor

Member Function 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.

Parameter	Description
aFilter	The filter to add
aEvent	The event that triggers this filter (or all)
aHeader	The header whose presence triggers this filter (or KNullDesC for any)
aStatusCode	The status code that triggers this filter (or -1 for all)
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
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

Parameter	Description
aFilter	The filter to add
aEvent	The event that triggers this filter (or all)
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
aName	the name of the Filter to add

CanChangeFilters ( )

IMPORT_C TBool

CanChangeFilters

(

)

const

Returns: ETrue if filters can currently be added or removed. Filters can only be added/removed if there are no transactions in existence on the session.