jobs

Documentation

Index

• Constants
• type Component
  • func NewComponent(opts ...ComponentOption) *Component
  • func (c *Component) Health() error
  • func (c *Component) Name() string
  • func (c *Component) Start() error
  • func (c *Component) Stop() error
• type ComponentOption
  • func WithLogger(logger *logrus.Entry) ComponentOption
  • func WithNamespace(namespace string) ComponentOption
  • func WithRedisPool(redisPool *redis.Pool) ComponentOption

Constants

const (
	DefaultPoolSize  = 5
	DefaultNamespace = "__foundation_jobs__"
)

const (
	ComponentName = "jobs-enqueuer"
)

Types

type Component

type Component struct {
	Enqueuer *work.Enqueuer
	// contains filtered or unexported fields
}

func NewComponent

func NewComponent(opts ...ComponentOption) *Component

func (*Component) Health

func (c *Component) Health() error

Health implements the Component interface.

func (*Component) Name

func (c *Component) Name() string

Name implements the Component interface.

func (*Component) Start

func (c *Component) Start() error

Start implements the Component interface.

func (*Component) Stop

func (c *Component) Stop() error

Stop implements the Component interface.

type ComponentOption

type ComponentOption func(*Component)

ComponentOption is an option to `Component`.

func WithLogger

func WithLogger(logger *logrus.Entry) ComponentOption

WithLogger sets the logger for the JobsEnqueuer component

func WithNamespace

func WithNamespace(namespace string) ComponentOption

WithNamespace sets the namespace for JobsEnqueuer component.

func WithRedisPool

func WithRedisPool(redisPool *redis.Pool) ComponentOption

WithRedisPool sets the redis pool for JobsEnqueuer component.