goroutine

Documentation

Index

• Variables
• func Delegate(c context.Context, t time.Duration, f func(ctx context.Context) error) error
• func SetCheckTime(d time.Duration) options.Option
• func SetIdle(idle int64) options.Option
• func SetLogger(logger log.Logger) options.Option
• func SetMax(max int64) options.Option
• func SetStopTimeout(d time.Duration) options.Option
• type GGroup
  • func NewGoroutine(ctx context.Context, opts ...options.Option) GGroup
• type Goroutine
  • func (g *Goroutine) AddTask(f func()) bool
  • func (g *Goroutine) AddTaskN(ctx context.Context, f func()) bool
  • func (g *Goroutine) ChangeMax(m int64)
  • func (g *Goroutine) Shutdown() error
  • func (g *Goroutine) Trick() string

Examples

• Goroutine.AddTask
• Goroutine.AddTaskN
• Goroutine.ChangeMax
• Goroutine.Shutdown
• NewGoroutine

Variables

var ErrRepeatClose = errors.New("goroutine/goroutine :重复关闭")

Functions

func Delegate

func Delegate(c context.Context, t time.Duration, f func(ctx context.Context) error) error

Delegate 委托执行 一般用于回收函数超时控制

func SetCheckTime

func SetCheckTime(d time.Duration) options.Option

SetCheckTime 设置检查时间

func SetIdle

func SetIdle(idle int64) options.Option

SetIdle 这是pool闲置goroutine数量

func SetLogger

func SetLogger(logger log.Logger) options.Option

SetLogger 设置日志对象

func SetMax

func SetMax(max int64) options.Option

SetMax 设置pool最大容量

func SetStopTimeout

func SetStopTimeout(d time.Duration) options.Option

SetStopTimeout 设置停止超时时间

Types

type GGroup

type GGroup interface {
	// ChangeMax 更改buffer大小
	ChangeMax(m int64)

	// AddTask 添加需要 `go function`
	AddTask(f func()) bool

	// AddTaskN 异步添加任务,有超时机制
	AddTaskN(ctx context.Context, f func()) bool

	// Shutdown 回收资源
	Shutdown() error

	// Trick debug
	Trick() string
}

func NewGoroutine

func NewGoroutine(ctx context.Context, opts ...options.Option) GGroup

NewGoroutine 实例化方法

Example

// 默认配置
// gGroup = NewGoroutine(context.TODO())

// 可供选择配置选项

// 设置停止超时时间
// SetStopTimeout(time.Second)

// 设置日志对象
// SetLogger(&testLogger{})

// 设置pool最大容量
// SetMax(100)

gGroup = NewGoroutine(context.TODO(),
	SetStopTimeout(time.Second),
	SetLogger(log.DefaultLogger),
	SetMax(100),
)

type Goroutine

type Goroutine struct {
	// contains filtered or unexported fields
}

func (*Goroutine) AddTask

func (g *Goroutine) AddTask(f func()) bool

AddTask 添加任务 直到添加成功为止

Example

if !gGroup.AddTask(mockFunc()) {
	// 添加任务失败
}

func (*Goroutine) AddTaskN

func (g *Goroutine) AddTaskN(ctx context.Context, f func()) bool

AddTaskN 添加任务 有超时时间

Example

// 带有超时控制添加任务
if !gGroup.AddTaskN(context.TODO(), mockFunc()) {
	// 添加任务失败
}

func (*Goroutine) ChangeMax

func (g *Goroutine) ChangeMax(m int64)

ChangeMax 修改pool上限值

Example

// 修改 pool最大容量
gGroup.ChangeMax(1000)

func (*Goroutine) Shutdown

func (g *Goroutine) Shutdown() error

Shutdown 优雅关闭 符合幂等性

Example

// 回收资源
_ = gGroup.Shutdown()

func (*Goroutine) Trick

func (g *Goroutine) Trick() string

Trick Debug使用