-
Notifications
You must be signed in to change notification settings - Fork 196
/
lock.go
34 lines (30 loc) · 1.26 KB
/
lock.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// Copyright (c) 2021 - The Event Horizon 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.
package lock
import "errors"
var (
// ErrLockExists is returned from Lock() when the lock is already taken.
ErrLockExists = errors.New("lock exists")
// ErrNoLockExists is returned from Unlock() when the lock does not exist.
ErrNoLockExists = errors.New("no lock exists")
)
// Lock is a locker of IDs.
type Lock interface {
// Lock sets a lock for the ID. Returns ErrLockExists if the lock is already
// taken or another error if it was not possible to get the lock.
Lock(id string) error
// Unlock releases the lock for the ID. Returns ErrNoLockExists if there is
// no lock for the ID or another error if it was not possible to unlock.
Unlock(id string) error
}