Add documentation for FileLocker
This commit is contained in:
parent
b4c0df187e
commit
14285e971d
|
@ -8,6 +8,13 @@ import (
|
||||||
"github.com/tus/tusd"
|
"github.com/tus/tusd"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// FileLocker provides an exclusive upload locking mechansim using lock files
|
||||||
|
// which are stored on disk. Each of them stores the PID of the process which
|
||||||
|
// aquired the lock. This allows locks to be automatically freed when a process
|
||||||
|
// is unable to release it on its own because the process is not alive anymore.
|
||||||
|
//
|
||||||
|
// Please consult the package lockingstore for instructions on how to use this
|
||||||
|
// locker.
|
||||||
type FileLocker struct {
|
type FileLocker struct {
|
||||||
// Relative or absolute path to store the locks in.
|
// Relative or absolute path to store the locks in.
|
||||||
Path string
|
Path string
|
||||||
|
|
Loading…
Reference in New Issue