wow-core/me.ahoo.wow.messaging.function/MessageFunction

MessageFunction

interface MessageFunction<P : Any, in M : MessageExchange<*, *>, out R> : QualifiedNamed, FunctionInfo

Represents a message function that processes messages within a message exchange. This interface defines the contract for functions that can handle specific message types and topics, providing a way to invoke processing logic on message exchanges.

Parameters

the type of the processor

the type of the message exchange, contravariant

the return type of the function

Inheritors

MessageFunctionAccessor

AbstractCommandFunction

AfterCommandFunction

StatelessSagaFunction

Properties

contextName

abstract val contextName: String

functionKind

abstract val functionKind: FunctionKind

name

abstract override val name: String

processor

abstract val processor: P

The processor instance that contains the actual business logic for handling messages.

processorName

open override val processorName: String

The name of the processor class, derived from the simple name of the processor's class.

qualifiedName

open override val qualifiedName: String

The fully qualified name of the function, formatted as "processorName.functionName(supportedTypeSimpleName)". This provides a unique identifier for the function.

supportedTopics

abstract val supportedTopics: Set<NamedAggregate>

The set of named aggregates (topics) that this function supports. The function will only process messages that match one of these aggregates.

supportedType

abstract val supportedType: Class<*>

The class type of message bodies that this function can process. Used to determine if a message is supported by checking if the message body is an instance of this type.

Functions

getAnnotation

abstract fun <A : Annotation> getAnnotation(annotationClass: Class<A>): A?

Retrieves an annotation of the specified type from the function's metadata.

getContextAlias

fun NamedBoundedContext.getContextAlias(boundedContext: BoundedContext? = MetadataSearcher.metadata.contexts[contextName]): String

getContextAliasPrefix

fun NamedBoundedContext.getContextAliasPrefix(): String

Gets the context alias prefix for this bounded context.

handle

open fun handle(exchange: M): R

Handles the message exchange by invoking the function. This method provides an alternative way to process the exchange.

invoke

abstract operator fun invoke(exchange: M): R

Invokes the message function with the given exchange. This is the primary method to execute the function's logic.

isEmpty

open fun isEmpty(): Boolean

isSameBoundedContext

open fun isSameBoundedContext(other: NamedBoundedContext): Boolean

isSameFunction

open fun isSameFunction(functionInfo: FunctionInfo): Boolean

isWaitingForFunction

fun NamedFunctionInfo?.isWaitingForFunction(function: FunctionInfo): Boolean

Checks if a function matches the criteria specified by this NamedFunctionInfo. Used to determine if a wait strategy should be notified about a specific function execution. Returns true if all specified criteria (context, processor, name) match or are not specified.

supportMessage

open fun <M : Message<*, Any>, NamedBoundedContext, NamedAggregate> supportMessage(message: M): Boolean

Checks if the given message is supported by this function. A message is supported if its body is an instance of the supported type and its aggregate matches one of the supported topics.

toWaitSignal

fun FunctionInfo.toWaitSignal(id: String, waitCommandId: String, commandId: String, aggregateId: AggregateId, stage: CommandStage, isLastProjection: Boolean = false, aggregateVersion: Int? = null, errorCode: String = ErrorCodes.SUCCEEDED, errorMsg: String = ErrorCodes.SUCCEEDED_MESSAGE, bindingErrors: List<BindingError> = emptyList(), result: Map<String, Any> = emptyMap(), commands: List<String> = listOf(), signalTime: Long = System.currentTimeMillis()): WaitSignal