singleflight

package

v0.3.6 Latest Latest Go to latest Published: Aug 5, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Asutorufa/yuhaiin

Links

Open Source Insights

Documentation ¶

Overview ¶

Package singleflight provides a duplicate function call suppression mechanism.

Index ¶

type Group
type GroupNoblock
- func (g *GroupNoblock[K, V]) DoBackground(key K, f func(V), fn func() (V, bool))
type GroupSync
- func (g *GroupSync[K, V]) Do(key K, fn func() (V, error)) (v V, err error, shared bool)
type Result

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(key K, fn func() (V, error)) (v V, 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.

func (*Group[K, V]) DoChan ¶

func (g *Group[K, V]) DoChan(key K, fn func() (V, error)) <-chan Result[V]

DoChan is like Do but returns a channel that will receive the results when they are ready.

The returned channel will not be closed.

func (*Group[K, V]) Forget ¶

func (g *Group[K, V]) Forget(key K)

Forget tells the singleflight to forget about a key. Future calls to Do for this key will call the function rather than waiting for an earlier call to complete.

type GroupNoblock ¶ added in v0.3.6

type GroupNoblock[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 (*GroupNoblock[K, V]) DoBackground ¶ added in v0.3.6

func (g *GroupNoblock[K, V]) DoBackground(key K, f func(V), fn func() (V, bool))

DoBackground 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.

type GroupSync ¶ added in v0.3.6

type GroupSync[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 (*GroupSync[K, V]) Do ¶ added in v0.3.6

func (g *GroupSync[K, V]) Do(key K, fn func() (V, error)) (v V, 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.

type Result ¶

type Result[T any] struct {
	Val    T
	Err    error
	Shared bool
}

Result holds the results of Do, so they can be passed on a channel.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL