README
¶
Singleflight
Package singleflight provides a duplicate function call suppression mechanism similar to golang.org/x/sync/singleflight but with support for context cancelation.
Installation
Run go get resenje.org/singleflight from command line.
Documentation
¶
Overview ¶
Package singleflight provides a duplicate function call suppression mechanism similar to golang.org/x/sync/singleflight with support for context cancellation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Group ¶
type Group[K comparable, V any] struct { // contains filtered or unexported fields }
Group represents a class of work and forms a namespace in which units of work can be executed with duplicate suppression.
func (*Group[K, V]) Do ¶
func (g *Group[K, V]) Do(ctx context.Context, key K, fn func(ctx context.Context) (V, error)) (v V, shared bool, err error)
Do executes and returns the results of the given function, making sure that only one execution is in-flight for a given key at a time. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results.
The context passed to the fn function is a context that preserves all values from the passed context but is cancelled by the singleflight only when all awaiting caller's contexts are cancelled (no caller is awaiting the result). If there are multiple callers, context passed to one caller does not affect the execution and returned values of others except if the function result is dependent on the context values.
The return value shared indicates whether v was given to multiple callers.
Source Files