locker

package

v0.0.0-...-e282ec7 Latest Latest Go to latest Published: Mar 29, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/czhj/ahfs

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Lock(ctx context.Context, key string, opts ...Option) (string, error)
func SetDefaultLocker(l Locker)
func Unlock(ctx context.Context, key string, id string) error
type Locker
type OSLocker
type Option
- func WithExpiration(d time.Duration) Option
- func WithMaxAttempts(count int) Option
type Options

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrKeyLocked      = errors.New("key is locked")
	ErrLockerIsExpire = errors.New("locker is expire")
	ErrLockerNotFound = errors.New("locker does not exists")
	ErrMaxAttempts    = errors.New("maximum number of attempts reached")
)

Functions ¶

func Lock ¶

func Lock(ctx context.Context, key string, opts ...Option) (string, error)

func SetDefaultLocker ¶

func SetDefaultLocker(l Locker)

func Unlock ¶

func Unlock(ctx context.Context, key string, id string) error

Types ¶

type Locker ¶

type Locker interface {
	Init(config string) error
	Close() error

	Lock(ctx context.Context, key string, opts ...Option) (string, error)
	Unlock(ctx context.Context, key string, id string) error
}

type OSLocker ¶

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

func (*OSLocker) Close ¶

func (o *OSLocker) Close() error

func (*OSLocker) Init ¶

func (o *OSLocker) Init(config string) error

func (*OSLocker) Lock ¶

func (o *OSLocker) Lock(ctx context.Context, key string, opts ...Option) (string, error)

func (*OSLocker) Unlock ¶

func (o *OSLocker) Unlock(ctx context.Context, key string, id string) error

type Option ¶

type Option func(*Options)

func WithExpiration ¶

func WithExpiration(d time.Duration) Option

func WithMaxAttempts ¶

func WithMaxAttempts(count int) Option

type Options ¶

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

Source Files ¶

View all Source files

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