locker

Documentation

Index

• Constants
• func New(lockerConfig config.Locker) error
• type Interface
  • func Handler() Interface

Constants

const (

	// lock acquire timeout
	// DefaultTimeout lock acquire timeout
	DefaultTimeout = time.Millisecond * 100
)

Functions

func New

func New(lockerConfig config.Locker) error

New creates a locker handler from the provided config.Locker and save it in handler for further use

Types

type Interface

type Interface interface {
	Close() error
	Lock(doc object.Interface) (func() error, error)
	TryLock(doc object.Interface, t time.Duration) (func() error, error)
}

Interface is the base functionality that any locker handler should implement in order to become valid handler

func Handler

func Handler() Interface

Handler returns the registered locker handler