Class: LockFile Private
Overview
This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.
A lock file.
Direct Known Subclasses
Instance Attribute Summary collapse
- #path ⇒ Object readonly private
Instance Method Summary collapse
-
#initialize(name) ⇒ LockFile
constructor
private
A new instance of LockFile.
- #lock ⇒ Object private
- #unlock ⇒ Object private
- #with_lock ⇒ Object private
Constructor Details
#initialize(name) ⇒ LockFile
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Returns a new instance of LockFile.
10 11 12 13 14 |
# File 'lock_file.rb', line 10 def initialize(name) @name = name.to_s @path = HOMEBREW_LOCKS/"#{@name}.lock" @lockfile = nil end |
Instance Attribute Details
#path ⇒ Object (readonly)
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
8 9 10 |
# File 'lock_file.rb', line 8 def path @path end |
Instance Method Details
#lock ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
16 17 18 19 20 21 22 |
# File 'lock_file.rb', line 16 def lock @path.parent.mkpath create_lockfile return if @lockfile.flock(File::LOCK_EX | File::LOCK_NB) raise OperationInProgressError, @name end |
#unlock ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
24 25 26 27 28 29 |
# File 'lock_file.rb', line 24 def unlock return if @lockfile.nil? || @lockfile.closed? @lockfile.flock(File::LOCK_UN) @lockfile.close end |
#with_lock ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
31 32 33 34 35 36 |
# File 'lock_file.rb', line 31 def with_lock lock yield ensure unlock end |