SubscribeMatch

ISubscription ISignal.SubscribeMatch(Uint32Condition condition, SignalMatchHandler<uint> handler)

Subscribes a callback to be executed when the signal matches the specified condition.

Parameters

• condition – Uint32Condition specifying when callback is to be executed.

• handler – Delegate to be invoked when match occurs.

Returns

ISubscription – An ISubscription for the callback.

Throws

• NullArgumentException – Null reference was passed.

• InvalidArgumentException – Invalid condition (e.g. mask is zero).

• UnsupportedException – Condition type not supported for this signal (signal data type must be SignalDataType.Uint32, SignalDataType.Enum, SignalDataType.Mask, SignalDataType.Bool, SignalDataType.Uint8, SignalDataType.Int8, SignalDataType.Uint16, SignalDataType.Int16 or SignalDataType.Int32).

• UnsupportedException – Signal doesn’t support match functionality (see product specific documentation).

• InvalidOperationException – Top-controller state is not “Run”.

• OutOfResourcesException – No resources available to subscribe callback.

• CommunicationErrorException – Protocol error.

• ConnectionLostException – Connection to controller lost.

• RebootedException – Controller has been rebooted since this object reference was retrieved, invalidating this reference.