Configuration.handleMessage()
Description
Appends a handleMessage filter to the current pipeline layout.
A handleMessage filter calls back user scripts every time a complete message (Message) is found in the input stream.
- INPUT - Any types of Events.
- OUTPUT - Same Events as input.
The user function that gets called will have a Message object as parameter.
A Message object is not an event, but a convenient container for a series of events that compose a complete message, that is, starting with a MessageStart event, followed by one or more Data events and ended by a MessageEnd event.
This filter passes every input event down to its output. It doesn't change how many or what events there are. However, since events are all just objects being passed around by reference, if you alter the event object itself, the change will be visible on the output, even though the references to the events are identical between the input and the output.
Syntax
pipy().pipeline().handleMessage(message => onMessage(message))
Parameters
handleMessage(handler)
A callback function that receives Messages passing through the filter.
The same Configuration object.