Filter

Pipe Filter.

Inheritance

ObjectPipeFilter

Namespace: Pipes.PlumbingAssembly: Pipes in (Pipes.dll)

Syntax

C#

public class Filter : Pipe

Remarks

Filters may modify the contents of messages before writing them to their output pipe fitting. They may also have their parameters and filter function passed to them by control message, as well as having their Bypass/Filter operation mode toggled via control message.

Constructors

Filter(String, IPipeFitting, Func<IPipeMessage,Object,Boolean>, Object)

Constructor.

Methods

ApplyFilter(IPipeMessage)

Filter the message.

IsTarget(IPipeMessage)

Is the message directed at this filter instance?

SetFilter(Func<IPipeMessage,Object,Boolean>)

Set the Filter function.

SetParams(Object)

Set the Filter parameters.

Write(IPipeMessage)

Handle the incoming message.

Properties

Get or set the Filter mode

Fields

filter function

mode of the filter, default is FilterControlMessage.FILTER

name of the filter

parameters for the filter message