Share via


Timer.ScheduleAtFixedRate Method

Definition

Overloads

ScheduleAtFixedRate(TimerTask, Date, Int64)

Schedules the specified task for repeated fixed-rate execution, beginning at the specified time.

ScheduleAtFixedRate(TimerTask, Int64, Int64)

Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay.

ScheduleAtFixedRate(TimerTask, Date, Int64)

Schedules the specified task for repeated fixed-rate execution, beginning at the specified time.

[Android.Runtime.Register("scheduleAtFixedRate", "(Ljava/util/TimerTask;Ljava/util/Date;J)V", "GetScheduleAtFixedRate_Ljava_util_TimerTask_Ljava_util_Date_JHandler")]
public virtual void ScheduleAtFixedRate (Java.Util.TimerTask? task, Java.Util.Date? firstTime, long period);
[<Android.Runtime.Register("scheduleAtFixedRate", "(Ljava/util/TimerTask;Ljava/util/Date;J)V", "GetScheduleAtFixedRate_Ljava_util_TimerTask_Ljava_util_Date_JHandler")>]
abstract member ScheduleAtFixedRate : Java.Util.TimerTask * Java.Util.Date * int64 -> unit
override this.ScheduleAtFixedRate : Java.Util.TimerTask * Java.Util.Date * int64 -> unit

Parameters

task
TimerTask

task to be scheduled.

firstTime
Date

First time at which task is to be executed.

period
Int64

time in milliseconds between successive task executions.

Attributes

Exceptions

if when.getTime() or period <= 0.

if the Timer has been canceled, or if the task has been scheduled or canceled.

Remarks

Schedules the specified task for repeated fixed-rate execution, beginning at the specified time. Subsequent executions take place at approximately regular intervals, separated by the specified period.

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate). As a consequence of the above, if the scheduled first time is in the past, then any "missed" executions will be scheduled for immediate "catch up" execution.

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.

Java documentation for java.util.Timer.scheduleAtFixedRate(java.util.TimerTask, java.util.Date, long).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to

ScheduleAtFixedRate(TimerTask, Int64, Int64)

Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay.

[Android.Runtime.Register("scheduleAtFixedRate", "(Ljava/util/TimerTask;JJ)V", "GetScheduleAtFixedRate_Ljava_util_TimerTask_JJHandler")]
public virtual void ScheduleAtFixedRate (Java.Util.TimerTask? task, long delay, long period);
[<Android.Runtime.Register("scheduleAtFixedRate", "(Ljava/util/TimerTask;JJ)V", "GetScheduleAtFixedRate_Ljava_util_TimerTask_JJHandler")>]
abstract member ScheduleAtFixedRate : Java.Util.TimerTask * int64 * int64 -> unit
override this.ScheduleAtFixedRate : Java.Util.TimerTask * int64 * int64 -> unit

Parameters

task
TimerTask

task to be scheduled.

delay
Int64

delay in milliseconds before task is to be executed.

period
Int64

time in milliseconds between successive task executions.

Attributes

Exceptions

if delay or period <= 0.

if the Timer has been canceled, or if the task has been scheduled or canceled.

Remarks

Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals, separated by the specified period.

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.

Java documentation for java.util.Timer.scheduleAtFixedRate(java.util.TimerTask, long, long).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to