lock.go 958 B

123456789101112131415161718192021222324252627282930
  1. // Copyright 2016 CoreOS, Inc.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package fileutil
  15. type Lock interface {
  16. // Name returns the name of the file.
  17. Name() string
  18. // TryLock acquires exclusivity on the lock without blocking.
  19. TryLock() error
  20. // Lock acquires exclusivity on the lock.
  21. Lock() error
  22. // Unlock unlocks the lock.
  23. Unlock() error
  24. // Destroy should be called after Unlock to clean up
  25. // the resources.
  26. Destroy() error
  27. }