Anvil
Anvil.Services.ScheduledTask Class Reference
+ Inheritance diagram for Anvil.Services.ScheduledTask:
+ Collaboration diagram for Anvil.Services.ScheduledTask:

Public Member Functions

void Cancel ()
 Cancels the execution of this task. More...
 
void Dispose ()
 

Public Attributes

readonly bool Repeating
 Gets if this is a repeating scheduled task. More...
 
readonly TimeSpan Schedule
 Gets the interval for repeating this task if Repeating is set to true. More...
 

Properties

int ExecutionCount [get]
 Gets the number of times this task has successfully executed. More...
 
TimeSpan ExecutionTime [get]
 Gets the API.Time.TimeSinceStartup that this task was last executed/will next be executed at. More...
 
int FailedExecutionCount [get]
 Gets the number of times this task has failed to execute because of an exception. More...
 
bool IsCancelled [get]
 Gets if this task has been cancelled for execution. More...
 

Member Function Documentation

◆ Cancel()

void Anvil.Services.ScheduledTask.Cancel ( )
inline

Cancels the execution of this task.

◆ Dispose()

void Anvil.Services.ScheduledTask.Dispose ( )
inline

Member Data Documentation

◆ Repeating

readonly bool Anvil.Services.ScheduledTask.Repeating

Gets if this is a repeating scheduled task.

◆ Schedule

readonly TimeSpan Anvil.Services.ScheduledTask.Schedule

Gets the interval for repeating this task if Repeating is set to true.

Property Documentation

◆ ExecutionCount

int Anvil.Services.ScheduledTask.ExecutionCount
get

Gets the number of times this task has successfully executed.

◆ ExecutionTime

TimeSpan Anvil.Services.ScheduledTask.ExecutionTime
get

Gets the API.Time.TimeSinceStartup that this task was last executed/will next be executed at.

◆ FailedExecutionCount

int Anvil.Services.ScheduledTask.FailedExecutionCount
get

Gets the number of times this task has failed to execute because of an exception.

◆ IsCancelled

bool Anvil.Services.ScheduledTask.IsCancelled
get

Gets if this task has been cancelled for execution.


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