sync

Documentation

Overview

Copyright 2023 The acquirecloud Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type LockProvider
• type Locker

Types

type LockProvider

type LockProvider interface {

	// NewLocker returns new Locker for the name provided. The locker
	// for the same name will try to work with the same locking resources
	NewLocker(name string) Locker
}

LockProvider interface allows to create new Locker objects. This interface can be useful for providing an alternative locking like Distributed Locks, but in general which will be similar to the sync.Lock

type Locker

type Locker interface {
	sync.Locker

	// TryLock tries to acquire the lock and return immediately whether the
	// attempt was successful or not
	TryLock(ctx context.Context) bool

	// LockWithCtx allows to lock Locker with a context. It will return nil if the locker is
	// locket successfully or ctx.Err() otherwise.
	LockWithCtx(ctx context.Context) error
}

Locker represents an object that supports sync.Locker and an extended functionality of locking mechanism in a distributed system