Class ServerStateProvider

Namespace

RDCore.SDK.Server.Services.States

Assembly

RDCore.SDK.dll

Manages the operational lifecycle state of a ServerApp instance.

public sealed class ServerStateProvider : IServerStateProvider, IDisposable

Inheritance

object

ServerStateProvider

Implements

IServerStateProvider

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

👉 This class works with IConfiguration rather than IOptions<TOptions> because it must be created before the application is fully configured, and must also survive the destruction of the application host in case of a hard crash.

Constructors

ServerStateProvider(IConfiguration)

Manages the operational lifecycle state of a ServerApp instance.

public ServerStateProvider(IConfiguration configuration)

Parameters

configuration IConfiguration

Remarks

👉 This class works with IConfiguration rather than IOptions<TOptions> because it must be created before the application is fully configured, and must also survive the destruction of the application host in case of a hard crash.

Properties

ProcessTokenSource

Gets the CancellationTokenSource that expires when an Exit notification is handled.

public CancellationTokenSource ProcessTokenSource { get; }

Property Value

CancellationTokenSource

Remarks

⚠️ This token terminates the server process. The process should exit with the current ExitCode.

ShutdownRequestTokenSource

Gets a CancellationTokenSource that expires when a Shutdown request is handled.

public CancellationTokenSource ShutdownRequestTokenSource { get; }

Property Value

CancellationTokenSource

State

Gets the current ServerState.

public ServerState State { get; }

Property Value

ServerState

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

OnExit()

Sets the server state to ExitingServerState if the current state is StartingServerState or ShuttingDown, otherwise throws an InvalidServerStateException; cancels the ProcessToken (causes an immediate process exit).

public void OnExit()

Exceptions

InvalidServerStateException

OnInitialize()

Sets the server state to InitializingServerState if the current state is StartingServerState, otherwise throws an InvalidServerStateException.

public void OnInitialize()

Exceptions

InvalidServerStateException

OnInitialized()

Sets the server state to RunningServerState if the current state is InitializingServerState, otherwise throws an InvalidServerStateException.

public void OnInitialized()

Exceptions

InvalidServerStateException

OnShutdown()

Sets the server state to ShuttingDown if the current state is StartingServerState or RunningServerState, otherwise throws an InvalidServerStateException; cancels the RequestToken.

public void OnShutdown()

Exceptions

InvalidServerStateException

OnTraceMessages()

Sets the server state to RunningServerState with tracing enabled.

public void OnTraceMessages()

OnTraceOff()

Sets the server state to RunningTracelessServerState.

public void OnTraceOff()

OnTraceVerbose()

Sets the server state to RunningServerState with verbose tracing enabled.

public void OnTraceVerbose()