Package com.inductiveautomation.ignition.gateway.tags.evaluation

Interface WriteProcessor

All Known Subinterfaces:

ValueGeneratingActor

All Known Implementing Classes:

ScalingActorFactory.ScalingActor

public interface WriteProcessor

To participate in a tag write pipeline, a TagActor must implement this interface. since 8.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.Object	WRITE_HANDLED_SENTINEL

Method Summary

Modifier and Type	Method	Description
java.lang.Object	processWrite(NodeContext context, java.util.concurrent.CompletableFuture<QualityCode> cf, SecurityContext security, java.lang.Object value, java.util.Optional<SubIndex> subIndex)	The returned value is passed to the next actor, if the future has not been completed.

Field Detail

WRITE_HANDLED_SENTINEL

static final java.lang.Object WRITE_HANDLED_SENTINEL

Method Detail

processWrite

java.lang.Object processWrite(NodeContext context,
                              java.util.concurrent.CompletableFuture<QualityCode> cf,
                              SecurityContext security,
                              java.lang.Object value,
                              java.util.Optional<SubIndex> subIndex)

The returned value is passed to the next actor, if the future has not been completed. Gives the actors a chance to mutate the value, or cancel the write if appropriate. If WRITE_HANDLED_SENTINEL is returned, no further action should be taken.