Record Class EngineConfiguration

java.lang.Object
java.lang.Record
io.github.protasm.jvmud.execution.application.EngineConfiguration
public record EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads, Path mudlibDirectory, String publicHost) extends Record
Application endpoints and private control state, independent of mudlib manifests.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads)
    Uses the working directory's mudlibs folder for administrator-visible mudlibs.
    EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads, Path mudlibDirectory)
    Omits a public hostname, so directories refer players to the host they already connected to.
    EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads, Path mudlibDirectory, String publicHost)
    Validates independent ports; zero asks the OS to allocate a free port for embedding.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    adminPort()
    Returns the value of the adminPort record component.
    String
    bindAddress()
    Returns the value of the bindAddress record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Path
    mudlibDirectory()
    Returns the value of the mudlibDirectory record component.
    int
    playerPort()
    Returns the value of the playerPort record component.
    String
    publicHost()
    Returns the value of the publicHost record component.
    Path
    stateDirectory()
    Returns the value of the stateDirectory record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    traceLoads()
    Returns the value of the traceLoads record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EngineConfiguration

      public EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads, Path mudlibDirectory)
      Omits a public hostname, so directories refer players to the host they already connected to.

    • EngineConfiguration

      public EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads)
      Uses the working directory's mudlibs folder for administrator-visible mudlibs.

    • EngineConfiguration

      public EngineConfiguration(String bindAddress, int playerPort, int adminPort, Path stateDirectory, boolean traceLoads, Path mudlibDirectory, String publicHost)
      Validates independent ports; zero asks the OS to allocate a free port for embedding.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • bindAddress

      public String bindAddress()
      Returns the value of the bindAddress record component.
      Returns:
      the value of the bindAddress record component

    • playerPort

      public int playerPort()
      Returns the value of the playerPort record component.
      Returns:
      the value of the playerPort record component

    • adminPort

      public int adminPort()
      Returns the value of the adminPort record component.
      Returns:
      the value of the adminPort record component

    • stateDirectory

      public Path stateDirectory()
      Returns the value of the stateDirectory record component.
      Returns:
      the value of the stateDirectory record component

    • traceLoads

      public boolean traceLoads()
      Returns the value of the traceLoads record component.
      Returns:
      the value of the traceLoads record component

    • mudlibDirectory

      public Path mudlibDirectory()
      Returns the value of the mudlibDirectory record component.
      Returns:
      the value of the mudlibDirectory record component

    • publicHost

      public String publicHost()
      Returns the value of the publicHost record component.
      Returns:
      the value of the publicHost record component