redislock

package module

v0.0.2 Latest Latest Go to latest Published: Sep 16, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/JingIsCoding/redis-lock

Links

Open Source Insights

README ¶

redis-lock

Documentation ¶

Index ¶

Constants
Variables
type Config
type Lock
- func (lock *Lock) Unlock() error
- func (lock *Lock) Wait() result
type LockManager
- func NewLockManager(redisAddr string, optionalOption ...Option) (LockManager, error)
type LogLevel
type Logger
- func New(writer Writer, config Config) Logger
type Option
type Writer

Constants ¶

View Source

const (
	Reset       = "\033[0m"
	Red         = "\033[31m"
	Green       = "\033[32m"
	Yellow      = "\033[33m"
	Blue        = "\033[34m"
	Magenta     = "\033[35m"
	Cyan        = "\033[36m"
	White       = "\033[37m"
	BlueBold    = "\033[34;1m"
	MagentaBold = "\033[35;1m"
	RedBold     = "\033[31;1m"
	YellowBold  = "\033[33;1m"
)

Colors

Variables ¶

View Source

var (
	// Discard logger will print any log to io.Discard
	Discard = New(log.New(io.Discard, "", log.LstdFlags), Config{})
	// Default Default logger
	Default = New(log.New(os.Stdout, "\r\n", log.LstdFlags), Config{
		SlowThreshold:             200 * time.Millisecond,
		LogLevel:                  Warn,
		IgnoreRecordNotFoundError: false,
		Colorful:                  true,
	})
)

View Source

var DefaultOption = Option{
	MaxIdle:      5,
	MaxActive:    100,
	MaxQueueSize: 10,
	IdleTimeout:  240 * time.Second,
	Logger:       Default,
}

View Source

var ErrRecordNotFound = errors.New("record not found")

ErrRecordNotFound record not found error

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	SlowThreshold             time.Duration
	Colorful                  bool
	IgnoreRecordNotFoundError bool
	ParameterizedQueries      bool
	LogLevel                  LogLevel
}

Config logger config

type Lock ¶

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

func (*Lock) Unlock ¶

func (lock *Lock) Unlock() error

func (*Lock) Wait ¶

func (lock *Lock) Wait() result

type LockManager ¶

type LockManager interface {
	Lock(context context.Context, key string, duration time.Duration) Lock
	Close() error
}

func NewLockManager ¶

func NewLockManager(redisAddr string, optionalOption ...Option) (LockManager, error)

type LogLevel ¶

type LogLevel int

LogLevel log level

const (
	// Silent silent log level
	Silent LogLevel = iota + 1
	// Error error log level
	Error
	// Warn warn log level
	Warn
	// Info info log level
	Info
)

type Logger ¶

type Logger interface {
	LogMode(LogLevel) Logger
	Info(string, ...interface{})
	Warn(string, ...interface{})
	Error(string, ...interface{})
}

Logger logger interface

func New ¶

func New(writer Writer, config Config) Logger

New initialize logger

type Option ¶

type Option struct {
	MaxIdle      int
	MaxActive    int
	MaxQueueSize int
	IdleTimeout  time.Duration
	Logger       Logger
}

type Writer ¶

type Writer interface {
	Printf(string, ...interface{})
}

Writer log writer interface

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL