consul

Documentation

Index

• Variables
• type Lock
  • func NewLock(key string) (*Lock, error)
  • func NewLockWithTTL(key string, ttl time.Duration) (*Lock, error)
  • func (l *Lock) Acquire() error
  • func (l *Lock) GetState() map[string]interface{}
  • func (l *Lock) IsAcquirer() error
  • func (l *Lock) Release() error
  • func (l *Lock) SetState(state map[string]interface{})

Variables

var LockTTL = 10 * time.Second

LockTTL defines max time to live of a lock.

var WaitForLock = 5 * time.Second

WaitForLock defines the about of time to wait to acquire a lock

Types

type Lock

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

Lock provides lock functionalities based on consul sessions.It implements The Lock interface.

func NewLock

func NewLock(key string) (*Lock, error)

NewLock creates a consul lock instance

func NewLockWithTTL

func NewLockWithTTL(key string, ttl time.Duration) (*Lock, error)

NewLockWithTTL creates a consul lock instance

func (*Lock) Acquire

func (l *Lock) Acquire() error

Acquire acquires a lock. Returns error if it failed to acquire the lock. If the lock object has a session that is still tired to the locked key, nil is returned.

func (*Lock) GetState

func (l *Lock) GetState() map[string]interface{}

GetState returns the lock state

func (*Lock) IsAcquirer

func (l *Lock) IsAcquirer() error

IsAcquirer checks whether this lock instance is the acquirer of the lock on a specific key

func (*Lock) Release

func (l *Lock) Release() error

Release invalidates the lock previously acquired. Returns nil if when lock is not held

func (*Lock) SetState

func (l *Lock) SetState(state map[string]interface{})

SetState sets the lock state