GoFrame gcron-基本介紹

2022-04-11 09:05 更新

基本介紹

?gcron?模塊提供了對定時(shí)任務(wù)的實(shí)現(xiàn),支持類似?crontab?的配置管理方式,并支持最小粒度到秒的定時(shí)任務(wù)管理。

使用方式:

import "github.com/gogf/gf/v2/os/gcron"

接口文檔:https://pkg.go.dev/github.com/gogf/gf/v2/os/gcron

簡要說明:

  1. ?New?方法用于創(chuàng)建自定義的定時(shí)任務(wù)管理對象;
  2. ?Add?方法用于添加定時(shí)任務(wù),其中:
    • - ?pattern ?參數(shù)使用?CRON?語法格式(具體說明見本章后續(xù)相關(guān)說明);
    • - ?job ?參數(shù)為需要執(zhí)行的任務(wù)方法(方法地址);
    • - ?name ?為非必需參數(shù),用于給定時(shí)任務(wù)指定一個(gè)唯一的名稱,注意如果已存在相同名稱的任務(wù),那么添加定時(shí)任務(wù)將會失??;
  3. ?AddSingleton?方法用于添加單例定時(shí)任務(wù),即同時(shí)只能有一個(gè)該任務(wù)正在運(yùn)行;
  4. ?AddOnce?方法用于添加只運(yùn)行一次的定時(shí)任務(wù),當(dāng)運(yùn)行一次數(shù)后該定時(shí)任務(wù)自動銷毀;
  5. ?AddTimes?方法用于添加運(yùn)行指定次數(shù)的定時(shí)任務(wù),當(dāng)運(yùn)行?times?次數(shù)后該定時(shí)任務(wù)自動銷毀;
  6. ?Entries?方法用于獲取當(dāng)前所有已注冊的定時(shí)任務(wù)信息;
  7. ?Remove?方法用于根據(jù)名稱刪除定時(shí)任務(wù)(停止并刪除);
  8. ?Search?方法用于根據(jù)名稱進(jìn)行定時(shí)任務(wù)搜索(返回定時(shí)任務(wù)?*Entry?對象指針);
  9. ?Start?方法用于啟動定時(shí)任務(wù)(?Add?后自動啟動定時(shí)任務(wù)), 可通過?name?參數(shù)指定需要啟動的任務(wù)名稱;
  10. ?Stop?方法用于停止定時(shí)任務(wù)(?Remove?會停止并刪除), 可通過?name?參數(shù)指定需要停止的任務(wù)名稱;
  11. ?Close?方法用于關(guān)閉自定義的定時(shí)任務(wù)管理對象;


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號