dmutex

Documentation

Index

• Constants
• Variables
• func EnsureMongoDBMutexIndex(c *mgo.Collection, uniqueField string, ttlField string, ...) error
• func NewMongoDBImpl(c *mgo.Collection, cfg *MutexMongoDBImplConfig) (*mutexMongoDBImpl, error)
• type Locker
• type MutexMongoDBImplConfig

Constants

const (
	DefaultUniqueField = "key"
	DefaultTTLField    = "created_at"
)

Variables

var (
	ErrMutexIndexNotExist = errors.New("unique index or ttl index not exists")
	ErrParamsIsNil        = errors.New("params cannot be nil")
	ErrDuplicateKey       = errors.New("duplicate key error")
	ErrNotFoundKey        = errors.New("key does not exist")
)

Functions

func EnsureMongoDBMutexIndex

func EnsureMongoDBMutexIndex(
	c *mgo.Collection,
	uniqueField string,
	ttlField string,
	expireAfter time.Duration,
) error

EnsureMongoDBMutexIndex Ensure the index required by mutex exists

func NewMongoDBImpl

func NewMongoDBImpl(c *mgo.Collection, cfg *MutexMongoDBImplConfig) (*mutexMongoDBImpl, error)

NewMongoDBImpl creates a new mutex, Implemented by mongodb.

Types

type Locker

type Locker interface {
	Lock(string) error
	Unlock(string) error
}

type MutexMongoDBImplConfig

type MutexMongoDBImplConfig struct {
	TTLField    string
	UniqueField string
}