README
¶
Beanstalk
Go client for beanstalkd.
Install
$ go get github.com/beanstalkd/go-beanstalk
Use
Produce jobs:
c, err := beanstalk.Dial("tcp", "127.0.0.1:11300")
id, err := c.Put([]byte("hello"), 1, 0, 120*time.Second)
Consume jobs:
c, err := beanstalk.Dial("tcp", "127.0.0.1:11300")
id, body, err := c.Reserve(5 * time.Second)
Documentation
¶
Overview ¶
Package beanstalk provides a client for the beanstalk protocol. See http://kr.github.com/beanstalkd/ for the server.
This package is synchronized internally and safe to use from multiple goroutines without other coordination.
Example (Put) ¶
id, err := conn.Put([]byte("myjob"), 1, 0, time.Minute)
if err != nil {
panic(err)
}
fmt.Println("job", id)
Output:
Example (PutOtherTube) ¶
tube := &beanstalk.Tube{Conn: conn, Name: "mytube"}
id, err := tube.Put([]byte("myjob"), 1, 0, time.Minute)
if err != nil {
panic(err)
}
fmt.Println("job", id)
Output:
Example (Reserve) ¶
id, body, err := conn.Reserve(5 * time.Second)
if err != nil {
panic(err)
}
fmt.Println("job", id)
fmt.Println(string(body))
Output:
Example (ReserveOtherTubeSet) ¶
tubeSet := beanstalk.NewTubeSet(conn, "mytube1", "mytube2")
id, body, err := tubeSet.Reserve(10 * time.Hour)
if err != nil {
panic(err)
}
fmt.Println("job", id)
fmt.Println(string(body))
Output:
Index ¶
- Constants
- Variables
- type Conn
- func (c *Conn) Bury(id uint64, pri uint32) error
- func (c *Conn) Close() error
- func (c *Conn) Delete(id uint64) error
- func (c *Conn) KickJob(id uint64) error
- func (c *Conn) ListTubes() ([]string, error)
- func (c *Conn) Peek(id uint64) (body []byte, err error)
- func (c *Conn) Release(id uint64, pri uint32, delay time.Duration) error
- func (c *Conn) Stats() (map[string]string, error)
- func (c *Conn) StatsJob(id uint64) (map[string]string, error)
- func (c *Conn) Touch(id uint64) error
- type ConnError
- type NameError
- type Tube
- func (t *Tube) Kick(bound int) (n int, err error)
- func (t *Tube) Pause(d time.Duration) error
- func (t *Tube) PeekBuried() (id uint64, body []byte, err error)
- func (t *Tube) PeekDelayed() (id uint64, body []byte, err error)
- func (t *Tube) PeekReady() (id uint64, body []byte, err error)
- func (t *Tube) Put(body []byte, pri uint32, delay, ttr time.Duration) (id uint64, err error)
- func (t *Tube) Stats() (map[string]string, error)
- type TubeSet
Examples ¶
Constants ¶
const DefaultDialTimeout = 10 * time.Second
DefaultDialTimeout is the time to wait for a connection to the beanstalk server.
const DefaultKeepAlivePeriod = 10 * time.Second
DefaultKeepAlivePeriod is the default period between TCP keepalive messages.
const NameChars = `\-+/;.$_()0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz`
Characters allowed in a name in the beanstalkd protocol.
Variables ¶
var ( ErrBadFormat = errors.New("bad command format") ErrBuried = errors.New("buried") ErrDeadline = errors.New("deadline soon") ErrDraining = errors.New("draining") ErrInternal = errors.New("internal error") ErrJobTooBig = errors.New("job too big") ErrNoCRLF = errors.New("expected CR LF") ErrNotFound = errors.New("not found") ErrNotIgnored = errors.New("not ignored") ErrOOM = errors.New("server is out of memory") ErrTimeout = errors.New("timeout") ErrUnknown = errors.New("unknown command") )
Error messages returned by the server.
var ( ErrEmpty = errors.New("name is empty") ErrBadChar = errors.New("name has bad char") // contains a character not in NameChars ErrTooLong = errors.New("name is too long") )
Name format errors. The Err field of NameError contains one of these.
Functions ¶
This section is empty.
Types ¶
type Conn ¶
A Conn represents a connection to a beanstalkd server. It consists of a default Tube and TubeSet as well as the underlying network connection. The embedded types carry methods with them; see the documentation of those types for details.
func Dial ¶
Dial connects addr on the given network using net.DialTimeout with a default timeout of 10s and then returns a new Conn for the connection.
func DialTimeout ¶
DialTimeout connects addr on the given network using net.DialTimeout with a supplied timeout and then returns a new Conn for the connection.
func NewConn ¶
func NewConn(conn io.ReadWriteCloser) *Conn
NewConn returns a new Conn using conn for I/O.
func (*Conn) Bury ¶
Bury places the given job in a holding area in the job's tube and sets its priority to pri. The job will not be scheduled again until it has been kicked; see also the documentation of Kick.
func (*Conn) KickJob ¶
KickJob places the given job to the ready queue of the same tube where it currently belongs when the given job id exists and is in a buried or delayed state.
func (*Conn) ListTubes ¶
ListTubes returns the names of the tubes that currently exist on the server.
func (*Conn) Release ¶
Release tells the server to perform the following actions: set the priority of the given job to pri, remove it from the list of jobs reserved by c, wait delay seconds, then place the job in the ready queue, which makes it available for reservation by any client.
type ConnError ¶
ConnError records an error message from the server and the operation and connection that caused it.
type NameError ¶
NameError indicates that a name was malformed and the specific error describing how.
type Tube ¶
Tube represents tube Name on the server connected to by Conn. It has methods for commands that operate on a single tube.
func (*Tube) Kick ¶
Kick takes up to bound jobs from the holding area and moves them into the ready queue, then returns the number of jobs moved. Jobs will be taken in the order in which they were last buried.
func (*Tube) PeekBuried ¶
PeekBuried gets a copy of the job in the holding area that would be kicked next by Kick.
func (*Tube) PeekDelayed ¶
PeekDelayed gets a copy of the delayed job that is next to be put in t's ready queue.
type TubeSet ¶
TubeSet represents a set of tubes on the server connected to by Conn. Name names the tubes represented.
func NewTubeSet ¶
NewTubeSet returns a new TubeSet representing the given names.
Source Files