beanstalkg

README

Beanstalkg

Beanstalkg is a go implementation of Beanstalkd a fast, general-purpose work queue. Idea is to support the same set of features and protocol with the addition of high availability and failover built in. You can read the plan.md if interested in contributing.

Right now it supports all the basic commands to run producers and workers. i.e "use", "put", "watch", "ignore", "reserve", "delete", "release", "bury", "reserve-with-timeout".

I wish to complete rest of the commands soon but any help is always appreciated.

Advantages compared to beanstalkd

• Extensible design. For example you can replace the backend storage with anything you like, just implement a simple interface and plugin.
• Implemented in golang. More readable code with support for concurrency using awesome go routines.
• Support for clustering(coming soon :)

User guide

Beanstalkg is currently only released as a docker image for users. Latest release is v0.0.3. Assuming you already have a working docker engine installation, you can start a Beanstalkg instance with following steps,

• Run command docker run -p 11300:11300 beanstalkg/beanstalkg:v0.0.3. This will start the beanstalkg server in the foreground. The server starts listening on port 11300.
• Now you can connect to the server with any client library available to beanstalkd. eg: Using official go client

  // 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)
  
  

Developer guide

Please install golang and then clone this repo and from the root run,

• go install
• go run main.go

Licensing

beanstalkg is licensed under the MIT License. See LICENSE for the full license text.