beanstalk

Documentation

Index

• type Broker
  • func (b *Broker) Init(cfg *Config) (bool, error)
  • func (b *Broker) Listen(pipelines []*jobs.Pipeline, pool chan jobs.Handler, err jobs.ErrorHandler) error
  • func (b *Broker) Push(p *jobs.Pipeline, j *jobs.Job) (string, error)
  • func (b *Broker) Serve() error
  • func (b *Broker) Stop()
• type Config
  • func (c *Config) Conn() (*beanstalk.Conn, error)
  • func (c *Config) Hydrate(cfg service.Config) error
• type Tube
  • func NewTube(p *jobs.Pipeline) (*Tube, error)

Types

type Broker

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

Broker run jobs using Broker service.

func (*Broker) Init

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

Init configures local job broker.

func (*Broker) Listen

func (b *Broker) Listen(pipelines []*jobs.Pipeline, pool chan jobs.Handler, err jobs.ErrorHandler) error

Listen configures broker with list of tubes to listen and handler function. Local broker groups all tubes together.

func (*Broker) Push

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

Push new job to queue

func (*Broker) Serve

func (b *Broker) Serve() error

Serve tubes.

func (*Broker) Stop

func (b *Broker) Stop()

Stop serving.

type Config

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

	// Reserve timeout in seconds.
	Reserve int
}

Config defines beanstalk broker configuration.

func (*Config) Conn

func (c *Config) Conn() (*beanstalk.Conn, error)

Conn creates new rpc socket Listener.

func (*Config) Hydrate

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

Hydrate config values.

type Tube

type Tube struct {
	*beanstalk.Tube

	// Indicates that tube must be listened.
	Listen bool
}

Tube connects with singular queue channel in beanstalk.

func NewTube

func NewTube(p *jobs.Pipeline) (*Tube, error)

NewTube creates new tube or returns an error