RHTTPFilterCollection Class Reference

#include <mw/http/rhttpfiltercollection.h>

class RHTTPFilterCollection

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.

See also: RHTTPSession::FilterCollection MHTTPFilter::TPositions

Constructor & Destructor Documentation

RHTTPFilterCollection ( )

RHTTPFilterCollection()[inline]

Constructor

Member Function Documentation

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

IMPORT_C voidAddFilterL(MHTTPFilter &aFilter,
THTTPEventaEvent,
RStringFaHeader,
TIntaStatusCode,
TIntaPosition,
RStringFaName
)

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 also: See MHTTPFilter::TPositions

Parameters
aFilterThe filter to add
aEventThe event that triggers this filter (or all)
aHeaderThe header whose presence triggers this filter (or KNullDesC for any)
aStatusCodeThe status code that triggers this filter (or -1 for all)
aPositionThe 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
aNamethe name of the Filter to add

AddFilterL ( MHTTPFilter &, THTTPEvent, TInt, RStringF )

IMPORT_C voidAddFilterL(MHTTPFilter &aFilter,
THTTPEventaEvent,
TIntaPosition,
RStringFaName
)
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 also: See MHTTPFilter::TPositions

Parameters
aFilterThe filter to add
aEventThe event that triggers this filter (or all)
aPositionThe 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
aNamethe name of the Filter to add

CanChangeFilters ( )

IMPORT_C TBoolCanChangeFilters()const

Return Value
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.

Query ( RStringF )

IMPORT_C THTTPFilterIteratorQuery(RStringFaName =  RStringF())

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

Parameters
aNameThe name of the filter to find. (All filters will be found if the default parameter is used)
Return Value
A HTTP filter iterator.

RemoveFilter ( RStringF )

IMPORT_C voidRemoveFilter(RStringFaFilter)

Removes all filter registrations of the specified name.

Parameters
aFilterFilter name to remove.

Session ( )

RHTTPSession Session()const [inline]