Class: OpenHAB::Core::Timer

Overview

Instance Attribute Summary collapse

• #execution_time ⇒ ZonedDateTime^? readonly

  The scheduled execution time, or nil if the timer was cancelled.

• #id ⇒ Object^?

Instance Method Summary collapse

• #active? ⇒ true, false

  Check if the timer will execute in the future.

• #cancel ⇒ true, false

  Cancel timer.

• #cancelled? ⇒ true, false

  Check if the timer has been cancelled.

• #inspect ⇒ String (also: #to_s)
• #reschedule(time = nil) ⇒ self

  Reschedule timer.

• #running? ⇒ true, false

  Check if the timer code is currently running.

• #terminated? ⇒ true, false

  Check if the timer has terminated.

# File 'lib/openhab/core/timer.rb', line 69

34
35
36

# File 'lib/openhab/core/timer.rb', line 34

def id
  @id
end

# File 'lib/openhab/core/timer.rb', line 14

107
108
109
110

# File 'lib/openhab/core/timer.rb', line 107

def cancel
  DSL.timers.delete(self)
  cancel!
end

# File 'lib/openhab/core/timer.rb', line 18

57
58
59
60
61
62
63
64
65
66

# File 'lib/openhab/core/timer.rb', line 57

def inspect
  r = "#<#{self.class.name} #{"#{id.inspect} " if id}#{block.source_location.join(":")}"
  if cancelled?
    r += " (cancelled)"
  else
    r += " @ #{execution_time}"
    r += " (executed)" if terminated?
  end
  "#{r}>"
end

82
83
84
85
86
87
88
89
90
91

# File 'lib/openhab/core/timer.rb', line 82

def reschedule(time = nil)
  return reschedule!(time) unless id

  # re-add ourself to the TimerManager's @timers_by_id
  DSL.timers.schedule(id) do |old_timer|
    old_timer&.cancel unless old_timer.eql?(self)
    self.id = nil
    reschedule!(time)
  end
end

# File 'lib/openhab/core/timer.rb', line 22

30

# File 'lib/openhab/core/timer.rb', line 30

def_delegator :@timer, :has_terminated, :terminated?