mutex

Documentation

Index

• Constants
• func GetEtcdClient(host string, timeout time.Duration, user string, pass string) (*clientv3.Client, error)
• func GetEtcdTLSClient(host string, tls *tls.Config, timeout time.Duration) (*clientv3.Client, error)
• func GetMutex(session *concurrency.Session, prefix string) *concurrency.Mutex
• func GetSession(client *clientv3.Client) (*concurrency.Session, error)
• type Lock
  • func (e *Lock) Close() error
  • func (e *Lock) Release() error
  • func (e *Lock) TryAcquire() error

Constants

const ProdMutexPrefix = "/gromit/prod/"

ProdMutexPrefix is the prefix for all the created mutex objects.

const TestMutexPrefix = "/gromit/test/"

TestMutexPrefix should only be used from within unit and integration tests.

Functions

func GetEtcdClient

func GetEtcdClient(host string, timeout time.Duration, user string, pass string) (*clientv3.Client, error)

GetEtcdClient creates an etcd client.

func GetEtcdTLSClient

func GetEtcdTLSClient(host string, tls *tls.Config, timeout time.Duration) (*clientv3.Client, error)

func GetMutex

func GetMutex(session *concurrency.Session, prefix string) *concurrency.Mutex

func GetSession

func GetSession(client *clientv3.Client) (*concurrency.Session, error)

Types

type Lock

type Lock struct {
	Client  *clientv3.Client
	Session *concurrency.Session
	Mutex   *concurrency.Mutex
}

func (*Lock) Close

func (e *Lock) Close() error

Close releases the client and session resources

func (*Lock) Release

func (e *Lock) Release() error

Release an existent lock

func (*Lock) TryAcquire

func (e *Lock) TryAcquire() error

Try to adquire a lock (non-blocking), if process is locked will log error and exit without locking