Class: Concurrent::Actor::Behaviour::Termination

Inherits:

Abstract

• Object
• Abstract
• Concurrent::Actor::Behaviour::Termination

show all

Defined in:

lib/concurrent/actor/behaviour/termination.rb

Overview

Instance Attribute Summary (collapse)

• - (undocumented) core inherited from Abstract readonly
• - (undocumented) subsequent inherited from Abstract readonly
• - (undocumented) terminated readonly

Instance Method Summary (collapse)

• - (Termination) initialize(core, subsequent, core_options, trapping = false, terminate_children = true) constructor

  A new instance of Termination.

• - (undocumented) on_envelope(envelope)
• - (undocumented) terminate!(reason = nil, envelope = nil)

  Terminates the actor.

• - (true, false) terminated?

  If actor is terminated.

• - (undocumented) trapping=(val)
• - (Boolean) trapping?

15
16
17
18
19
20
21

# File 'lib/concurrent/actor/behaviour/termination.rb', line 15

def initialize(core, subsequent, core_options, trapping = false, terminate_children = true)
  super core, subsequent, core_options
  @terminated         = Concurrent::Promises.resolvable_future
  @public_terminated  = @terminated.with_hidden_resolvable
  @trapping           = trapping
  @terminate_children = terminate_children
end

13
14
15

# File 'lib/concurrent/actor/behaviour/termination.rb', line 13

def terminated
  @terminated
end

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# File 'lib/concurrent/actor/behaviour/termination.rb', line 37

def on_envelope(envelope)
  command, reason = envelope.message
  case command
  when :terminated?
    terminated?
  when :terminate!
    if trapping? && reason != :kill
      pass envelope
    else
      terminate! reason, envelope
    end
  when :termination_event
    @public_terminated
  else
    if terminated?
      reject_envelope envelope
      MESSAGE_PROCESSED
    else
      pass envelope
    end
  end
end

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# File 'lib/concurrent/actor/behaviour/termination.rb', line 62

def terminate!(reason = nil, envelope = nil)
  return true if terminated?

  self_termination = Concurrent::Promises.resolved_future(reason.nil?, reason.nil? || nil, reason)
  all_terminations = if @terminate_children
                       Concurrent::Promises.zip(*children.map { |ch| ch.ask(:terminate!) }, self_termination)
                     else
                       self_termination
                     end

  all_terminations.chain_resolvable(@terminated)
  if envelope && envelope.future
    all_terminations.chain { |fulfilled, _, reason| envelope.future.resolve fulfilled, true, reason }
  end

  broadcast(true, [:terminated, reason]) # TODO do not end up in Dead Letter Router
  parent << :remove_child if parent

  MESSAGE_PROCESSED
end

25
26
27

# File 'lib/concurrent/actor/behaviour/termination.rb', line 25

def terminated?
  @terminated.resolved?
end

33
34
35

# File 'lib/concurrent/actor/behaviour/termination.rb', line 33

def trapping=(val)
  @trapping = !!val
end

29
30
31

# File 'lib/concurrent/actor/behaviour/termination.rb', line 29

def trapping?
  @trapping
end