🍦 Rego

Rego 是一个简单的资源池库，用于复用一些特定的资源，比如说网络连接。

Read me in English

🍭 功能特性

• 简单复用资源，支持令牌机制去限制数量
• 支持错误处理回调，用于自定义业务方的特定错误
• 支持查询资源池的运行指标，比如活跃和空闲的资源数量
• 回调函数支持 context 的透传、超时控制

历史版本的特性请查看 HISTORY.md。未来版本的新特性和计划请查看 FUTURE.md。

💡 使用方式

$ go get -u github.com/FishGoddess/rego

package main

import (
	"context"
	"fmt"
	"net"

	"github.com/FishGoddess/rego"
)

// acquireConn acquires a new conn, and returns an error if failed.
func acquireConn(ctx context.Context) (net.Conn, error) {
	// Guess this ip is from which websites?
	var dialer net.Dialer
	return dialer.DialContext(ctx, "tcp", "20.205.243.166:80")
}

// releaseConn releases the given conn, and returns an error if failed.
func releaseConn(ctx context.Context, conn net.Conn) error {
	return conn.Close()
}

func main() {
	// Create a resource pool which type is net.Conn and limit is 64.
	ctx := context.Background()

	pool := rego.New(64, acquireConn, releaseConn)
	defer pool.Close(ctx)

	// Take a resource from pool.
	conn, err := pool.Take(ctx)
	if err != nil {
		panic(err)
	}

	// Remember put the client to pool when your using is done.
	// This is why we call the resource in pool is reusable.
	// We recommend you to do this job in a defer function.
	defer pool.Put(ctx, conn)

	// Use the conn
	fmt.Println(conn.RemoteAddr())
}

🚄 性能测试

$ make bench

goos: linux
goarch: amd64
cpu: AMD EPYC 7K62 48-Core Processor

BenchmarkPool-2          4038403               306.0 ns/op             0 B/op          0 allocs/op

测试文件：_examples/performance_test.go

👥 贡献者

如果您觉得 rego 缺少您需要的功能，请不要犹豫，马上参与进来，发起一个 issue。