mysqllock

Documentation

Overview

Package mysqllock provides a distributed locking mechanism leveraging MySQL internal functions.

Index

• Variables
• type MySQLLock
  • func New(db *sql.DB) *MySQLLock
  • func (l *MySQLLock) Acquire(ctx context.Context, key string, timeout time.Duration) (ReleaseFunc, error)
• type ReleaseFunc

Variables

var (
	// ErrTimeout is an error when the lock is not acquired within the timeout.
	ErrTimeout = errors.New("acquire lock timeout")

	// ErrFailed is an error when the lock is not acquired.
	ErrFailed = errors.New("failed to acquire a lock")
)

Types

type MySQLLock

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

MySQLLock represents a locker.

func New

func New(db *sql.DB) *MySQLLock

New creates a new instance of the locker.

func (*MySQLLock) Acquire

func (l *MySQLLock) Acquire(ctx context.Context, key string, timeout time.Duration) (ReleaseFunc, error)

Acquire attempts to acquire a database lock.

type ReleaseFunc

type ReleaseFunc func() error

ReleaseFunc is an alias for a release lock function.