Go to file

Kyle Vigen f22d6d7e8d Ability to exit work loop gracefully This change adds the ability to call Shutdown on a gearman-go worker which causes the worker to wait for all currently active jobs to finish and then close the connection. It does this by keeping tracking of the number of currently active transactions, disallowing new job creation, and using a WaitGroup to wait for all active jobs to finish.		2016-04-26 17:35:44 -07:00
client	Allow built in selectionHandlers to be reused outside of package	2015-12-11 13:48:02 -08:00
example	fixed signal method	2015-01-16 17:41:19 +08:00
worker	Ability to exit work loop gracefully	2016-04-26 17:35:44 -07:00
.gitignore	Initial commit	2012-12-20 18:51:15 -08:00
.travis.yml	upgrade travis to Go 1.4	2015-01-10 00:09:38 +08:00
gearman.go	a better doc	2013-12-25 18:11:01 +08:00
LICENSE	Added the client	2011-05-19 20:10:53 +08:00
README.md	80 chars/line	2015-01-20 10:28:36 +08:00

README.md

Gearman-Go

This module is a Gearman API for the Go Programming Language. The protocols were written in pure Go. It contains two sub-packages:

The client package is used for sending jobs to the Gearman job server, and getting responses from the server.

"github.com/mikespook/gearman-go/client"

The worker package will help developers in developing Gearman worker service easily.

"github.com/mikespook/gearman-go/worker"

Install

Install the client package:

$ go get github.com/mikespook/gearman-go/client

Install the worker package:

$ go get github.com/mikespook/gearman-go/worker

Both of them:

$ go get github.com/mikespook/gearman-go

Usage

Worker

// Limit number of concurrent jobs execution. 
// Use worker.Unlimited (0) if you want no limitation.
w := worker.New(worker.OneByOne)
w.ErrHandler = func(e error) {
	log.Println(e)
}
w.AddServer("127.0.0.1:4730")
// Use worker.Unlimited (0) if you want no timeout
w.AddFunc("ToUpper", ToUpper, worker.Unlimited)
// This will give a timeout of 5 seconds
w.AddFunc("ToUpperTimeOut5", ToUpper, 5)

if err := w.Ready(); err != nil {
	log.Fatal(err)
	return
}
go w.Work()

Client

// ...
c, err := client.New("tcp4", "127.0.0.1:4730")
// ... error handling
defer c.Close()
c.ErrorHandler = func(e error) {
	log.Println(e)
}
echo := []byte("Hello\x00 world")
echomsg, err := c.Echo(echo)
// ... error handling
log.Println(string(echomsg))
jobHandler := func(resp *client.Response) {
	log.Printf("%s", resp.Data)
}
handle, err := c.Do("ToUpper", echo, client.JobNormal, jobHandler)
// ...

Branches

Version 0.x means: It is far far away from stable.

Use at your own risk!

master current usable version
0.2-dev Refactoring a lot of things
0.1-testing Old API and some known issues, eg. issue-14

Contributors

Great thanks to all of you for your support and interest!

(Alphabetic order)

Maintainer

Xing Xing <mikespook@gmail.com> @Twitter

Open Source - MIT Software License

See LICENSE.