Class Firmware

Namespace

DuetControlServer.Codes.Pipelines

Assembly

DuetControlServer.dll

Dummy stage for codes ready to be sent to the firmware. This class is not used by the pipeline itself but indirectly from the SPI channel processor

public sealed class Firmware : PipelineBase

Inheritance

object

PipelineBase

Firmware

Inherited Members

PipelineBase.Stage

PipelineBase.ChannelProcessor

PipelineBase.CodeProcessor

PipelineBase.Diagnostics(StringBuilder)

PipelineBase.IsIdle(Code)

PipelineBase.WriteCode(Code)

PipelineBase.WriteCodeAsync(Code)

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

Firmware(ChannelProcessor, CodeProcessor, LinkInterface, IHostApplicationLifetime, IOptions<Settings>)

Dummy stage for codes ready to be sent to the firmware. This class is not used by the pipeline itself but indirectly from the SPI channel processor

public Firmware(ChannelProcessor channelProcessor, CodeProcessor codeProcessor, LinkInterface linkInterface, IHostApplicationLifetime lifetime, IOptions<Settings> settings)

Parameters

channelProcessor ChannelProcessor

Channel processor

codeProcessor CodeProcessor

Code processor

linkInterface LinkInterface

Link interface

lifetime IHostApplicationLifetime

Application lifetime

settings IOptions<Settings>

Application settings

See Also

Processor

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

cancellationToken CancellationToken

Returns

Task<bool>

Whether the codes have been flushed successfully

FlushAsync(bool, CancellationToken)

Wait for the pipeline stage to become idle

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

Parameters

flushAll bool

Flush everything

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

See Also

Processor