Class SpectreConsoleHostedService

Provides a hosted service for running Spectre.Console CLI applications within a .NET Core generic host. This class handles the application lifecycle, processes commands, and manages application exit codes based on command execution results.

Inheritance

object

SpectreConsoleHostedService

Implements

IHostedService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Coree.NETStandard.SpectreConsole

Assembly: Coree.NETStandard.dll

Syntax

public class SpectreConsoleHostedService : IHostedService

Constructors

SpectreConsoleHostedService(ICommandApp, IHostApplicationLifetime)

Initializes a new instance of the SpectreConsoleHostedService class with the specified Spectre.Console CLI application and application lifetime management services.

Declaration

public SpectreConsoleHostedService(ICommandApp commandApp, IHostApplicationLifetime appLifetime)

Parameters

Type	Name	Description
ICommandApp	commandApp	The Spectre.Console CLI application to be hosted.
IHostApplicationLifetime	appLifetime	The application lifetime management service.

Methods

StartAsync(CancellationToken)

Starts the hosted Spectre.Console CLI application asynchronously. Parses the command line arguments, executes the corresponding command, and sets the application exit code based on the outcome of the command execution. This method employs a specialized set of exit codes defined by the SpectreConsoleHostedService.ExitCode enum, which may deviate from standard exit code conventions to suit the specific behavior and requirements of this application. For example, it includes codes for successful command execution that leads to application continuation or termination, and for handling cases where help information is displayed or a command is not found.

Declaration

public Task StartAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to request cancellation of the operation.

Returns

Type	Description
Task	A task that represents the asynchronous start operation.

StopAsync(CancellationToken)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Currently, this method completes immediately as no cleanup is needed.

Declaration

public Task StopAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to request cancellation of the operation.

Returns

Type	Description
Task	A task that represents the asynchronous stop operation.

Implements

IHostedService