Skip to content

Commit

Permalink
feat: Add server registered/unregistered events (#1386)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
Twarug and powercasgamer authored Jul 24, 2024
1 parent 44b1e0c commit 09f687e
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -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");
}
}
Original file line number Diff line number Diff line change
@@ -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");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent;
import com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent;
import com.velocitypowered.api.proxy.server.RegisteredServer;
import com.velocitypowered.api.proxy.server.ServerInfo;
import com.velocitypowered.proxy.VelocityServer;
Expand Down Expand Up @@ -84,6 +86,10 @@ public RegisteredServer register(ServerInfo serverInfo) {
throw new IllegalArgumentException(
"Server with name " + serverInfo.getName() + " already registered");
} else if (existing == null) {
if (server != null) {
server.getEventManager().fireAndForget(new ServerRegisteredEvent(rs));
}

return rs;
} else {
return existing;
Expand All @@ -107,5 +113,9 @@ public void unregister(ServerInfo serverInfo) {
"Trying to remove server %s with differing information", serverInfo.getName());
Preconditions.checkState(servers.remove(lowerName, rs),
"Server with name %s replaced whilst unregistering", serverInfo.getName());

if (server != null) {
server.getEventManager().fireAndForget(new ServerUnregisteredEvent(rs));
}
}
}

0 comments on commit 09f687e

Please sign in to comment.