C# Class Castle.Components.Scheduler.PeriodicTrigger

Inheritance: Trigger

Show file Open project: codereflection/Castle.Components.Scheduler Class Usage Examples

Public Methods

Method	Description
Clone ( ) : Trigger
CreateDailyTrigger ( System.DateTime startTimeUtc ) : PeriodicTrigger	Creates a trigger that fires every 24 hours beginning at the specified start time. This method does not take into account local time variations such as Daylight Saving Time. Use a more sophisticated calendar-based trigger for that purpose.
CreateOneShotTrigger ( System.DateTime fireTimeUtc ) : PeriodicTrigger	Creates a trigger that fires exactly once at the specified time.
PeriodicTrigger ( System.DateTime startTimeUtc, System.DateTime endTimeUtc, System.TimeSpan period, int jobExecutionCount ) : System.Collections.Generic	Creates a periodic trigger.
Schedule ( TriggerScheduleCondition condition, System.DateTime timeBasisUtc, JobExecutionDetails lastJobExecutionDetails ) : TriggerScheduleAction

Private Methods

Method	Description
ScheduleSuggestedAction ( TriggerScheduleAction action, System.DateTime timeBasisUtc ) : TriggerScheduleAction

Method Details

Clone() public method

public Clone ( ) : Trigger
return	Trigger

CreateDailyTrigger() public static method

Creates a trigger that fires every 24 hours beginning at the specified start time.

This method does not take into account local time variations such as Daylight Saving Time. Use a more sophisticated calendar-based trigger for that purpose.

public static CreateDailyTrigger ( System.DateTime startTimeUtc ) : PeriodicTrigger
startTimeUtc	System.DateTime	The UTC date and time when the trigger will first fire
return	PeriodicTrigger

CreateOneShotTrigger() public static method

Creates a trigger that fires exactly once at the specified time.

public static CreateOneShotTrigger ( System.DateTime fireTimeUtc ) : PeriodicTrigger
fireTimeUtc	System.DateTime	The UTC time at which the trigger should fire
return	PeriodicTrigger

PeriodicTrigger() public method

Creates a periodic trigger.

Thrown if is negative or zero Thrown if is negative

public PeriodicTrigger ( System.DateTime startTimeUtc, System.DateTime endTimeUtc, System.TimeSpan period, int jobExecutionCount ) : System.Collections.Generic
startTimeUtc	System.DateTime	The UTC date and time when the trigger will first fire
endTimeUtc	System.DateTime	The UTC date and time when the trigger must stop firing. /// If the time is set to null, the trigger may continue firing indefinitely.
period	System.TimeSpan	The recurrence period of the trigger. /// If the period is set to null, the trigger will fire exactly once /// and never recur.
jobExecutionCount	int	The number of job executions remaining before the trigger /// stops firing. This number is decremented each time the job executes /// until it reaches zero. If the count is set to null, the number of times the job /// may execute is unlimited.
return	System.Collections.Generic

Schedule() public method

public Schedule ( TriggerScheduleCondition condition, System.DateTime timeBasisUtc, JobExecutionDetails lastJobExecutionDetails ) : TriggerScheduleAction
condition	TriggerScheduleCondition
timeBasisUtc	System.DateTime
lastJobExecutionDetails	JobExecutionDetails
return	TriggerScheduleAction