Documentation
¶
Index ¶
- func SetupDefaultOptions(ctx context.Context, opts lockgate.AcquireOptions) lockgate.AcquireOptions
- type HostLocker
- func (hl *HostLocker) AcquireLock(ctx context.Context, lockName string, opts lockgate.AcquireOptions) (bool, lockgate.LockHandle, error)
- func (hl *HostLocker) Locker() lockgate.Locker
- func (hl *HostLocker) ReleaseLock(lock lockgate.LockHandle) error
- func (hl *HostLocker) WithLock(ctx context.Context, lockName string, opts lockgate.AcquireOptions, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SetupDefaultOptions ¶
func SetupDefaultOptions(ctx context.Context, opts lockgate.AcquireOptions) lockgate.AcquireOptions
Types ¶
type HostLocker ¶
type HostLocker struct {
// contains filtered or unexported fields
}
func NewHostLocker ¶
func NewHostLocker(locksDir string) (*HostLocker, error)
func (*HostLocker) AcquireLock ¶
func (hl *HostLocker) AcquireLock(ctx context.Context, lockName string, opts lockgate.AcquireOptions) (bool, lockgate.LockHandle, error)
func (*HostLocker) Locker ¶
func (hl *HostLocker) Locker() lockgate.Locker
func (*HostLocker) ReleaseLock ¶
func (hl *HostLocker) ReleaseLock(lock lockgate.LockHandle) error
func (*HostLocker) WithLock ¶
func (hl *HostLocker) WithLock(ctx context.Context, lockName string, opts lockgate.AcquireOptions, f func() error) error
WithLock acquires host lock and executes callback opts.NonBlocking=false. Be aware, if opts.NonBlocking=true it does "try lock", ignores lock's status and executes callback anyway.
Source Files
Click to show internal directories.
Click to hide internal directories.