Chronos Plugins  5.2.0
This documentation covers the plugin interfaces definitions and an example implementation.
AxelSemrau.Chronos.Plugin.StopRunArgs Class Reference

Options for stopping the schedule/queue. More...

Public Types

enum class  StopMode { Immediately , NoNewJobs }
 Details how to stop the run More...
 

Properties

StopMode How [get, set]
 Specify how the run should be stopped More...
 
bool RestartRemainingJobs [get, set]
 In case of a soft stop, should the unstarted jobs be scheduled for a later restart? More...
 
bool StopQueue [get, set]
 Do not start any other schedules after the current one was stopped. More...
 
string Reason [get, set]
 Optional reason for the stop. More...
 
bool RunErrorMethod [get, set]
 For immediate stop, try to run the error method first. More...
 

Detailed Description

Options for stopping the schedule/queue.

Definition at line 291 of file MiscInterfaces.cs.

Member Enumeration Documentation

◆ StopMode

Details how to stop the run

Enumerator
Immediately 

Stop as soon as possible.

This also means that the queue will be stopped and that remaining samples are not rescheduled.

NoNewJobs 

Do not interrupt jobs that were already started.

Definition at line 296 of file MiscInterfaces.cs.

297  {
304  Immediately,
308  NoNewJobs
309  }

Property Documentation

◆ How

StopMode AxelSemrau.Chronos.Plugin.StopRunArgs.How
getset

Specify how the run should be stopped

Definition at line 314 of file MiscInterfaces.cs.

314 { get; set; }

◆ Reason

string AxelSemrau.Chronos.Plugin.StopRunArgs.Reason
getset

Optional reason for the stop.

Definition at line 326 of file MiscInterfaces.cs.

326 { get; set; }

◆ RestartRemainingJobs

bool AxelSemrau.Chronos.Plugin.StopRunArgs.RestartRemainingJobs
getset

In case of a soft stop, should the unstarted jobs be scheduled for a later restart?

Definition at line 318 of file MiscInterfaces.cs.

318 { get; set; }

◆ RunErrorMethod

bool AxelSemrau.Chronos.Plugin.StopRunArgs.RunErrorMethod
getset

For immediate stop, try to run the error method first.

Definition at line 330 of file MiscInterfaces.cs.

330 { get; set; }

◆ StopQueue

bool AxelSemrau.Chronos.Plugin.StopRunArgs.StopQueue
getset

Do not start any other schedules after the current one was stopped.

Definition at line 322 of file MiscInterfaces.cs.

322 { get; set; }

The documentation for this class was generated from the following file: