core

Documentation

Index

• Constants
• Variables
• type CacheManager
  • func NewRedisCacheManager(conf RedisCacheManagerConfig) (CacheManager, error)
• type DispatchFunc
• type DispatchManagerConfig
• type Event
• type EventMode
• type ID
• type PersistenceManager
  • func NewSqlPersistenceManager(cache CacheManager, conf SqlPersistenceManagerConfig) (PersistenceManager, error)
• type RedisCacheManagerConfig
• type Scheduler
  • func NewScheduler(ctx context.Context, conf SchedulerConfig, pers PersistenceManager, ...) Scheduler
• type SchedulerConfig
• type SqlPersistenceManagerConfig
• type StackManagerConfig

Constants

const (
	TimestampMode = iota
	CronMode
)

Variables

var ErrMaxEventQueueCapacity = errors.New("the max eventQueue capacity has been reached")

var ErrMaxRawEventQueueCapacity = errors.New("the max rawEventQueue capacity has been reached")

var ErrMaxStackCapacity = errors.New("the max stack capacity has been reached")

var (
	ErrNotFound = errors.New("the requested item cannot be found")
)

var (
	ErrNotImplemented = errors.New("this method is not implemented")
)

Types

type CacheManager

type CacheManager interface {
	PersistenceManager
}

func NewRedisCacheManager

func NewRedisCacheManager(conf RedisCacheManagerConfig) (CacheManager, error)

type DispatchFunc

type DispatchFunc func(Event) error

type DispatchManagerConfig

type DispatchManagerConfig struct {
	WorkerNumber         int
	DefaultQueueCapacity int
	MaxQueueCapacity     int
}

type Event

type Event struct {
	ID ID

	// CronExpression allows us to schedule the event based on the cron expression
	CronExpression string

	// ShouldExecuteAt is the timestamp at which the event must be scheduled
	ShouldExecuteAt time.Time

	// Mode is the mode in which the event should be scheduled (CronMode or TimestampMode)
	Mode EventMode

	// Topic is the channel on which the event has to be dispatched
	Topic string

	// Payload is the content of the event
	Payload []byte
}

type EventMode

type EventMode uint

type ID

type ID string

type PersistenceManager

type PersistenceManager interface {
	Add(ctx context.Context, e Event) error
	AddBulk(ctx context.Context, evs []Event) error
	Delete(ctx context.Context, id ID) error
	Get(ctx context.Context, id ID) (Event, error)
	GetAll(ctx context.Context) ([]Event, error)
}

func NewSqlPersistenceManager

func NewSqlPersistenceManager(cache CacheManager, conf SqlPersistenceManagerConfig) (PersistenceManager, error)

type RedisCacheManagerConfig

type RedisCacheManagerConfig struct {
	Addr string
	Pass string
	DB   int
}

type Scheduler

type Scheduler interface {
	Schedule(e Event) (ID, error)
	Unschedule(id ID) error

	Start() error
	Stop()
	SetConfig(conf SchedulerConfig) error
	// contains filtered or unexported methods
}

func NewScheduler

func NewScheduler(ctx context.Context, conf SchedulerConfig, pers PersistenceManager, cache CacheManager, fn DispatchFunc) Scheduler

type SchedulerConfig

type SchedulerConfig struct {
	StackManagerConfig
	DispatchManagerConfig
	DefaultInputQueueCapacity int
	MaxInputQueueCapacity     int
	MaxBulkLimit              int
}

type SqlPersistenceManagerConfig

type SqlPersistenceManagerConfig struct {
	Url    string
	Driver string
}

type StackManagerConfig

type StackManagerConfig struct {
	StacksNumber         int
	DefaultStackCapacity int
	MaxStackCapacity     int
}