client

Documentation

Overview

Package client defines the distrilock client interface and associated types.

Index

• type Client
• type Error
  • func (e *Error) Error() string
• type Lock
  • func (l *Lock) Release() error
  • func (l *Lock) String() string
  • func (l *Lock) Verify() error

Types

type Client

type Client interface {
	// Acquire will acquire a named lock through the distrilock daemon.
	Acquire(lockName string) (*Lock, error)
	// Release will release a locked name previously acquired in this session.
	Release(l *Lock) error
	// IsLocked returns true when distrilock deamon estabilished that lock is currently acquired.
	IsLocked(lockName string) (bool, error)
	// Verify will verify that the lock is currently held by the client and healthy.
	Verify(l *Lock) error
	// Close releases all session-specific resources of this client.
	Close() error
}

Client is a generic distrilock client interface.

type Error

type Error struct {
	Result api.LockCommandResult
	Reason string
}

Error is the composite error return by all client method calls.

func (*Error) Error

func (e *Error) Error() string

Error returns the associated summary of the ClientError e.

type Lock

type Lock struct {
	Client
	Name string
}

Lock is a client-specific acquired lock object.

func (*Lock) Release

func (l *Lock) Release() error

Release is a short-hand to call Client.Release for Lock l.

func (*Lock) String

func (l *Lock) String() string

String returns the lock name and the associated client.

func (*Lock) Verify

func (l *Lock) Verify() error

Verify is a short-hand to call Client.Verify for Lock l.