Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add an explicit Close function #21

Merged
merged 1 commit into from Sep 15, 2018
Merged

Add an explicit Close function #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions flock.go
View file
Open in desktop
Expand Up @@ -39,6 +39,14 @@ func NewFlock(path string) *Flock {
return &Flock{path: path}
}

// Close is equivalent to calling Unlock.
//
// This will release the lock and close the underlying file descriptor.
// It will not remove the file from disk, that's up to your application.
func (f *Flock) Close() error {
return f.Unlock()
}

// Path is a function to return the path as provided in NewFlock().
func (f *Flock) Path() string {
return f.path
Expand Down