Import path: gitlab.soludian.com/soludian/fountain/libs/ftasker/fcroner

fcroner

import "gitlab.soludian.com/soludian/fountain/libs/ftasker/fcroner"

Index

• Constants
• type Entry
• type EntryID
• type FCroner
  • func InstallFountainInstance(options ...Option) *FCroner
  • func (c *FCroner) GetName() string
  • func (c *FCroner) Start() error
  • func (c *FCroner) Stop() error
• type FuncJob
  • func (f FuncJob) Name() string
  • func (f FuncJob) Run(ctx context.Context) error
• type Job
• type JobWrapper
• type NamedJob
• type Option
  • func WithConfig(conf *config) Option
  • func WithEnvironment(env string) Option
  • func WithJob(job FuncJob) Option
  • func WithLocation(loc *time.Location) Option
  • func WithLock(lock locker.Lock) Option
  • func WithName(name string) Option
  • func WithParser(p fcron.Parser) Option
  • func WithSeconds() Option
  • func WithWrappers(wrappers ...JobWrapper) Option
• type Parser
• type Schedule

Constants

PackageName package name

const KPackageName = "fcroner"

type Entry

Entry...

type Entry = fcron.Entry

type EntryID

EntryID...

type EntryID = fcron.EntryID

type FCroner

FCroner...

type FCroner struct {
    // contains filtered or unexported fields
}

func InstallFountainInstance

func InstallFountainInstance(options ...Option) *FCroner

func (*FCroner) GetName

func (c *FCroner) GetName() string

Name name

func (*FCroner) Start

func (c *FCroner) Start() error

Start...

func (*FCroner) Stop

func (c *FCroner) Stop() error

Stop...

type FuncJob

FuncJob...

type FuncJob func(ctx context.Context) error

func (FuncJob) Name

func (f FuncJob) Name() string

Name...

func (FuncJob) Run

func (f FuncJob) Run(ctx context.Context) error

Run...

type Job

Job...

type Job = fcron.Job

type JobWrapper

JobWrapper...

type JobWrapper = fcron.JobWrapper

type NamedJob

NamedJob..

type NamedJob interface {
    Run(ctx context.Context) error
    Name() string
}

type Option

Option...

type Option func(c *config)

func WithConfig

func WithConfig(conf *config) Option

WithConfig Required.

func WithEnvironment

func WithEnvironment(env string) Option

func WithJob

func WithJob(job FuncJob) Option

WithJob specifies the Job

func WithLocation

func WithLocation(loc *time.Location) Option

WithLocation sets the time zone

func WithLock

func WithLock(lock locker.Lock) Option

WithLock sets the distributed lock. When Config.EnableDistributedTask = true, this Option must be set

func WithName

func WithName(name string) Option

func WithParser

func WithParser(p fcron.Parser) Option

WithParser sets the time parser

func WithSeconds

func WithSeconds() Option

WithSeconds turns on the second unit

func WithWrappers

func WithWrappers(wrappers ...JobWrapper) Option

WithWrappers sets the JobWrapper

type Parser

Parser...

type Parser = fcron.Parser

type Schedule

Schedule...

type Schedule = fcron.Schedule

Generated by gomarkdoc