Class Flush

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

Inheritance
object
BaseCommand
Command<bool>
Flush
Flush
Inherited Members
Namespace: DuetAPI.Commands
Assembly: DuetAPI.dll
Syntax
[RequiredPermissions(SbcPermissions.CommandExecution)]
public class Flush : Command<bool>

Properties

Channel

Code channel to flush

Declaration
public CodeChannel Channel { get; set; }
Property Value
Type Description
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

Declaration
public bool IfExecuting { get; set; }
Property Value
Type Description
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

Declaration
public bool SyncFileStreams { get; set; }
Property Value
Type Description
bool
Remarks

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