Class: Concurrent::Cancellation

Inherits:

Synchronization::Object

• Object
• Synchronization::Object
• Concurrent::Cancellation

show all

Defined in:

lib/concurrent/edge/cancellation.rb

Overview

# Create new cancellation. `cancellation` is used for cancelling, `token` is passed down to
# tasks for cooperative cancellation
cancellation, token = Concurrent::Cancellation.create
Thread.new(token) do |token|
  # Count 1+1 (simulating some other meaningful work) repeatedly
  # until the token is cancelled through cancellation.
  token.loop_until_canceled { 1+1 }
end
sleep 0.1
cancellation.cancel # Stop the thread by cancelling

Defined Under Namespace

Classes: Token

Class Method Summary (collapse)

• + (Array(Cancellation, Cancellation::Token)) create(resolvable_future_or_event = Promises.resolvable_event, *resolve_args)

  Creates the cancellation object.

Instance Method Summary (collapse)

• - (true, false) cancel(raise_on_repeated_call = true)

  Cancel this cancellation.

• - (true, false) canceled?

  Is the cancellation cancelled?.

• - (String) to_s (also: #inspect)

  Short string representation.

• - (Token) token

  Returns the token associated with the cancellation.

cancellation, token = Concurrent::Cancellation.create

28
29
30
31

# File 'lib/concurrent/edge/cancellation.rb', line 28

def self.create(resolvable_future_or_event = Promises.resolvable_event, *resolve_args)
  cancellation = new(resolvable_future_or_event, *resolve_args)
  [cancellation, cancellation.token]
end

44
45
46

# File 'lib/concurrent/edge/cancellation.rb', line 44

def cancel(raise_on_repeated_call = true)
  !!@Cancel.resolve(*@ResolveArgs, raise_on_repeated_call)
end

50
51
52

# File 'lib/concurrent/edge/cancellation.rb', line 50

def canceled?
  @Cancel.resolved?
end

56
57
58

# File 'lib/concurrent/edge/cancellation.rb', line 56

def to_s
  format '<#%s:0x%x canceled:%s>', self.class, object_id << 1, canceled?
end

37
38
39

# File 'lib/concurrent/edge/cancellation.rb', line 37

def token
  @Token
end