Table of Contents

Class BackgroundService

Namespace
nanoFramework.Hosting
Assembly
nanoFramework.Hosting.dll

Base class for implementing a long running IHostedService.

public abstract class BackgroundService : IHostedService, IDisposable
Inheritance
BackgroundService
Implements
Inherited Members
Extension Methods

Constructors

BackgroundService() 

protected BackgroundService()

Properties

CancellationRequested

Gets or sets whether cancellation has been requested for this service.

protected bool CancellationRequested { get; set; }

Property Value

bool

ShutdownTimeout

Gets or sets the amount of time to wait for the ExecuteThread() to terminate.

protected TimeSpan ShutdownTimeout { get; set; }

Property Value

TimeSpan

Methods

Dispose()

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

public virtual void Dispose()

ExecuteAsync()

This method is called when the IHostedService starts.

protected abstract void ExecuteAsync()

ExecuteThread()

Gets the Thread that executes the background operation.

public virtual Thread ExecuteThread()

Returns

Thread

Remarks

Will return null if the background operation hasn't started.

Start()

Triggered when the application host is ready to start the service.

public virtual void Start()

Stop()

Triggered when the application host is performing a graceful shutdown.

public virtual void Stop()