Categorygithub.com/go-tick/core
modulepackage
0.1.0-beta.1
Repository: https://github.com/go-tick/core.git
Documentation: pkg.go.dev

# README

⏲️ GoTick

TBA

# Functions

DefaultInMemoryConfig returns the default configuration for the in-memory driver.
DefaultPlannerConfig returns the default configuration for the planner.
DefaultSchedulerConfig returns the default configuration for the scheduler.
NewCalendarSchedule creates a new JobSchedule based on the provided time.
NewCalendarScheduleWithMaxDelay creates a new JobSchedule based on the provided time and max delay.
NewCronSchedule creates a new JobSchedule based on the provided cron string.
NewCronScheduleWithMaxDelay creates a new JobSchedule based on the provided cron string and max delay.
No description provided by the author
No description provided by the author
No description provided by the author
NewSequenceSchedule creates a new JobSchedule based on the provided sequence of times.
NewSequenceScheduleWithMaxDelay creates a new JobSchedule based on the provided sequence of times and max delay.
WithDefaultPlannerFactory sets the default planner factory.
WithDelayedStrategy sets the strategy to use when a job is delayed.
WithDriverFactory sets the driver factory.
WithIdlePollingInterval sets the polling timeout.
WithInMemoryDriverFactory sets the in-memory driver factory.
WithMaxPlanAhead sets the maximum time for which a job can be planned in advance.
WithPlannerFactory sets the planner factory.
WithPlannerThreads sets the number of threads to use in the planner for next execution evaluations.
WithPlannerTimeout sets the timeout for the planner to plan a job.
WithScheduleLockTimeout sets the timeout for the in-memory driver for the schedule to be locked after job is planned for next execution.
WithSubscribers adds the given subscribers to the scheduler.
WithThreads sets the number of threads to use in the scheduler for next execution evaluations.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

BackgroundService is an interface that represents a service that can be started and stopped in the background.
Job represents a job that can be executed by a scheduler.
JobSchedule represents a schedule for a job.
MaxDelay represents an interface that exposes the maximum delay (used as extension for a schedule).
No description provided by the author
PlannerSubscriber is an interface that represents a subscriber to a planner.
Scheduler is an interface that represents a job scheduler.
SchedulerDriver is an interface that represents a driver (storage) for a scheduler that can schedule jobs, unschedule jobs and plans job executions.
SchedulerSubscriber is an interface that represents a subscriber to a scheduler.
Timeout represents an interface that exposes the timeout (used as extension for a job).

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author