Class: ApplicationInsights::Channel::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/application_insights/channel/event.rb

Overview

An event class that allows simple cross-thread signalling.

An object of this type managers an internal flag that can be set to true via the #set method and reset via the #clear method. Calling the #wait method will block until the flag is set to true.

Examples:

require 'application_insights'
require 'thread'
event = ApplicationInsights::Channel::Event.new
Thread.new do
  sleep 1
  event.set
end
puts 'Main screen turn on.'
result = event.wait
puts 'All your base are belong to us.'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Event

Initializes a new instance of the class.



23
24
25
26
27
 
# File 'lib/application_insights/channel/event.rb', line 23

def initialize
  @mutex = Mutex.new
  @condition_variable = ConditionVariable.new
  @signal = false
end

Instance Attribute Details

#signal ⇒ Boolean (readonly)

The signal value for this object. Note that the value of this property is not synchronized with respect to #set and #clear meaning that it could return false positives or negatives.

Returns:

  • (Boolean) —

    the signal value.



32
33
34
 
# File 'lib/application_insights/channel/event.rb', line 32

def signal
  @signal
end

Instance Method Details

#clear ⇒ Object

Sets the internal flag to false.



43
44
45
46
47
 
# File 'lib/application_insights/channel/event.rb', line 43

def clear
  @mutex.synchronize do
    @signal = false
  end
end

#set ⇒ Object

Sets the internal flag to true. Calling this method will also cause all waiting threads to awaken.



35
36
37
38
39
40
 
# File 'lib/application_insights/channel/event.rb', line 35

def set
  @mutex.synchronize do
    @signal = true
    @condition_variable.broadcast
  end
end

#wait(timeout = nil) ⇒ Boolean

Calling this method will block until the internal flag is set to true. If the flag is set to true before calling this method, we will return immediately. If the timeout parameter is specified, the method will unblock after the specified number of seconds.

Parameters:

  • timeout (Fixnum) (defaults to: nil) —

    the timeout for the operation in seconds.

Returns:

  • (Boolean) —

    the value of the internal flag on exit.



54
55
56
57
58
59
60
61
 
# File 'lib/application_insights/channel/event.rb', line 54

def wait(timeout=nil)
  @mutex.synchronize do
    if @signal == false
      @condition_variable.wait @mutex, (timeout == nil) ? nil : timeout
    end
    @signal
  end
end