Class StopPlugin

Namespace

DuetControlServer.Commands

Assembly

DuetControlServer.dll

Implementation of the StopPlugin command

public sealed class StopPlugin : StopPlugin

Inheritance

object

BaseCommand

Command

StopPlugin

StopPlugin

Inherited Members

StopPlugin.UpdateFromJson(JsonElement)

StopPlugin.UpdateFromJsonReader(ref Utf8JsonReader)

StopPlugin.Plugin

StopPlugin.SaveState

Command.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StopPlugin(ObjectModel, IOptions<Settings>)

Implementation of the StopPlugin command

public StopPlugin(ObjectModel model, IOptions<Settings> settings)

Parameters

model ObjectModel

Object model

settings IOptions<Settings>

Settings

Properties

StoppingAll

This is set to true if all the plugins are supposed to be stopped

[JsonIgnore]
public bool StoppingAll { get; set; }

Property Value

bool

Methods

ExecuteAsync(CancellationToken)

Stop a plugin

public override Task ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task

Asynchronous task

Exceptions

ArgumentException

Plugin is invalid