locking

Documentation

Overview

Package locking provides functions for acquiring and releasing MySQL advisory locks.

Index

• func Acquire(tx *gorm.DB, lockKey string, opts ...Option) (release func() error, err error)
• type Option
  • func WithRetry(opts *backoff.Options) Option
• type Options

Functions

func Acquire

func Acquire(tx *gorm.DB, lockKey string, opts ...Option) (release func() error, err error)

Acquire acquires a MySQL advisory lock. Returns a release function and an error.

It's the responsibility of the caller to release the lock by calling the release function.

Types

type Option

type Option func(*Options)

Option is a function that applies an option to an Options instance.

func WithRetry

func WithRetry(opts *backoff.Options) Option

WithRetry sets the retry options.

type Options

type Options struct {
	Retry *backoff.Options
}

Options represents the locking options.