dlock

Documentation

Overview

Package dlock provide distributed lock function

Index

• Variables
• func Init(opts Options) (err error)
• func Install(pluginImplName string, f initFunc)
• func IsHoldLock(key string) bool
• func Lock(key string, ttl int64) error
• func Renew(key string) error
• func TryLock(key string, ttl int64) error
• func Unlock(key string) error
• type DLock
  • func Instance() DLock
• type Options

Variables

var (
	ErrKindIsEmpty   = errors.New("dlock's kind is empty")
	ErrIsInitialized = errors.New("instance has been initialized")
)

var ErrDLockNotExists = errors.New("DLock do not exist")

Functions

func Init

func Init(opts Options) (err error)

func Install

func Install(pluginImplName string, f initFunc)

func IsHoldLock

func IsHoldLock(key string) bool

func Lock

func Lock(key string, ttl int64) error

func Renew

func Renew(key string) error

func TryLock

func TryLock(key string, ttl int64) error

func Unlock

func Unlock(key string) error

Types

type DLock

type DLock interface {
	Lock(key string, ttl int64) error
	TryLock(key string, ttl int64) error
	Renew(key string) error
	IsHoldLock(key string) bool
	Unlock(key string) error
}

func Instance

func Instance() DLock

type Options

type Options struct {
	Kind string
}

Options contains configuration for plugins