vcron

Documentation

Index

• func Add(ctx context.Context, pattern string, job gcron.JobFunc, name ...string) (*gcron.Entry, error)
• func AddSingleton(ctx context.Context, pattern string, job gcron.JobFunc, name ...string) (*gcron.Entry, error)
• func Start(name ...string)
• func Stop(name ...string)

Functions

func Add

func Add(ctx context.Context, pattern string, job gcron.JobFunc, name ...string) (*gcron.Entry, error)

Add adds a timed task to default cron object. A unique `name` can be bound with the timed task. It returns and error if the `name` is already used.

func AddSingleton

func AddSingleton(ctx context.Context, pattern string, job gcron.JobFunc, name ...string) (*gcron.Entry, error)

AddSingleton adds a singleton timed task, to default cron object. A singleton timed task is that can only be running one single instance at the same time. A unique `name` can be bound with the timed task. It returns and error if the `name` is already used.

func Start

func Start(name ...string)

Start starts running the specified timed task named `name`. If no`name` specified, it starts the entire cron.

func Stop

func Stop(name ...string)

Stop stops running the specified timed task named `name`. If no`name` specified, it stops the entire cron.