Class FilterMessageType

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

Represents an operator that filters the sequence for valid Harp messages matching the specified message type.

[WorkflowElementIcon(typeof(ElementCategory), "Reactive.Condition")]
public class FilterMessageType : Combinator<HarpMessage, HarpMessage>

Inheritance

object

Combinator<HarpMessage, HarpMessage>

FilterMessageType

Inherited Members

Combinator<HarpMessage, HarpMessage>.Process(IObservable<HarpMessage>)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

FilterType

Gets or sets a value specifying how the message filter will use the matching criteria.

public FilterType FilterType { get; set; }

Property Value

FilterType

MessageType

Gets or sets a value specifying the expected message type. If no value is specified, all messages will be accepted.

public MessageType? MessageType { get; set; }

Property Value

MessageType?

Methods

Process(IObservable<HarpMessage>)

Filters an observable sequence for Harp messages matching the specified message type criteria.

public override IObservable<HarpMessage> Process(IObservable<HarpMessage> source)

Parameters

source IObservable<HarpMessage>

An observable sequence of Harp messages.

Returns

IObservable<HarpMessage>

An observable sequence including or excluding the Harp messages matching the specified message type, depending on the specified filter type. If message type is null, messages of any type are accepted. Error messages are always rejected.