backend/com.tecknobit.brownie.helpers/LocalEventsHandler

Local Events Handler

@Component
open class LocalEventsHandler

The LocalEventsHandler component class is used to handle the local events registered during the runtime of the backend instance on the same physical machine where is running. These events are useful to indicate that for example the host has been stopped or has been rebooted so is needed to restart the auto run services etc...

Author

N7ghtm4r3 - Tecknobit

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
enum LocalEvent
LocalEvent list of available local events handled

Properties

Link copied to clipboard
@Autowired
private open var hostsService: HostsService
hostsService the service used to handle the hosts between controller and related repository
Link copied to clipboard
private val LOCAL_EVENTS_HANDLER: LocalEventsHandler
LOCAL_EVENTS_HANDLER the singleton instance of the local events handler
Link copied to clipboard
private val preferences: Preferences
preferences the local preferences used to store the local events to register

Functions

Link copied to clipboard
@EventListener(value = ApplicationReadyEvent::class )
open fun executeLocalEventsScan()
Event listener which wait the complete startup of the backend to perform the scan of the local events currently registered and to handle
Link copied to clipboard
open fun getInstance(): LocalEventsHandler
Method used to obtain an instance of the handler
Link copied to clipboard
private open fun hasLocalEventRegistered(event: LocalEventsHandler.LocalEvent): Boolean
Method used to check whether a LocalEvent is registered
Link copied to clipboard
open fun hostSuspendedEventIsRegistered(): Boolean
Method used to check whether the HOST_SUSPENDED event is registered
Link copied to clipboard
open fun registerHostSuspendedEvent(host: BrownieHost)
Method used to register the HOST_SUSPENDED event
Link copied to clipboard
private open fun registerLocalEvent(event: LocalEventsHandler.LocalEvent)
Method used to register a local event
Link copied to clipboard
open fun unregisterHostSuspendedEvent()
Method used to unregister the previously registered HOST_SUSPENDED event and the additional information registered
Link copied to clipboard
private open fun unregisterLocalEvent(event: LocalEventsHandler.LocalEvent)
Method used to unregister a local event