Class SimpleCode

Namespace

DuetControlServer.Commands

Assembly

DuetControlServer.dll

Implementation of the SimpleCode command

public sealed class SimpleCode : SimpleCode, IConnectionCommand

Inheritance

object

BaseCommand

Command<string>

SimpleCode

SimpleCode

Implements

IConnectionCommand

Inherited Members

SimpleCode.UpdateFromJson(JsonElement)

SimpleCode.UpdateFromJsonReader(ref Utf8JsonReader)

SimpleCode.Code

SimpleCode.Channel

SimpleCode.ExecuteAsynchronously

Command<string>.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SimpleCode(CodeFactory, ObjectModel, IHostApplicationLifetime)

Implementation of the SimpleCode command

public SimpleCode(CodeFactory codeFactory, ObjectModel model, IHostApplicationLifetime lifetime)

Parameters

codeFactory CodeFactory

Code factory

model ObjectModel

Object model

lifetime IHostApplicationLifetime

Host application lifetime

Properties

Connection

Source connection of this command

public Connection? Connection { get; set; }

Property Value

Connection

IsFromFirmware

Indicates if the code comes from the firmware. Only used internally

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

Property Value

bool

Methods

ExecuteAsync(CancellationToken)

Converts simple G/M/T-codes to a regular Code instances, executes them and returns the result as text

public override Task<string> ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<string>

Code result as text

Exceptions

OperationCanceledException

Code has been cancelled

ParseAsync()

Parse codes from the given input string asynchronously

public IAsyncEnumerable<Code> ParseAsync()

Returns

IAsyncEnumerable<Code>

Parsed G/M/T-codes