Class Executed

Namespace

DuetControlServer.Codes.Pipelines

Assembly

DuetControlServer.dll

Pipeline element for dealing with codes that have been resolved or cancelled. This is the only pipeline stage that cannot maintain more than one stack level

public sealed class Executed : PipelineBase

Inheritance

object

PipelineBase

Executed

Inherited Members

PipelineBase.Stage

PipelineBase.ChannelProcessor

PipelineBase.CodeProcessor

PipelineBase.Diagnostics(StringBuilder)

PipelineBase.IsIdle(Code)

PipelineBase.FlushAsync(bool, CancellationToken)

PipelineBase.Push(CodeFile)

PipelineBase.Pop()

PipelineBase.SetJobFile(CodeFile)

PipelineBase.WaitForCompletionAsync()

PipelineBase.CurrentStackItem

PipelineBase.HasValidJobFile

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Executed(ChannelProcessor, CodeProcessor, EventLogger, LinkInterface, ObjectModel, ICodeHandler, ICodeHandler, ICodeHandler, IHostApplicationLifetime, IOptions<Settings>)

Constructor of this class

public Executed(ChannelProcessor channelProcessor, CodeProcessor codeProcessor, EventLogger eventLogger, LinkInterface linkInterface, ObjectModel model, ICodeHandler gCodes, ICodeHandler mCodes, ICodeHandler tCodes, IHostApplicationLifetime lifetime, IOptions<Settings> settings)

Parameters

channelProcessor ChannelProcessor

Channel processor

codeProcessor CodeProcessor

Code processor

eventLogger EventLogger

Event logger

linkInterface LinkInterface

model ObjectModel

Object model

gCodes ICodeHandler

G-code handler

mCodes ICodeHandler

M-code handler

tCodes ICodeHandler

T-code handler

lifetime IHostApplicationLifetime

Application lifetime

settings IOptions<Settings>

Application settings

Methods

FlushAsync(Code, CancellationToken)

Wait for the pipeline stage to become idle

public override Task<bool> FlushAsync(Code code, CancellationToken cancellationToken = default)

Parameters

code Code

Code waiting for the flush

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<bool>

Whether the codes have been flushed successfully

FlushAsync(CodeFile, CancellationToken)

Wait for the pipeline stage to become idle

public override Task<bool> FlushAsync(CodeFile file, CancellationToken cancellationToken = default)

Parameters

file CodeFile

Code file

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<bool>

Whether the codes have been flushed successfully

ProcessCodeAsync(Code)

Process an incoming code

public override Task ProcessCodeAsync(Code code)

Parameters

code Code

Code to process

Returns

Task

Asynchronous task

WriteCode(Code)

Execute a given code on this pipeline stage

public override void WriteCode(Code code)

Parameters

code Code

Code to enqueue

WriteCodeAsync(Code)

Execute a given code on this pipeline stage

public override ValueTask WriteCodeAsync(Code code)

Parameters

code Code

Code to enqueue

Returns

ValueTask

Asynchronous task