Package io.camunda.zeebe.engine.state.immutable

Interface MessageState

All Known Subinterfaces:

MutableMessageState

All Known Implementing Classes:

DbMessageState

public interface MessageState

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageState.ExpiredMessageVisitor
static final record	MessageState.Index	Index to point to a specific position in the messages with deadline column family.
static interface	MessageState.MessageVisitor

Method Summary

Modifier and Type	Method	Description
boolean	exist(org.agrona.DirectBuffer name, org.agrona.DirectBuffer correlationKey, org.agrona.DirectBuffer messageId)
boolean	existActiveProcessInstance(org.agrona.DirectBuffer bpmnProcessId, org.agrona.DirectBuffer correlationKey)
boolean	existMessageCorrelation(long messageKey, org.agrona.DirectBuffer bpmnProcessId)
StoredMessage	getMessage(long messageKey)
org.agrona.DirectBuffer	getProcessInstanceCorrelationKey(long processInstanceKey)
void	visitMessages(org.agrona.DirectBuffer name, org.agrona.DirectBuffer correlationKey, MessageState.MessageVisitor visitor)
boolean	visitMessagesWithDeadlineBeforeTimestamp(long timestamp, MessageState.Index startAt, MessageState.ExpiredMessageVisitor visitor)	Visits the messages with expired deadline, using the provided visitor.

Method Details

existMessageCorrelation

boolean existMessageCorrelation(long messageKey,
 org.agrona.DirectBuffer bpmnProcessId)

existActiveProcessInstance

boolean existActiveProcessInstance(org.agrona.DirectBuffer bpmnProcessId,
 org.agrona.DirectBuffer correlationKey)

getProcessInstanceCorrelationKey

org.agrona.DirectBuffer getProcessInstanceCorrelationKey(long processInstanceKey)

visitMessages

void visitMessages(org.agrona.DirectBuffer name,
 org.agrona.DirectBuffer correlationKey,
 MessageState.MessageVisitor visitor)

getMessage

StoredMessage getMessage(long messageKey)

visitMessagesWithDeadlineBeforeTimestamp

boolean visitMessagesWithDeadlineBeforeTimestamp(long timestamp,
 MessageState.Index startAt,
 MessageState.ExpiredMessageVisitor visitor)

Visits the messages with expired deadline, using the provided visitor. The visitor stops when all messages with expired deadline have been visited, but can also be controlled through the visitor function.

Parameters:

timestamp - Timestamp used to determine whether the deadline has expired

startAt - Index used to start the iteration at; visiting starts at the beginning when startAt is null

visitor - This method is called for each message with expired deadline. It must return a boolean that when true allows the visiting to continue, or when false stops the visiting.

Returns:

true when the visiting is stopped due to the returned value of the last call to visitor, otherwise false

exist

boolean exist(org.agrona.DirectBuffer name,
 org.agrona.DirectBuffer correlationKey,
 org.agrona.DirectBuffer messageId)