Package com.inductiveautomation.eventstream.gateway.stages

Interface StageEvent

All Known Implementing Classes:

StageEvent.Shutdown, StageEvent.Submit

public sealed interface StageEvent
permits StageEvent.Submit, StageEvent.Shutdown

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	StageEvent.Shutdown	Signals an EventStream has been shut down.
static final record	StageEvent.Submit

Method Summary

Modifier and Type	Method	Description
void	complete(EventResult result)	Must be called by Stage when it's done being processed by EventStream.
CompletableFuture<EventResult>	future()
default EventResult	getResult()
List<StageEvent>	split(int count)	Splits an Event into multiple copies of the same Event.

Method Details

future

CompletableFuture<EventResult> future()

complete

void complete(EventResult result)

Must be called by Stage when it's done being processed by EventStream.

Parameters:

result - True, Event was successfully handled. False, otherwise.

getResult

default EventResult getResult()

split

List<StageEvent> split(int count)

Splits an Event into multiple copies of the same Event. The originating Event will only complete once all of its copies have completed. Used when multiple stages need their own copy of events.

Parameters:

count - Amount of events to split into

Returns:

List of cloned Events