net.minestom.server.extras.lan.OpenToLANConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of minestom-snapshots Show documentation

1.20.4 Lightweight Minecraft server

There is a newer version: 7320437640

package net.minestom.server.extras.lan;

import net.minestom.server.event.server.ServerListPingEvent;
import net.minestom.server.utils.time.TimeUnit;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;

import java.time.Duration;
import java.util.Objects;

/**
 * Configuration for opening the server to LAN.
 *
 * @see OpenToLAN#open(OpenToLANConfig)
 */
public class OpenToLANConfig {
    int port;
    Duration delayBetweenPings, delayBetweenEvent;

    /**
     * Creates a new config with the port set to random and the delay between pings set
     * to 1.5 seconds and the delay between event calls set to 30 seconds.
     */
    public OpenToLANConfig() {
        this.port = 0;
        this.delayBetweenPings = Duration.of(1500, TimeUnit.MILLISECOND);
        this.delayBetweenEvent = Duration.of(30, TimeUnit.SECOND);
    }

    /**
     * Sets the port used to send pings from. Use {@code 0} to pick a random free port.
     *
     * @param port the port
     * @return {@code this}, for chaining
     */
    @Contract("_ -> this")
    public @NotNull OpenToLANConfig port(int port) {
        this.port = port;
        return this;
    }

    /**
     * Sets the delay between outgoing pings.
     *
     * @param delay the delay
     * @return {@code this}, for chaining
     */
    @Contract("_ -> this")
    public @NotNull OpenToLANConfig pingDelay(@NotNull Duration delay) {
        this.delayBetweenPings = Objects.requireNonNull(delay, "delay");
        return this;
    }

    /**
     * Sets the delay between calls of {@link ServerListPingEvent}.
     *
     * @param delay the delay
     * @return {@code this}, for chaining
     */
    @Contract("_ -> this")
    public @NotNull OpenToLANConfig eventCallDelay(@NotNull Duration delay) {
        this.delayBetweenEvent = Objects.requireNonNull(delay, "delay");
        return this;
    }
}