C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | Public Static Functions | List of all members
DefaultCommandFilter Class Referenceabstract

The DefaultCommandFilter class is the default implementation of ICommandFilter. It aggregates redundant view resize and ping events, thereby reducing the number of commands automatically fired to the service application. Since this filtering only applies to commands automatically generated by PureWeb for input events, changing this default is rare.

Public Functions

CommandFilterFlags::Enum CommandFilterFlags () const
 
virtual void FilterCommands (CSI::Collections::IList< Typeless > &commands)=0
 
virtual void FilterCommands (Collections::IList< Typeless > &commands)
 
void SetCommandFilterFlags (CommandFilterFlags::Enum flags)
 
Constructors and Destructors
 DefaultCommandFilter (void)
 
 DefaultCommandFilter (CommandFilterFlags::Enum filterFlags)
 
 ~DefaultCommandFilter (void)
 

Public Static Functions

static const Typeless NullCommand ()
 

Usage Description

CommandFilterFlags::Enum CommandFilterFlags ( ) const
inline

Returns the list of command filter flags currently set in the object.

virtual void FilterCommands ( CSI::Collections::IList< Typeless > &  commands)
pure virtualinherited

Filters the specified list of commands. Commands that do not pass the filter may be replaced with NullCommand, or they may be removed from the list, at the filter's discretion.

This method will be called by the PureWeb event loop, after the filter is installed through SetCommandFilter.

Parameters
commandsList of incoming commands to filter.
void FilterCommands ( Collections::IList< Typeless > &  commands)
virtual

Filters the specified list of commands. Commands that do not pass the filter may be replaced with NullCommand, or they may be removed from the list, at the filter's discretion.

This method will be called by the PureWeb event loop, after the filter is installed through SetCommandFilter.

Parameters
commandsList of incoming commands to filter.
static const Typeless NullCommand ( )
inlinestatic

A no-operation command. May be used as a substitution for commands that do not pass the filter in FilterCommands

void SetCommandFilterFlags ( CommandFilterFlags::Enum  flags)
inline

Sets the command filter flags.

Filter flags are used to control how commands should be filtered. See CommandFilterFlags for the list of supported values.