idempotent

README

Idempotent

Go idempotent library

GORM Drive

db := NewDB("root:@tcp(localhost:3306)/test?parseTime=true&loc=Asia%2FShanghai&charset=utf8mb4")
i, err := idempotent.New(drive_gorm.New(db))
if err != nil {
    panic(err)
}
_ = db.Transaction(func(tx *gorm.DB) error {
    ok := i.Acquire("idempotent_key", drive_gorm.New(tx), idempotent.WithTTL(time.Minute))
    if !ok {
        fmt.Println("Repeated")
        return nil
    }
    // Some of your code
    fmt.Println("Hello")
    return nil
})

Documentation

Index

• type Config
  • func DefaultConfig() *Config
• type ConfigOpt
  • func WithClearExpiry(duration time.Duration) ConfigOpt
  • func WithTTL(ttl time.Duration) ConfigOpt
• type Idempotent
  • func New(d drive.Drive, opts ...ConfigOpt) (*Idempotent, error)
  • func (i *Idempotent) Acquire(key string, engine drive.Drive, opts ...ConfigOpt) bool

Types

type Config

type Config struct {
	// key过期时间
	TTL time.Duration
	//清除过期间隔
	ClearExpiryDuration time.Duration
}

func DefaultConfig

func DefaultConfig() *Config

type ConfigOpt

type ConfigOpt func(op *Config)

func WithClearExpiry

func WithClearExpiry(duration time.Duration) ConfigOpt

WithClearExpiry

func WithTTL

func WithTTL(ttl time.Duration) ConfigOpt

WithTTL

type Idempotent

type Idempotent struct {
	// contains filtered or unexported fields
}

func New

func New(d drive.Drive, opts ...ConfigOpt) (*Idempotent, error)

func (*Idempotent) Acquire

func (i *Idempotent) Acquire(key string, engine drive.Drive, opts ...ConfigOpt) bool