FilterControlMessage
Inheritance
Syntax
public class FilterControlMessage : Message
Remarks
A special message type for controlling the behavior of a Filter.
The FilterControlMessage.SET_PARAMS message type tells the Filter to retrieve the filter parameters object.
The FilterControlMessage.SET_FILTER message type tells the Filter to retrieve the filter function.
The FilterControlMessage.BYPASS message type tells the Filter that it should go into Bypass mode operation, passing all normal messages through unfiltered.
The FilterControlMessage.FILTER message type tells the Filter that it should go into Filtering mode operation, filtering all normal normal messages before writing out. This is the default mode of operation and so this message type need only be sent to cancel a previous FilterControlMessage.BYPASS message.
The Filter only acts on a control message if it is targeted to this named filter instance. Otherwise it writes the message through to its output unchanged.