Class: Smith::Workflow::Parallel::CancellationSignal

Inherits:

Struct

• Object
• Struct
• Smith::Workflow::Parallel::CancellationSignal

Defined in:

lib/smith/workflow/parallel/cancellation_signal.rb

Instance Attribute Summary

• #cancelled ⇒ Object

  Returns the value of attribute cancelled.

• #mutex ⇒ Object

  Returns the value of attribute mutex.

Instance Method Summary

• #cancel! ⇒ Object
• #cancelled? ⇒ Boolean
• #initialize ⇒ CancellationSignal constructor

  A new instance of CancellationSignal.

Constructor Details

#initialize ⇒ CancellationSignal

Returns a new instance of CancellationSignal.

# File 'lib/smith/workflow/parallel/cancellation_signal.rb', line 7

def initialize
  super(false, Mutex.new)
end

Instance Attribute Details

#cancelled ⇒ Object

Returns the value of attribute cancelled

Returns:

• (Object) —

  the current value of cancelled

# File 'lib/smith/workflow/parallel/cancellation_signal.rb', line 6

def cancelled
  @cancelled
end

#mutex ⇒ Object

Returns the value of attribute mutex

Returns:

• (Object) —

  the current value of mutex

# File 'lib/smith/workflow/parallel/cancellation_signal.rb', line 6

def mutex
  @mutex
end

Instance Method Details

#cancel! ⇒ Object

# File 'lib/smith/workflow/parallel/cancellation_signal.rb', line 11

def cancel!
  mutex.synchronize { self.cancelled = true }
end

#cancelled? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/smith/workflow/parallel/cancellation_signal.rb', line 15

def cancelled?
  mutex.synchronize { cancelled }
end