README
¶
Go Locks
A simple library that provides pools of locks for Go. It is useful when you need to lock on a resource that cannot carry its lock. Such as files, network connections, etc.
Install
go get github.com/DaanV2/go-locks
Usage
package main
import (
"fmt"
"github.com/DaanV2/go-locks"
)
func main() {
pool := locks.NewPool(100)
lock := pool.GetLock(uint64)
lock.Lock()
defer lock.Unlock()
// Do something with the resource
// For files:
key := locks.KeyForString("file.txt")
lock := pool.GetLock(key)
lock.Lock()
defer lock.Unlock()
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Pool is a pool of locks that can be used to lock based on a key.
func NewPool ¶
NewPool creates a new pool of locks, where amount is the number of locks to create. It returns an error if the amount is less than or equal to 0. The ideal amount of locks is dependent on the number of threads. With a factor that depends on the amount of collision you want per lock. Example:
threads := 7 // Collision of 25% per lock amount := threads * (100 / 25) // => 7 * 4 = 28
type RWPool ¶
type RWPool struct {
// contains filtered or unexported fields
}
func NewRWPool ¶
NewRWPool creates a new pool of locks, where amount is the number of locks to create. Instead of mutexes, it uses RWMutexes.
Source Files
Click to show internal directories.
Click to hide internal directories.