beanstalk

Documentation

Index

• type Broker
  • func (b *Broker) Consume(pipe *jobs.Pipeline, execPool chan jobs.Handler, errHandler jobs.ErrorHandler) error
  • func (b *Broker) Init(cfg *Config) (bool, error)
  • func (b *Broker) Listen(lsn func(event int, ctx interface{}))
  • func (b *Broker) Push(pipe *jobs.Pipeline, j *jobs.Job) (string, error)
  • func (b *Broker) Register(pipe *jobs.Pipeline) error
  • func (b *Broker) Serve() (err error)
  • func (b *Broker) Stat(pipe *jobs.Pipeline) (stat *jobs.Stat, err error)
  • func (b *Broker) Stop()
• type Config
  • func (c *Config) Hydrate(cfg service.Config) error
  • func (c *Config) TimeoutDuration() time.Duration

Types

type Broker

type Broker struct {
	// contains filtered or unexported fields
}

Broker run consume using Broker service.

func (*Broker) Consume

func (b *Broker) Consume(pipe *jobs.Pipeline, execPool chan jobs.Handler, errHandler jobs.ErrorHandler) error

Consume configures pipeline to be consumed. With execPool to nil to reset consuming. Method can be called before the service is started!

func (*Broker) Init

func (b *Broker) Init(cfg *Config) (bool, error)

Init configures broker.

func (*Broker) Listen

func (b *Broker) Listen(lsn func(event int, ctx interface{}))

Listen attaches server event watcher.

func (*Broker) Push

func (b *Broker) Push(pipe *jobs.Pipeline, j *jobs.Job) (string, error)

Push data into the worker.

func (*Broker) Register

func (b *Broker) Register(pipe *jobs.Pipeline) error

Register broker pipeline.

func (*Broker) Serve

func (b *Broker) Serve() (err error)

Serve broker pipelines.

func (*Broker) Stat

func (b *Broker) Stat(pipe *jobs.Pipeline) (stat *jobs.Stat, err error)

Stat must fetch statistics about given pipeline or return error.

func (*Broker) Stop

func (b *Broker) Stop()

Stop all pipelines.

type Config

type Config struct {
	// Addr of beanstalk server.
	Addr string

	// Timeout to allocate the connection. Default 10 seconds.
	Timeout int
}

Config defines beanstalk broker configuration.

func (*Config) Hydrate

func (c *Config) Hydrate(cfg service.Config) error

Hydrate config values.

func (*Config) TimeoutDuration

func (c *Config) TimeoutDuration() time.Duration

TimeoutDuration returns number of seconds allowed to allocate the connection.