MiniDay/Velocity
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

feat: Add server registered/unregistered events (#1386)

Browse Source 
* feat: Add server registered/unregistered events

* Annotate new API with `@Beta`

* Migrate from classes to records

* Add null checks

* Fix code style indent

* Add links in documentation

* Fix docs indent

---------

Co-authored-by: powercas_gamer <cas@mizule.dev>
This commit is contained in:
Patryk Twardosz
2024-07-25 01:13:21 +02:00
committed by GitHub
parent 44b1e0c6f9
commit 09f687e5d5
3 changed files with 72 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
api/src/main/java/com/velocitypowered/api/event/proxy/server/ServerRegisteredEvent.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright (C) 2024 Velocity Contributors
*
* The Velocity API is licensed under the terms of the MIT License. For more details,
* reference the LICENSE file in the api top-level directory.
*/
package com.velocitypowered.api.event.proxy.server;
import com.google.common.annotations.Beta;
import com.google.common.base.Preconditions;
import com.velocitypowered.api.proxy.server.RegisteredServer;
import com.velocitypowered.api.proxy.server.ServerInfo;
import org.jetbrains.annotations.NotNull;
/**
* This event is fired by the proxy after a backend server is registered to the server map.
* Currently, it may occur when a server is registered dynamically at runtime or when a server is
* replaced due to configuration reload.
*
* @see com.velocitypowered.api.proxy.ProxyServer#registerServer(ServerInfo)
*
* @param registeredServer A {@link RegisteredServer} that has been registered.
* @since 3.3.0
*/
@Beta
public record ServerRegisteredEvent(@NotNull RegisteredServer registeredServer) {
public ServerRegisteredEvent {
Preconditions.checkNotNull(registeredServer, "registeredServer");
}
}

31
api/src/main/java/com/velocitypowered/api/event/proxy/server/ServerUnregisteredEvent.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright (C) 2024 Velocity Contributors
*
* The Velocity API is licensed under the terms of the MIT License. For more details,
* reference the LICENSE file in the api top-level directory.
*/
package com.velocitypowered.api.event.proxy.server;
import com.google.common.annotations.Beta;
import com.google.common.base.Preconditions;
import com.velocitypowered.api.proxy.server.RegisteredServer;
import com.velocitypowered.api.proxy.server.ServerInfo;
import org.jetbrains.annotations.NotNull;
/**
* This event is fired by the proxy after a backend server is unregistered from the server map.
* Currently, it may occur when a server is unregistered dynamically at runtime
* or when a server is replaced due to configuration reload.
*
* @see com.velocitypowered.api.proxy.ProxyServer#unregisterServer(ServerInfo)
*
* @param unregisteredServer A {@link RegisteredServer} that has been unregistered.
* @since 3.3.0
*/
@Beta
public record ServerUnregisteredEvent(@NotNull RegisteredServer unregisteredServer) {
public ServerUnregisteredEvent {
Preconditions.checkNotNull(unregisteredServer, "unregisteredServer");
}
}