registry

package

v0.1.0 Latest Latest Go to latest Published: Jun 2, 2025 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/codenbase/coden

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ListWatchers() map[string]Watcher
func Register(name string, watcher Watcher)
type ISpec
type Watcher

Constants ¶

View Source

const (
	Every3Seconds = "@every 3s"
)

Variables ¶

View Source

var (
	// ErrRegistered will be returned when watcher is already been registered.
	ErrRegistered = errors.New("watcher has already been registered")
	// ErrConfigUnavailable will be returned when the configuration input is not the expected type.
	ErrConfigUnavailable = errors.New("configuration is not available")
)

Functions ¶

func ListWatchers ¶

func ListWatchers() map[string]Watcher

ListWatchers returns registered watchers in map format.

func Register ¶

func Register(name string, watcher Watcher)

Register registers a watcher and save in global variable `registry`.

Types ¶

type ISpec ¶

type ISpec interface {
	// Spec return the spec for a cron job.
	// There are two cron spec formats in common usage:
	// - standard cron format: https://en.wikipedia.org/wiki/Cron
	// - quartz scheduler format: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/tutorial-lesson-06.html
	// This method is optional for a watcher.
	Spec() string
}

Spec interface provides methods to set spec for a cron job.

type Watcher ¶

type Watcher interface {
	cron.Job
}

Watcher is the interface for watchers. It use cron job as a scheduling engine.

Source Files ¶

View all Source files

registry.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL