You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.6 KiB
90 lines
2.6 KiB
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
// Package gmlock implements a concurrent-safe memory-based locker.
|
|
package gmlock
|
|
|
|
var (
|
|
// Default locker.
|
|
locker = New()
|
|
)
|
|
|
|
// Lock locks the `key` with writing lock.
|
|
// If there's a write/reading lock the `key`,
|
|
// it will blocks until the lock is released.
|
|
func Lock(key string) {
|
|
locker.Lock(key)
|
|
}
|
|
|
|
// TryLock tries locking the `key` with writing lock,
|
|
// it returns true if success, or if there's a write/reading lock the `key`,
|
|
// it returns false.
|
|
func TryLock(key string) bool {
|
|
return locker.TryLock(key)
|
|
}
|
|
|
|
// Unlock unlocks the writing lock of the `key`.
|
|
func Unlock(key string) {
|
|
locker.Unlock(key)
|
|
}
|
|
|
|
// RLock locks the `key` with reading lock.
|
|
// If there's a writing lock on `key`,
|
|
// it will blocks until the writing lock is released.
|
|
func RLock(key string) {
|
|
locker.RLock(key)
|
|
}
|
|
|
|
// TryRLock tries locking the `key` with reading lock.
|
|
// It returns true if success, or if there's a writing lock on `key`, it returns false.
|
|
func TryRLock(key string) bool {
|
|
return locker.TryRLock(key)
|
|
}
|
|
|
|
// RUnlock unlocks the reading lock of the `key`.
|
|
func RUnlock(key string) {
|
|
locker.RUnlock(key)
|
|
}
|
|
|
|
// LockFunc locks the `key` with writing lock and callback function `f`.
|
|
// If there's a write/reading lock the `key`,
|
|
// it will blocks until the lock is released.
|
|
//
|
|
// It releases the lock after `f` is executed.
|
|
func LockFunc(key string, f func()) {
|
|
locker.LockFunc(key, f)
|
|
}
|
|
|
|
// RLockFunc locks the `key` with reading lock and callback function `f`.
|
|
// If there's a writing lock the `key`,
|
|
// it will blocks until the lock is released.
|
|
//
|
|
// It releases the lock after `f` is executed.
|
|
func RLockFunc(key string, f func()) {
|
|
locker.RLockFunc(key, f)
|
|
}
|
|
|
|
// TryLockFunc locks the `key` with writing lock and callback function `f`.
|
|
// It returns true if success, or else if there's a write/reading lock the `key`, it return false.
|
|
//
|
|
// It releases the lock after `f` is executed.
|
|
func TryLockFunc(key string, f func()) bool {
|
|
return locker.TryLockFunc(key, f)
|
|
}
|
|
|
|
// TryRLockFunc locks the `key` with reading lock and callback function `f`.
|
|
// It returns true if success, or else if there's a writing lock the `key`, it returns false.
|
|
//
|
|
// It releases the lock after `f` is executed.
|
|
func TryRLockFunc(key string, f func()) bool {
|
|
return locker.TryRLockFunc(key, f)
|
|
}
|
|
|
|
// Remove removes mutex with given `key`.
|
|
func Remove(key string) {
|
|
locker.Remove(key)
|
|
}
|