Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.71 KB

Scheduling.md

File metadata and controls

50 lines (36 loc) · 2.71 KB
Raw

Scheduling

The @ScheduledTask annotation is a part of the Bring Framework's scheduling support, designed to mark methods as scheduled tasks. This annotation enables automatic invocation of annotated methods at specified intervals, facilitating the execution of recurring tasks within applications.

Annotation Details

The @ScheduledTask annotation provides the following attributes for customization:

  • value: Specifies the name of the scheduled task.
  • initialDelay: Represents the delay in milliseconds before the first execution (default: 1000 milliseconds).
  • period: Denotes the fixed rate in milliseconds between consecutive executions (default: 5000 milliseconds).
  • timeUnit: Specifies the time unit for initialDelay and period (default: TimeUnit.MILLISECONDS).

Usage Example

import io.github.blyznytsiaorg.bring.core.annotation.Component;
import io.github.blyznytsiaorg.bring.core.annotation.ScheduledTask;

import java.time.LocalDateTime;

@Component
public class MyScheduledTasks {

    @ScheduledTask(value = "myTask", period = 10000)
    public void scheduledMethod1() {
        System.out.println(Thread.currentThread().getName() + " scheduledMethod1 " + LocalDateTime.now());
    }
}

Explanation

  • @Service: Annotation indicating that the class is a Bring service component.
  • @ScheduledTask: Applied to a method, marking it as a scheduled task.
    • value = "myTask": Assigns a specific name ("myTask") to this scheduled task.
    • initialDelay = 1000: Sets the initial delay before the first execution of the task to 1000 milliseconds (1 second).
    • period = 5000: Specifies the interval between consecutive executions of the task to 5000 milliseconds (5 seconds).
    • timeUnit = TimeUnit.MILLISECONDS: Indicates that the time values (initial delay and period) are in milliseconds.

Classes worth exploring for a deeper understanding of triggering mechanisms.

  • CustomScheduleConfiguration - Configures a custom schedule with a specific core pool size for executing scheduled tasks. This class sets up a scheduled executor service with a defined core pool size and creates a custom scheduler based on this executor service.
  • CustomScheduler - Represents a custom scheduler utilizing a ScheduledExecutorService for task scheduling. This class wraps a ScheduledExecutorService and provides methods to schedule tasks, as well as to shut down the underlying executor service.
  • ScheduleBeanPostProcessor - A BeanPostProcessor responsible for processing beans and registering methods annotated with @ScheduledTask for scheduling via a CustomScheduler.

The @ScheduledTask annotation simplifies the scheduling of recurring tasks within your application, enhancing efficiency by automating periodic executions.