idempotency

Documentation

Overview

Package idempotency provides a duplicate function call suppression mechanism. It is a lightly modified version of groupcache's singleflight package that does not forget keys until explicitly told to.

Index

• type Group
  • func (g *Group) Forget(key string)
  • func (g *Group) Once(key string, fn func() (interface{}, error)) (interface{}, error)

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) Forget

func (g *Group) Forget(key string)

Forget forgets a key, allowing the next call for the key to execute the function.

func (*Group) Once

func (g *Group) Once(key string, fn func() (interface{}, error)) (interface{}, error)

Once executes and returns the results of the given function, making sure that only one execution for a given key happens until the key is explicitly forgotten. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results.