Class: Concurrent::Actor::Core
- Inherits:
-
Synchronization::LockableObject
- Object
- Synchronization::LockableObject
- Concurrent::Actor::Core
- Includes:
- TypeCheck
- Defined in:
- lib/concurrent-ruby-edge/concurrent/actor/core.rb
Overview
Instance Attribute Summary collapse
-
#actor_class ⇒ Context
readonly
A subclass of AbstractContext representing Actor's behaviour.
- #behaviour_definition ⇒ undocumented readonly
- #context ⇒ undocumented readonly
- #context_class ⇒ undocumented readonly
-
#executor ⇒ Executor
readonly
Executor which is used to process messages.
-
#name ⇒ String
readonly
The name of actor instance, it should be uniq (not enforced).
-
#path ⇒ String
readonly
Path of this actor.
-
#reference ⇒ Reference
readonly
Reference to this actor which can be safely passed around.
Instance Method Summary collapse
- #add_child(child) ⇒ undocumented private
- #allocate_context ⇒ undocumented private
-
#behaviour(behaviour_class) ⇒ Behaviour::Abstract, nil
Based on behaviour_class.
-
#behaviour!(behaviour_class) ⇒ Behaviour::Abstract
Based on behaviour_class.
- #broadcast(public, event) ⇒ undocumented
- #build_context ⇒ undocumented private
-
#children ⇒ Array<Reference>
Of children actors.
- #dead_letter_routing ⇒ undocumented
-
#guard! ⇒ undocumented
ensures that we are inside of the executor.
-
#initialize(opts = {}, &block) ⇒ Core
constructor
A new instance of Core.
- #log(level, message = nil, &block) ⇒ undocumented
-
#on_envelope(envelope) ⇒ undocumented
is executed by Reference scheduling processing of new messages can be called from other alternative Reference implementations.
-
#parent ⇒ Reference, nil
A parent Actor.
- #process_envelope(envelope) ⇒ undocumented private
- #remove_child(child) ⇒ undocumented private
-
#schedule_execution ⇒ undocumented
Schedules blocks to be executed on executor sequentially, sets Actress.current.
- #Child!(value, *types) ⇒ undocumented included from TypeCheck
- #Child?(value, *types) ⇒ Boolean included from TypeCheck
- #Match!(value, *types) ⇒ undocumented included from TypeCheck
- #Match?(value, *types) ⇒ Boolean included from TypeCheck
- #Type!(value, *types) ⇒ undocumented included from TypeCheck
- #Type?(value, *types) ⇒ Boolean included from TypeCheck
Constructor Details
#initialize(opts = {}, &block) ⇒ Core
Returns a new instance of Core.
50 51 52 53 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 50 def initialize(opts = {}, &block) super(&nil) synchronize { ns_initialize(opts, &block) } end |
Instance Attribute Details
#actor_class ⇒ Context (readonly)
A subclass of AbstractContext representing Actor's behaviour.
35 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 attr_reader :reference, :name, :path, :executor, :context_class, :context, :behaviour_definition |
#behaviour_definition ⇒ undocumented (readonly)
35 36 37 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 def behaviour_definition @behaviour_definition end |
#context ⇒ undocumented (readonly)
35 36 37 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 def context @context end |
#context_class ⇒ undocumented (readonly)
35 36 37 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 def context_class @context_class end |
#executor ⇒ Executor (readonly)
Executor which is used to process messages.
35 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 attr_reader :reference, :name, :path, :executor, :context_class, :context, :behaviour_definition |
#name ⇒ String (readonly)
The name of actor instance, it should be uniq (not enforced). Allows easier orientation between actor instances.
35 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 attr_reader :reference, :name, :path, :executor, :context_class, :context, :behaviour_definition |
#path ⇒ String (readonly)
Path of this actor. It is used for easier orientation and logging.
Path is constructed recursively with: parent.path + self.name
up to a Concurrent::Actor.root,
e.g. /an_actor/its_child
.
35 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 attr_reader :reference, :name, :path, :executor, :context_class, :context, :behaviour_definition |
#reference ⇒ Reference (readonly)
Reference to this actor which can be safely passed around.
35 36 37 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 35 def reference @reference end |
Instance Method Details
#add_child(child) ⇒ undocumented
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
74 75 76 77 78 79 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 74 def add_child(child) guard! Type! child, Reference @children.add child nil end |
#allocate_context ⇒ undocumented
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
150 151 152 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 150 def allocate_context @context = @context_class.allocate end |
#behaviour(behaviour_class) ⇒ Behaviour::Abstract, nil
Returns based on behaviour_class.
138 139 140 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 138 def behaviour(behaviour_class) @behaviours[behaviour_class] end |
#behaviour!(behaviour_class) ⇒ Behaviour::Abstract
Returns based on behaviour_class.
145 146 147 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 145 def behaviour!(behaviour_class) @behaviours.fetch behaviour_class end |
#broadcast(public, event) ⇒ undocumented
131 132 133 134 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 131 def broadcast(public, event) log(DEBUG) { "event: #{event.inspect} (#{public ? 'public' : 'private'})" } @first_behaviour.on_event(public, event) end |
#build_context ⇒ undocumented
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
155 156 157 158 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 155 def build_context @context.send :initialize_core, self @context.send :initialize, *@args, &@block end |
#children ⇒ Array<Reference>
Returns of children actors.
68 69 70 71 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 68 def children guard! @children.to_a end |
#dead_letter_routing ⇒ undocumented
63 64 65 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 63 def dead_letter_routing @context.dead_letter_routing end |
#guard! ⇒ undocumented
ensures that we are inside of the executor
102 103 104 105 106 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 102 def guard! unless Actor.current == reference raise "can be called only inside actor #{reference} but was #{Actor.current}" end end |
#log(level, message = nil, &block) ⇒ undocumented
108 109 110 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 108 def log(level, = nil, &block) super level, @path, , &block end |
#on_envelope(envelope) ⇒ undocumented
is executed by Reference scheduling processing of new messages can be called from other alternative Reference implementations
92 93 94 95 96 97 98 99 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 92 def on_envelope(envelope) log(DEBUG) { "is #{envelope.future ? 'asked' : 'told'} #{envelope..inspect} by #{envelope.sender}" } schedule_execution do log(DEBUG) { "was #{envelope.future ? 'asked' : 'told'} #{envelope..inspect} by #{envelope.sender} - processing" } process_envelope envelope end nil end |
#parent ⇒ Reference, nil
A parent Actor. When actor is spawned the Concurrent::Actor.current becomes its parent. When actor is spawned from a thread outside of an actor (Concurrent::Actor.current is nil) Concurrent::Actor.root is assigned.
58 59 60 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 58 def parent @parent_core && @parent_core.reference end |
#process_envelope(envelope) ⇒ undocumented
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
161 162 163 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 161 def process_envelope(envelope) @first_behaviour.on_envelope envelope end |
#remove_child(child) ⇒ undocumented
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
82 83 84 85 86 87 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 82 def remove_child(child) guard! Type! child, Reference @children.delete child nil end |
#schedule_execution ⇒ undocumented
Schedules blocks to be executed on executor sequentially, sets Actress.current
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/concurrent-ruby-edge/concurrent/actor/core.rb', line 114 def schedule_execution @serialized_execution.post(@executor) do synchronize do begin Thread.current[:__current_actor__] = reference yield rescue => e log FATAL, e ensure Thread.current[:__current_actor__] = nil end end end nil end |