RHTTPFilterCollection in Application Protocols HTTP

class RHTTPFilterCollection;

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.

Members

Defined in RHTTPFilterCollection:
AddFilterL(), AddFilterL(), CanChangeFilters(), Query(), RHTTPFilterCollection(), RemoveFilter(), Session()

Description

Constructor

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

Pre-Condition

The session is open and no transactions have been created yet.

Description

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.

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

Pre-Condition

The session is open and no transactions have been created yet

Description

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.

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

Description

Return value

TBool

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.

IMPORT_C void RemoveFilter(RStringF aFilter);

Description

Removes all filter registrations of the specified name.

Parameters


RStringF aFilter

Filter name to remove.

IMPORT_C THTTPFilterIterator Query(RStringF aName=RStringF());

Description

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

Parameters


RStringF aName

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

Return value

THTTPFilterIterator

A HTTP filter iterator.

inline RHTTPSession Session() const;

Description

Return value


RHTTPSession

Class `RHTTPFilterCollection`

Description

Members

See also:

Construction and destruction