README
¶
contextflight
contextflight is a thin wrapper around singleflight that adds
context handling.
It works like singleflight, with the addition that the provided function receives a context.Context, which will
be cancelled when all waiting callers' contexts are cancelled.
This allows for correctly cancelling an expensive operation inside of singleflight only when all requesters have canceled their requests.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Group ¶
type Group 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) Do ¶
func (g *Group) Do(ctx context.Context, key string, fn func(context.Context) (interface{}, error)) (v interface{}, err error, shared bool)
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 return value shared indicates whether v was given to multiple callers. The context passed to the given function will be cancelled iff all callers' contexts are cancelled.
type Result ¶
type Result singleflight.Result
Result holds the results of Do, so they can be passed on a channel.
Source Files