Interface EventScopeInstanceState
- All Known Subinterfaces:
MutableEventScopeInstanceState
- All Known Implementing Classes:
DbEventScopeInstanceState
public interface EventScopeInstanceState
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canTriggerEvent
(long eventScopeKey, org.agrona.DirectBuffer elementId) Checks if the event scope can be triggered for the given event.getInstance
(long eventScopeKey) Returns a event scope instance by key or null if none exists with this key.peekEventTrigger
(long eventScopeKey) Returns the next event trigger for the event scope or null if none exists.
-
Method Details
-
getInstance
Returns a event scope instance by key or null if none exists with this key.- Parameters:
eventScopeKey
- the key of the event scope- Returns:
- the event scope instance or null
-
peekEventTrigger
Returns the next event trigger for the event scope or null if none exists. This will not remove the event trigger from the state.- Parameters:
eventScopeKey
- the key of the event scope- Returns:
- the next event trigger or null if none exist
-
canTriggerEvent
boolean canTriggerEvent(long eventScopeKey, org.agrona.DirectBuffer elementId) Checks if the event scope can be triggered for the given event.- Parameters:
eventScopeKey
- the key of the event scope the event is triggered inelementId
- the element id of the event that is triggered- Returns:
true
if the event can be triggered, otherwisefalse
-