Table of Contents

Class Flush

Namespace
DuetAPI.Commands
Assembly
DuetAPI.dll

Wait for all pending (macro) codes on the given channel to finish. This effectively guarantees that all buffered codes are processed by RRF before this command finishes. If the flush request is successful, true is returned

[RequiredPermissions(SbcPermissions.CommandExecution)]
public class Flush : Command<bool>
Inheritance
Flush
Derived
Inherited Members

Constructors

Flush() 

public Flush()

Properties

Channel

Code channel to flush

public CodeChannel Channel { get; set; }

Property Value

CodeChannel

Remarks

This value is ignored if this request is processed while a code is being intercepted

IfExecuting

Check if the corresponding channel is actually executing codes (i.e. if it is active). If the input channel is not active, this command returns false

public bool IfExecuting { get; set; }

Property Value

bool

Remarks

This option is ignored if SyncFileStreams is true

SyncFileStreams

Whether the File and File2 streams are supposed to synchronize if a code is being intercepted

public bool SyncFileStreams { get; set; }

Property Value

bool

Remarks

This option should be used with care, under certain circumstances this can lead to a deadlock!

Methods

UpdateFromJson(JsonElement)

Update this instance from a given JSON element

public override void UpdateFromJson(JsonElement jsonElement)

Parameters

jsonElement JsonElement

Element to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader)

Update this instance from a given JSON element

public override void UpdateFromJsonReader(ref Utf8JsonReader reader)

Parameters

reader Utf8JsonReader

Reader to update this intance from

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data