RHTTPFilterCollection in HTTP Client

class RHTTPFilterCollection

Supported from 7.0

A handle to the filter collection in a session.

It provides facilities for adding and deleting filters, and for querying what filters are installed.

Adds a filter to the session's filter queue.

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

`MHTTPFilter& aFilter`	The filter to add
`THTTPEvent aEvent`	The event that triggers this filter
`RStringF aHeader`	The header whose presence triggers this filter, or `KNullDesC` to trigger on any header
`TInt aStatusCode`	The status code that triggers this filter, or `KAnyStatusCode` to trigger on any status code
`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

KErrNoMemory

Out of memory

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

Adds a filter to the session's filter queue.

This overload takes no status code or header parameter, and so is intended for filters that are only interested in events.

`MHTTPFilter& aFilter`	The filter to add
`THTTPEvent aEvent`	The event that triggers this filter
`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

KErrNoMemory

Out of memory

TBool CanChangeFilters() const;

Tests if a filter can currently be added or removed.

Filters can only be added or removed if there are no transactions in existence on the session.


TBool

ETrue if a filter can currently be added or removed

void RemoveFilter(RStringF aFilter);

Removes all registrations of the specified filter.

RStringF aFilter

Name of the filter to remove

THTTPFilterIterator Query(RStringF aName=RStringF());

Gets an iterator for all registrations of a specified filter.

RStringF aName=RStringF()

Name of the filter to query for. By default, it will find all filters.


THTTPFilterIterator

Iterator for all registrations of the specified filter