Clash.Meta/common/picker/picker.go

93 lines
2.1 KiB
Go
Raw Normal View History

2018-12-05 21:13:29 +08:00
package picker
2019-07-02 19:18:03 +08:00
import (
"context"
"sync"
"time"
2019-07-02 19:18:03 +08:00
)
// Picker provides synchronization, and Context cancelation
// for groups of goroutines working on subtasks of a common task.
// Inspired by errGroup
2022-04-24 02:07:57 +08:00
type Picker[T any] struct {
ctx context.Context
2019-07-02 19:18:03 +08:00
cancel func()
wg sync.WaitGroup
2020-04-16 18:31:40 +08:00
once sync.Once
errOnce sync.Once
2022-04-24 02:07:57 +08:00
result T
2020-04-16 18:31:40 +08:00
err error
}
2022-04-24 02:07:57 +08:00
func newPicker[T any](ctx context.Context, cancel func()) *Picker[T] {
return &Picker[T]{
ctx: ctx,
cancel: cancel,
}
2019-07-02 19:18:03 +08:00
}
// WithContext returns a new Picker and an associated Context derived from ctx.
// and cancel when first element return.
2022-04-24 02:07:57 +08:00
func WithContext[T any](ctx context.Context) (*Picker[T], context.Context) {
2019-07-02 19:18:03 +08:00
ctx, cancel := context.WithCancel(ctx)
2022-04-24 02:07:57 +08:00
return newPicker[T](ctx, cancel), ctx
2019-07-02 19:18:03 +08:00
}
// WithTimeout returns a new Picker and an associated Context derived from ctx with timeout.
2022-04-24 02:07:57 +08:00
func WithTimeout[T any](ctx context.Context, timeout time.Duration) (*Picker[T], context.Context) {
ctx, cancel := context.WithTimeout(ctx, timeout)
2022-04-24 02:07:57 +08:00
return newPicker[T](ctx, cancel), ctx
}
2019-07-02 19:18:03 +08:00
// Wait blocks until all function calls from the Go method have returned,
// then returns the first nil error result (if any) from them.
2022-04-24 02:07:57 +08:00
func (p *Picker[T]) Wait() T {
2019-07-02 19:18:03 +08:00
p.wg.Wait()
if p.cancel != nil {
p.cancel()
2023-07-14 09:55:43 +08:00
p.cancel = nil
2019-07-02 19:18:03 +08:00
}
return p.result
}
2020-04-16 18:31:40 +08:00
// Error return the first error (if all success return nil)
2022-04-24 02:07:57 +08:00
func (p *Picker[T]) Error() error {
2020-04-16 18:31:40 +08:00
return p.err
}
2019-07-02 19:18:03 +08:00
// Go calls the given function in a new goroutine.
// The first call to return a nil error cancels the group; its result will be returned by Wait.
2022-04-24 02:07:57 +08:00
func (p *Picker[T]) Go(f func() (T, error)) {
2019-07-02 19:18:03 +08:00
p.wg.Add(1)
2018-12-05 21:13:29 +08:00
go func() {
2019-07-02 19:18:03 +08:00
defer p.wg.Done()
2018-12-05 21:13:29 +08:00
2019-07-02 19:18:03 +08:00
if ret, err := f(); err == nil {
p.once.Do(func() {
p.result = ret
if p.cancel != nil {
p.cancel()
2023-07-14 09:55:43 +08:00
p.cancel = nil
2019-07-02 19:18:03 +08:00
}
})
2020-04-16 18:31:40 +08:00
} else {
p.errOnce.Do(func() {
p.err = err
})
2018-12-05 21:13:29 +08:00
}
}()
}
2023-07-14 09:55:43 +08:00
// Close cancels the picker context and releases resources associated with it.
// If Wait has been called, then there is no need to call Close.
func (p *Picker[T]) Close() error {
if p.cancel != nil {
p.cancel()
p.cancel = nil
}
return nil
}