Schedule #

gFly’s scheduler offers a fresh approach to managing scheduled jobs on your server. The scheduler allows you to fluently and expressively define your command schedule within your gFly application itself. When using the scheduler, only a single cron entry is needed on your server. Your job schedule is defined in the app/console/schedules directory. To help you get started, a simple example hello-world run every 2 seconds job is defined within folder.

IMPORTANT!
The Schedule Job file should be placed in directory app/console/schedules

Run below command to start scheduler:

./build/artisan schedule:run

Scheduler only handle a instance which implemented interface IJob

// IJob The interface task.
type IJob interface {
    GetTime() string // Schedule time. Example "0/5 * * * * *"
    Handle() // Method to handle the job
}

Let example you want to create a job name TickTickJob. A struct TickTickJob will be created

// TickTickJob struct for ticktick job.
type TickTickJob struct{}

You want the job will be called every 5 seconds. So, need to implement method GetTime() string of interface IJob for struct TickTickJob

// GetTime Get time format.
func (c *TickTickJob) GetTime() string {
    return "0/5 * * * * *"
}

The handler of job will make a random message from pool (have 3 messages) and display.

// Handle Process the job.
func (c *TickTickJob) Handle() {
    var messages = []string{
        "Today is a good day to learn gFly framework",
        "What is the weather today?... Umm",
        "The job will be scheduled. The task will be enqueued!",
    }

    // Get random Index
    idx := utils.RandInt64(int64(len(messages)))

    log.Infof("Message %s", messages[idx])
    log.Infof("TickTickJob :: Run at %s", time.Now().Format("2006-01-02 15:04:05"))
}

The latest important thing is register job to scheduler

// Auto-register job into scheduler.
func init() {
    console.RegisterJob(&TickTickJob{})
}

Job file `ticktick_job.go` #

package schedules

import (
    "app/core/console"
    "app/core/log"
    "app/core/utils"
    "time"
)

// ---------------------------------------------------------------
//                      Register job.
// ---------------------------------------------------------------

// Auto-register job into scheduler.
func init() {
    console.RegisterJob(&TickTickJob{})
}

// ---------------------------------------------------------------
//                      TickTickJob struct.
// ---------------------------------------------------------------

// TickTickJob struct for ticktick job.
type TickTickJob struct{}

// GetTime Get time format.
func (c *TickTickJob) GetTime() string {
    return "0/5 * * * * *"
}

// Handle Process the job.
func (c *TickTickJob) Handle() {
    var messages = []string{
        "Today is a good day to learn gFly framework",
        "What is the weather today?... Umm",
        "The job will be scheduled. The task will be enqueued!",
    }

    // Get random Index
    idx := utils.RandInt64(int64(len(messages)))

    log.Infof("Message %s", messages[idx])
    log.Infof("TickTickJob :: Run at %s", time.Now().Format("2006-01-02 15:04:05"))
}

Note: Put the job file ticktick_job.go correct folder app/console/schedules/

Check `TickTickJob` job #

Run scheduler

./build/artisan schedule:run

Schedule #

Job file ticktick_job.go #

Check TickTickJob job #

Job file `ticktick_job.go` #

Check `TickTickJob` job #