GroupTimeoutHandler

@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class GroupTimeoutHandler(val name: String = "")(source)

Declares this function as a component group timeout handler with the given name.

Requirements

  • The declaring class must be annotated with @BService.

  • The annotation value to have same name as the one given to ComponentGroupBuilder.timeout, however, it can be omitted if you use the type-safe timeoutWith extensions.

  • First parameter must be GroupTimeoutData.

Option types

  • User data: Uses @TimeoutData, the order must match the data passed when creating the select menu, supported types and modifiers are in ParameterResolver, additional types can be added by implementing TimeoutParameterResolver.

  • Service options: No annotation, however, I recommend injecting the service in the class instead.

See also

ComponentGroupBuilder.timeout

@Aggregate

Properties

Link copied to clipboard
@get:JvmName(name = "value")
val name: String

Name of the timeout handler, referenced by ComponentGroupBuilder.timeout.