FluentScheduler

https://fluentscheduler.github.io/
Admin
FluentScheduler is an automated job scheduler with a fluent interface for the .NET platform that...
Tokens:1,635
Snippets:26
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start a Schedule

Source: https://fluentscheduler.github.io/starting-stopping-and-resetting

Call this method to begin executing scheduled jobs. Ensure the schedule is properly configured before starting.

```csharp
schedule.Start();
```

--------------------------------

### Instantiate and start a new schedule

Source: https://fluentscheduler.github.io/creating-schedules

Defines a job to run every 5 minutes and immediately starts the schedule.

```csharp
var schedule = new Schedule(
    () => Console.WriteLine("5 minutes just passed."),
    run => run.Every(5).Minutes()
);

schedule.Start();
```

--------------------------------

### Basic Job Scheduling with FluentScheduler

Source: https://fluentscheduler.github.io/

This snippet demonstrates how to schedule a simple job that runs every 5 minutes. Ensure FluentScheduler is installed and configured.

```csharp
var schedule = new Schedule(
    () => Console.WriteLine("5 minutes just passed."),
    run => run.Every(5).Minutes()
);

schedule.Start();

```

--------------------------------

### Listen for Job Start Event

Source: https://fluentscheduler.github.io/listening-for-events

Subscribe to the JobStarted event to log when a job begins execution. This handler is called with event arguments containing the job's start time.

```csharp
schedule.JobStarted += (sender, ea) => Console.WriteLine($"Job started at {ea.StartTime}.");

```

--------------------------------

### Group and start multiple schedules

Source: https://fluentscheduler.github.io/grouping-schedules

Create a collection of Schedule objects and use extension methods to manage them simultaneously.

```csharp
var s1 = new Schedule(() => Console.WriteLine("A minute just passed."), run => run.Every(1).Minutes());
var s2 = new Schedule(() => Console.WriteLine("5 minutes just passed."), run => run.Every(5).Minutes());
var s3 = new Schedule(() => Console.WriteLine("10 minutes just passed."), run => run.Every(10).Minutes());

var schedules = new[] { s1, s2, s3, };

schedules.Start();
```

--------------------------------

### Schedule a task using a cron expression

Source: https://fluentscheduler.github.io/cron-expressions

Creates a new schedule that executes an action based on the provided cron string. Ensure the schedule is started after initialization.

```csharp
var schedule = new Schedule(
    () => Console.WriteLine("5 minutes just passed."),
    "*/5 * * * *"
);

schedule.Start();
```

--------------------------------

### Schedule tasks with FluentScheduler

Source: https://fluentscheduler.github.io/fluent-expressions

Use the Schedule class to define execution intervals and timing constraints for background tasks.

```csharp
new Schedule(() => { /* your code */ }, run => run.Every(2).Seconds());
```

```csharp
new Schedule(() => { /* your code */ }, run => run.OnceIn(5).Seconds());
```

```csharp
new Schedule(() => { /* your code */ }, run => run.Now().AndEvery(5).Minutes());
```

```csharp
new Schedule(() => { /* your code */ }, run => run.EveryWeekDay())
```

```csharp
new Schedule(() => { /* your code */ }, run => run.EveryWeekend())
```

```csharp
new Schedule(() => { /* your code */ }, run => run.Every(1).Days().At(21, 15));
```

```csharp
new Schedule(() => { /* your code */ }, run => run.Every(1).Month().On(20))
```

```csharp
new Schedule(() => { /* your code */ }, run => run.Every(1).Days().Except(DayOfWeek.Monday))
```

```csharp
new Schedule(() => { /* your code */ }, run => run.Now().AndEvery(1).Days().Between(1, 0, 4, 0))
```

--------------------------------

### Create an Async Schedule

Source: https://fluentscheduler.github.io/async-schedules

Use an async lambda expression within the Schedule constructor to perform asynchronous operations. Ensure proper disposal of resources like WebClient within the task.

```csharp
var schedule = new Schedule(
    async () =>
    {
        using var client = new WebClient();
        var content = await client.DownloadStringTaskAsync("http://example.com");
        Console.WriteLine(content);
    },
    run => run.Now()
);
```

--------------------------------

### Demonstrate Non-Reentrant Schedule Execution

Source: https://fluentscheduler.github.io/reentrancy

This C# code demonstrates a non-reentrant schedule that includes a long-running operation. Even though scheduled to run every second, it will only execute once at a time due to its non-reentrant nature.

```csharp
var schedule = new Schedule(
    () =>
    {
        Console.WriteLine("Waiting 5 seconds...");
        Thread.Sleep(5000);
    },
    run => run.Every(1).Seconds()
);

schedule.Start();

```

--------------------------------

### Resetting the schedule

Source: https://fluentscheduler.github.io/changing-the-scheduling

Clears the current scheduling configuration.

```csharp
schedule.ResetScheduling();
```

--------------------------------

### Configure Schedule to Use UTC Time

Source: https://fluentscheduler.github.io/utc-time

By default, schedules use local time. Call this method to change the schedule to use UTC.

```csharp
schedule.UseUtc();

```

--------------------------------

### Updating the schedule

Source: https://fluentscheduler.github.io/changing-the-scheduling

Defines a new interval for the schedule. Ensure the schedule is stopped before applying changes.

```csharp
schedule.SetScheduling(run => run.Every(2).Hour());
```

--------------------------------

### Listen for Job End Event

Source: https://fluentscheduler.github.io/listening-for-events

Subscribe to the JobEnded event to log job completion details, including end time, exceptions, and the next scheduled run. This handler processes success and failure scenarios.

```csharp
schedule.JobEnded += (sender, ea) =>
{
    if (ea.Exception == null)
        Console.WriteLine($"The job ended at {ea.EndTime}.")
    else
        Console.WriteLine($"The job ended at {ea.EndTime} due to an error: {ea.Exception}");

    if (ea.NextRun.HasValue)
        Console.WriteLine($"Next run at {ea.NextRun.Value}.");
};

```

--------------------------------

### Stop a Schedule and Block Until Completion

Source: https://fluentscheduler.github.io/starting-stopping-and-resetting

This method stops the scheduler and waits for all currently running jobs to complete before returning. Use this when a graceful shutdown is required.

```csharp
schedule.StopAndBlock();
```

--------------------------------

### Stop a Schedule Without Blocking

Source: https://fluentscheduler.github.io/starting-stopping-and-resetting

Use this method to stop the scheduler immediately without waiting for currently executing jobs to finish. This is useful for quick shutdowns.

```csharp
schedule.Stop();
```
Tokens:
Raw