Write(IPipeMessage)

Handle the incoming message.
Namespace: Pipes.PlumbingAssembly: Pipes in (Pipes.dll)

Syntax

C#
public bool Write(
	IPipeMessage message
	)

Parameters

messageIPipeMessage

Returns

Boolean
Boolean True if the filter process does not throw an error and subsequent operations in the pipeline succede.

Remarks

If message type is normal, filter the message (unless in BYPASS mode) and write the result to the output pipe fitting if the filter operation is successful.

The FilterControlMessage.SET_PARAMS message type tells the Filter that the message class is FilterControlMessage, which it casts the message to in order to retrieve the filter parameters object if the message is addressed to this filter.

The FilterControlMessage.SET_FILTER message type tells the Filter that the message class is FilterControlMessage, which it casts the message to in order 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 BYPASS message.

The Filter only acts on the control message if it is targeted to this named filter instance. Otherwise it writes through to the output.