C# Class fCraft.SchedulerTask

A task to be executed by the Scheduler. Stores timing information and state.

Show file Open project: GlennMR/800craft Class Usage Examples

Private Properties

Property	Type	Description
RunForever	SchedulerTask
SchedulerTask	System
SchedulerTask	System
SchedulerTask	System

Public Methods

Method	Description
RunForever ( System.TimeSpan interval ) : SchedulerTask	Runs the task forever at a given interval, until manually stopped.
RunForever ( System.TimeSpan interval, System.TimeSpan delay ) : SchedulerTask	Runs the task forever at a given interval after an initial delay, until manually stopped.
RunForever ( object userState, System.TimeSpan interval, System.TimeSpan delay ) : SchedulerTask	Runs the task forever at a given interval after an initial delay, until manually stopped.
RunManual ( ) : SchedulerTask	Executes the task once immediately, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.
RunManual ( System.DateTime time ) : SchedulerTask	Executes the task once at a given time, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.
RunManual ( System.TimeSpan delay ) : SchedulerTask	Executes the task once after a delay, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.
RunOnce ( ) : SchedulerTask	Runs the task once, as quickly as possible. Callback is invoked from the Scheduler thread.
RunOnce ( System.DateTime time ) : SchedulerTask	Runs the task once at a given date. If the given date is in the past, the task is ran immediately.
RunOnce ( System.TimeSpan delay ) : SchedulerTask	Runs the task once, after a given delay.
RunOnce ( object userState, System.DateTime time ) : SchedulerTask	Runs the task once at a given date. If the given date is in the past, the task is ran immediately.
RunOnce ( object userState, System.TimeSpan delay ) : SchedulerTask	Runs the task once, after a given delay.
RunRepeating ( System.TimeSpan delay, System.TimeSpan interval, int times ) : SchedulerTask	Runs the task a given number of times, at a given interval after an initial delay.
RunRepeating ( [ userState, System.TimeSpan delay, System.TimeSpan interval, int times ) : SchedulerTask	Runs the task a given number of times, at a given interval after an initial delay.
Stop ( ) : SchedulerTask	Stops the task, and removes it from the schedule.
ToString ( ) : string

Private Methods

Method	Description
RunForever ( ) : SchedulerTask
SchedulerTask ( ) : System
SchedulerTask ( [ callback, bool isBackground ) : System
SchedulerTask ( [ callback, bool isBackground, [ userState ) : System

Method Details

RunForever() public method

Runs the task forever at a given interval, until manually stopped.

public RunForever ( System.TimeSpan interval ) : SchedulerTask
interval	System.TimeSpan
return	SchedulerTask

RunForever() public method

Runs the task forever at a given interval after an initial delay, until manually stopped.

public RunForever ( System.TimeSpan interval, System.TimeSpan delay ) : SchedulerTask
interval	System.TimeSpan
delay	System.TimeSpan
return	SchedulerTask

RunForever() public method

Runs the task forever at a given interval after an initial delay, until manually stopped.

public RunForever ( object userState, System.TimeSpan interval, System.TimeSpan delay ) : SchedulerTask
userState	object
interval	System.TimeSpan
delay	System.TimeSpan
return	SchedulerTask

RunManual() public method

Executes the task once immediately, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.

public RunManual ( ) : SchedulerTask
return	SchedulerTask

RunManual() public method

Executes the task once at a given time, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.

public RunManual ( System.DateTime time ) : SchedulerTask
time	System.DateTime
return	SchedulerTask

RunManual() public method

Executes the task once after a delay, and suspends (but does not stop). A SchedulerTask object can be reused many times if ran manually.

public RunManual ( System.TimeSpan delay ) : SchedulerTask
delay	System.TimeSpan
return	SchedulerTask

RunOnce() public method

Runs the task once, as quickly as possible. Callback is invoked from the Scheduler thread.

public RunOnce ( ) : SchedulerTask
return	SchedulerTask

RunOnce() public method

Runs the task once at a given date. If the given date is in the past, the task is ran immediately.

public RunOnce ( System.DateTime time ) : SchedulerTask
time	System.DateTime
return	SchedulerTask

RunOnce() public method

Runs the task once, after a given delay.

public RunOnce ( System.TimeSpan delay ) : SchedulerTask
delay	System.TimeSpan
return	SchedulerTask

RunOnce() public method

Runs the task once at a given date. If the given date is in the past, the task is ran immediately.

public RunOnce ( object userState, System.DateTime time ) : SchedulerTask
userState	object
time	System.DateTime
return	SchedulerTask

RunOnce() public method

Runs the task once, after a given delay.

public RunOnce ( object userState, System.TimeSpan delay ) : SchedulerTask
userState	object
delay	System.TimeSpan
return	SchedulerTask

RunRepeating() public method

Runs the task a given number of times, at a given interval after an initial delay.

public RunRepeating ( System.TimeSpan delay, System.TimeSpan interval, int times ) : SchedulerTask
delay	System.TimeSpan
interval	System.TimeSpan
times	int
return	SchedulerTask

RunRepeating() public method

Runs the task a given number of times, at a given interval after an initial delay.

public RunRepeating ( [ userState, System.TimeSpan delay, System.TimeSpan interval, int times ) : SchedulerTask
userState	[
delay	System.TimeSpan
interval	System.TimeSpan
times	int
return	SchedulerTask

Stop() public method

Stops the task, and removes it from the schedule.

public Stop ( ) : SchedulerTask
return	SchedulerTask

ToString() public method

public ToString ( ) : string
return	string