promoted the README
This commit is contained in:
parent
43745ebe69
commit
0d6d1e114f
55
README.md
55
README.md
@ -1,23 +1,24 @@
|
|||||||
# Gearman API for golang
|
# Gearman API for golang
|
||||||
|
|
||||||
This module is Gearman API for golang. It was implemented a native
|
This package is a [Gearman](http://gearman.org/) API for [Golang](http://golang.org).
|
||||||
protocol for both worker and client API.
|
It was implemented a native protocol for both worker and client API.
|
||||||
|
|
||||||
Copyright 2012 Xing Xing <mikespook@gmail.com> All rights reserved.
|
Copyright 2012 Xing Xing <mikespook@gmail.com>
|
||||||
|
All rights reserved.
|
||||||
Use of this source code is governed by a MIT license that can be found
|
Use of this source code is governed by a MIT license that can be found
|
||||||
in the LICENSE file.
|
in the LICENSE file.
|
||||||
|
|
||||||
# INSTALL
|
# INSTALL
|
||||||
|
|
||||||
This will install the client:
|
Install the client package:
|
||||||
|
|
||||||
> $ go get bitbucket.org/mikespook/gearman-go/client
|
> $ go get bitbucket.org/mikespook/gearman-go/client
|
||||||
|
|
||||||
This will install the worker:
|
Install the worker package:
|
||||||
|
|
||||||
> $ go get bitbucket.org/mikespook/gearman-go/worker
|
> $ go get bitbucket.org/mikespook/gearman-go/worker
|
||||||
|
|
||||||
This will install the client and the worker automatically:
|
Install both:
|
||||||
|
|
||||||
> $ go get bitbucket.org/mikespook/gearman-go
|
> $ go get bitbucket.org/mikespook/gearman-go
|
||||||
|
|
||||||
@ -26,35 +27,43 @@ This will install the client and the worker automatically:
|
|||||||
|
|
||||||
## Worker
|
## Worker
|
||||||
|
|
||||||
> $ cd example
|
w := worker.New(worker.Unlimited)
|
||||||
>
|
w.ErrHandler = func(e error) {
|
||||||
> $ go build worker
|
log.Println(e)
|
||||||
>
|
}
|
||||||
> $ ./worker
|
w.AddServer("127.0.0.1:4730")
|
||||||
|
w.AddFunc("ToUpper", ToUpper, 0)
|
||||||
|
w.AddFunc("ToUpperTimeOut5", ToUpper, 5)
|
||||||
|
w.Work()
|
||||||
|
|
||||||
## Client
|
## Client
|
||||||
|
|
||||||
> $ cd example
|
c, err := client.New("127.0.0.1:4730")
|
||||||
>
|
// ...
|
||||||
> $ go build client
|
defer c.Close()
|
||||||
>
|
echo := []byte("Hello\x00 world")
|
||||||
> $ ./client
|
c.JobHandler = func(job *client.Job) error {
|
||||||
|
log.Printf("%s", job.Data)
|
||||||
# Code format
|
return nil
|
||||||
|
}
|
||||||
> $ gofmt -spaces=true -tabwidth=4 -w=true -tabindent=false $(DIR)
|
c.ErrHandler = func(e error) {
|
||||||
|
log.Println(e)
|
||||||
|
panic(e)
|
||||||
|
}
|
||||||
|
handle, err := c.Do("ToUpper", echo, client.JOB_NORMAL)
|
||||||
|
// ...
|
||||||
|
|
||||||
# Contacts
|
# Contacts
|
||||||
|
|
||||||
Xing Xing <mikespook@gmail.com>
|
Xing Xing <mikespook@gmail.com>
|
||||||
|
|
||||||
http://mikespook.com
|
[Blog](http://mikespook.com)
|
||||||
|
|
||||||
http://twitter.com/mikespook
|
[@Twitter](http://twitter.com/mikespook)
|
||||||
|
|
||||||
# History
|
# History
|
||||||
|
|
||||||
* 0.1 Refactoring code, redesign the API.
|
* 0.1 Code refactoring; Redesign the API.
|
||||||
* 0.0.1 Initial implementation, ugly code-style, slow profermance and unstable API.
|
* 0.0.1 Initial implementation, ugly code-style, slow profermance and unstable API.
|
||||||
|
|
||||||
# TODO
|
# TODO
|
||||||
|
Loading…
Reference in New Issue
Block a user