Class ServerStorageService

Namespace

McServerLauncher.Services

Assembly

McServerLauncher.dll

Loads and saves the list of registered servers in %APPDATA%\McServerLauncher\servers.json.

public class ServerStorageService

Inheritance

object

ServerStorageService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ServerStorageService(string?)

Default constructor uses %APPDATA%; dataDir is for tests.

public ServerStorageService(string? dataDir = null)

Parameters

dataDir string

Remarks

Same shape as AppSettingsService, and for the same reason: without it a test that goes anywhere near the server list reads and writes the real one on the machine running it. The two files live together, so whoever supplies a folder supplies it to both.

Properties

LastLoadOutcome

What happened with servers.json on the last Load(). Anything other than Ok should be surfaced to the user (the UI does it on startup) instead of silently showing an empty server list.

public AtomicJsonFile.LoadOutcome LastLoadOutcome { get; }

Property Value

AtomicJsonFile.LoadOutcome

QuarantinedFilePath

Where a corrupt servers.json is preserved (the ".bad" quarantine file).

public string QuarantinedFilePath { get; }

Property Value

string

Methods

Load()

Loads the list of servers. Returns an empty list if there is no file. If the file is corrupt, the last good ".bak" copy is restored when possible (see AtomicJsonFile); check LastLoadOutcome for what happened.

public List<ServerConfig> Load()

Returns

List<ServerConfig>

Save(IEnumerable<ServerConfig>)

Saves the list of servers (atomically; the previous version is kept as ".bak").

public void Save(IEnumerable<ServerConfig> servers)

Parameters

servers IEnumerable<ServerConfig>