api/club.arson.impulse.api.config

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BrokerConfig(val brokerId: String)

@Serializable

data class Configuration(var instanceName: String = "velocity", var servers: List<ServerConfig> = listOf(), var serverMaintenanceInterval: Long = 300, var messages: Messages = Messages())

Represents the configuration for Impulse

LifecycleSettings

@Serializable

data class LifecycleSettings(var timeouts: Timeouts = Timeouts(), var allowAutoStart: Boolean = true, var allowAutoStop: Boolean = true, var reconciliationBehavior: ReconcileBehavior = ON_STOP, var shutdownBehavior: ShutdownBehavior = ShutdownBehavior.STOP)

Lifecycle settings for a server

Messages

@Serializable

data class Messages(var startupError: String = "<red>Server is starting, please try again in a moment...</red>", var reconcileRestartTitle: String = "<red>Server is Restarting...</red>", var reconcileRestartMessage: String = "server restart imminent", var autoStartDisabled: String = "<red>Autostart is disabled for this server</red>")

Message text for user facing messages

ReconcileBehavior

@Serializable

enum ReconcileBehavior : Enum<ReconcileBehavior>

The behavior to take when reconciling a server

ServerConfig

@Serializable

data class ServerConfig(var name: String, var type: String, var lifecycleSettings: LifecycleSettings = LifecycleSettings(), var config: Any? = null)

Represents a server configuration

ShutdownBehavior

@Serializable

enum ShutdownBehavior : Enum<ShutdownBehavior>

The behavior to take when a server receives a shutdown signal

Timeouts

@Serializable

data class Timeouts(var startup: Long = 120, var shutdown: Long = 120, var reconciliationGracePeriod: Long = 60, var inactiveGracePeriod: Long = 300)

Various timeouts used for the server