Gearman-Go 项目技术文档

1. 安装指南

安装客户端包

通过以下命令安装 Gearman-Go 的客户端包：

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

安装工作端包

通过以下命令安装 Gearman-Go 的工作端包：

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

安装完整包

若需要同时安装客户端和工作端包，可以使用以下命令：

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

2. 项目使用说明

本项目包含两个子包：client 和 worker。

工作端（Worker）使用说明

工作端用于Gearman工作服务的开发。以下是一个简单的使用示例：

// 创建一个新的工作者实例，限制并发执行任务的数量。
// 如果不希望有任何限制，可以使用 worker.Unlimited (0)。
w := worker.New(worker.OneByOne)

// 设置错误处理函数。
w.ErrHandler = func(e error) {
    log.Println(e)
}

// 添加Gearman服务器地址。
w.AddServer("127.0.0.1:4730")

// 添加一个名为 "ToUpper" 的函数，不设超时限制。
w.AddFunc("ToUpper", ToUpper, worker.Unlimited)

// 添加一个名为 "ToUpperTimeOut5" 的函数，设置5秒超时。
w.AddFunc("ToUpperTimeOut5", ToUpper, 5)

// 准备工作，检查是否有错误。
if err := w.Ready(); err != nil {
    log.Fatal(err)
    return
}

// 在一个新的goroutine中启动工作。
go w.Work()

客户端（Client）使用说明

客户端用于向Gearman作业服务器发送任务，并接收响应。以下是一个简单的使用示例：

// ...
c, err := client.New("tcp4", "127.0.0.1:4730")
// 错误处理
defer c.Close()

// 设置错误处理函数。
c.ErrorHandler = func(e error) {
    log.Println(e)
}

// 发送一个回声测试。
echo := []byte("Hello\x00 world")
echomsg, err := c.Echo(echo)
// 错误处理
log.Println(string(echomsg))

// 定义一个处理函数，用于处理任务响应。
jobHandler := func(resp *client.Response) {
    log.Printf("%s", resp.Data)
}

// 发送一个名为 "ToUpper" 的任务。
handle, err := c.Do("ToUpper", echo, client.JobNormal, jobHandler)
// ...

3. 项目API使用文档

本项目API使用纯Go语言编写，具体使用方法请参考Go语言的标准文档格式。以下是一个简单的API使用示例：

• 客户端（Client）API：

  • New(network, address string) (*Client, error)：创建一个新的客户端实例。
  • Echo(data []byte) ([]byte, error)：发送回声测试请求。
  • Do(functionName string, data []byte, jobType JobType, handler JobHandler) (*JobHandle, error)：发送一个任务。

• 工作端（Worker）API：

  • New(concurrency int) *Worker：创建一个新的工作端实例。
  • AddServer(server string)：添加一个Gearman服务器地址。
  • AddFunc(functionName string, handler JobHandler, timeout int)：添加一个任务处理函数。

4. 项目安装方式

Gearman-Go 的安装方式已在“安装指南”部分详细说明，此处不再重复。简要概括，您可以使用 go get 命令来安装客户端、工作端或完整的包。