lock

Documentation

Index

• Constants
• func RegisterLocker(name string, f NewFunc)
• type ILocker
• type NewFunc
  • func LoadLocker(name string) (NewFunc, bool)
• type SessionOption
  • func WithDisableKeepAlive() SessionOption
  • func WithErrorNotify() SessionOption
  • func WithTTL(ttl int64) SessionOption
  • func WithWaitTime(waitTime time.Duration) SessionOption
• type SessionOptions

Constants

const DefaultSessionTTL = 60

Functions

func RegisterLocker

func RegisterLocker(name string, f NewFunc)

Types

type ILocker

type ILocker interface {
	Lock(key string, opts ...SessionOption) error
	Unlock()
	ErrC() <-chan error
}

type NewFunc

type NewFunc func(configId string) ILocker

func LoadLocker

func LoadLocker(name string) (NewFunc, bool)

type SessionOption

type SessionOption func(*SessionOptions)

SessionOption configures Session.

func WithDisableKeepAlive

func WithDisableKeepAlive() SessionOption

func WithErrorNotify

func WithErrorNotify() SessionOption

func WithTTL

func WithTTL(ttl int64) SessionOption

If TTL is <= 0, the default 60 seconds TTL will be used.

func WithWaitTime

func WithWaitTime(waitTime time.Duration) SessionOption

type SessionOptions

type SessionOptions struct {
	TTL              int64
	DisableKeepAlive bool
	WaitTime         time.Duration
	ErrorNotify      bool
}