docs/1.1.3/Concurrent/Actor/Core.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Class: Concurrent::Actor::Core
  
    &mdash; Concurrent Ruby
  
</title>

  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  pathId = "Concurrent::Actor::Core";
  relpath = '../../';
</script>


  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="../../class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="../../_index.html">Index (C)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Actor.html" title="Concurrent::Actor (module)">Actor</a></span></span>
     &raquo; 
    <span class="title">Core</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../../class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><h1>Class: Concurrent::Actor::Core
  
  
</h1>
<div class="box_info">
  
  <dl>
    <dt>Inherits:</dt>
    <dd>
      <span class="inheritName"><span class='object_link'>Synchronization::LockableObject</span></span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next"><span class='object_link'>Synchronization::LockableObject</span></li>
          
            <li class="next">Concurrent::Actor::Core</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
    </dd>
  </dl>
  

  <dl>
      <dt>Includes:</dt>
      <dd><span class='object_link'><a href="TypeCheck.html" title="Concurrent::Actor::TypeCheck (module)">TypeCheck</a></span></dd>
  </dl>
  
  
  <dl>
    <dt>Defined in:</dt>
    <dd>lib-edge/concurrent/actor/core.rb</dd>
  </dl>
  
</div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
  <div class="note notetag">
    <strong>Note:</strong>
    <div class='inline'><p>Whole class should be considered private. An user should use <span class='object_link'><a href="Context.html" title="Concurrent::Actor::Context (class)">Context</a></span>s and <span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span>s only.</p>
</div>
  </div>

  <div class="note notetag">
    <strong>Note:</strong>
    <div class='inline'><p>devel: core should not block on anything, e.g. it cannot wait on children to terminate
that would eat up all threads in task pool and deadlock</p>
</div>
  </div>

<p>Core of the actor.</p>


  </div>
</div>
<div class="tags">
  

</div>


  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#actor_class-instance_method" title="#actor_class (instance method)">#<strong>actor_class</strong>  &#x21d2; Context </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'><p>A subclass of <span class='object_link'><a href="AbstractContext.html" title="Concurrent::Actor::AbstractContext (class)">AbstractContext</a></span> representing Actor&#39;s behaviour.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#behaviour_definition-instance_method" title="#behaviour_definition (instance method)">#<strong>behaviour_definition</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#context-instance_method" title="#context (instance method)">#<strong>context</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#context_class-instance_method" title="#context_class (instance method)">#<strong>context_class</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#executor-instance_method" title="#executor (instance method)">#<strong>executor</strong>  &#x21d2; Executor </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'><p>Executor which is used to process messages.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong>  &#x21d2; String </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'><p>The name of actor instance, it should be uniq (not enforced).</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong>  &#x21d2; String </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'><p>Path of this actor.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#reference-instance_method" title="#reference (instance method)">#<strong>reference</strong>  &#x21d2; Reference </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'><p>Reference to this actor which can be safely passed around.</p>
</div></span>
  
</li>

    
  </ul>


    <h2>
      Instance Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#add_child-instance_method" title="#add_child (instance method)">#<strong>add_child</strong>(child)  &#x21d2; undocumented </a>
    

  </span>
  
  
  <span class="private note title">private</span>

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#allocate_context-instance_method" title="#allocate_context (instance method)">#<strong>allocate_context</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
  <span class="private note title">private</span>

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#behaviour-instance_method" title="#behaviour (instance method)">#<strong>behaviour</strong>(behaviour_class)  &#x21d2; Behaviour::Abstract<sup>?</sup> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>Based on behaviour_class.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#behaviour!-instance_method" title="#behaviour! (instance method)">#<strong>behaviour!</strong>(behaviour_class)  &#x21d2; Behaviour::Abstract </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>Based on behaviour_class.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#broadcast-instance_method" title="#broadcast (instance method)">#<strong>broadcast</strong>(public, event)  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#build_context-instance_method" title="#build_context (instance method)">#<strong>build_context</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
  <span class="private note title">private</span>

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Child!-instance_method" title="#Child! (instance method)">#<strong>Child!</strong>(value, *types)  &#x21d2; undocumented </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Child!-instance_method" title="Concurrent::Actor::TypeCheck#Child! (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Child%3F-instance_method" title="#Child? (instance method)">#<strong>Child?</strong>(value, *types)  &#x21d2; Boolean </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Child%3F-instance_method" title="Concurrent::Actor::TypeCheck#Child? (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#children-instance_method" title="#children (instance method)">#<strong>children</strong>  &#x21d2; Array&lt;Reference&gt; </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>Of children actors.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#dead_letter_routing-instance_method" title="#dead_letter_routing (instance method)">#<strong>dead_letter_routing</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#guard!-instance_method" title="#guard! (instance method)">#<strong>guard!</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>ensures that we are inside of the executor.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}, &amp;block)  &#x21d2; Core </a>
    

  </span>
  
  
    <span class="note title constructor">constructor</span>
  
  
    <span class="summary_desc"><div class='inline'><p>A new instance of Core.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#log-instance_method" title="#log (instance method)">#<strong>log</strong>(level, message = nil, &amp;block)  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Match!-instance_method" title="#Match! (instance method)">#<strong>Match!</strong>(value, *types)  &#x21d2; undocumented </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Match!-instance_method" title="Concurrent::Actor::TypeCheck#Match! (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Match%3F-instance_method" title="#Match? (instance method)">#<strong>Match?</strong>(value, *types)  &#x21d2; Boolean </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Match%3F-instance_method" title="Concurrent::Actor::TypeCheck#Match? (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#on_envelope-instance_method" title="#on_envelope (instance method)">#<strong>on_envelope</strong>(envelope)  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>is executed by Reference scheduling processing of new messages can be called from other alternative Reference implementations.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong>  &#x21d2; Reference<sup>?</sup> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>A parent Actor.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#process_envelope-instance_method" title="#process_envelope (instance method)">#<strong>process_envelope</strong>(envelope)  &#x21d2; undocumented </a>
    

  </span>
  
  
  <span class="private note title">private</span>

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#remove_child-instance_method" title="#remove_child (instance method)">#<strong>remove_child</strong>(child)  &#x21d2; undocumented </a>
    

  </span>
  
  
  <span class="private note title">private</span>

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#schedule_execution-instance_method" title="#schedule_execution (instance method)">#<strong>schedule_execution</strong>  &#x21d2; undocumented </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'><p>Schedules blocks to be executed on executor sequentially, sets Actress.current.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Type!-instance_method" title="#Type! (instance method)">#<strong>Type!</strong>(value, *types)  &#x21d2; undocumented </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Type!-instance_method" title="Concurrent::Actor::TypeCheck#Type! (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#Type%3F-instance_method" title="#Type? (instance method)">#<strong>Type?</strong>(value, *types)  &#x21d2; Boolean </a>
    

  </span>
  
    <span class="note title not_defined_here">
      included
      from <span class='object_link'><a href="TypeCheck.html#Type%3F-instance_method" title="Concurrent::Actor::TypeCheck#Type? (method)">TypeCheck</a></span>
    </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  

  <div id="constructor_details" class="method_details_list">
  <h2>Constructor Details</h2>
  
    <div class="method_details first">
  <h3 class="signature first" id="initialize-instance_method">
  
    #<strong>initialize</strong>(opts = {}, &amp;block)  &#x21d2; <tt><span class='object_link'><a href="" title="Concurrent::Actor::Core (class)">Core</a></span></tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Returns a new instance of Core</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>block</span>
      
      
        <span class='type'>(<tt>Proc</tt>)</span>
      
      
        &mdash;
        <div class='inline'><p>for class instantiation</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>opts</span>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Concurrent::Hash (class)">Hash</a></span></tt>)</span>
      
      
        <em class="default">(defaults to: <tt>{}</tt>)</em>
      
      
        &mdash;
        <div class='inline'><p>a customizable set of options</p>
</div>
      
    </li>
  
</ul>

  
    <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
    <ul class="option">
      
        <li>
          <span class="name">name</span>
          <span class="type">(<tt>String</tt>)</span>
          <span class="default">
            
          </span>
          
        </li>
      
        <li>
          <span class="name">actor_class</span>
          <span class="type">(<tt><span class='object_link'><a href="Context.html" title="Concurrent::Actor::Context (class)">Context</a></span></tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>a class to be instantiated defining Actor&#39;s behaviour</p>
</div>
          
        </li>
      
        <li>
          <span class="name">args</span>
          <span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>&lt;Object&gt;</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>arguments for actor_class instantiation</p>
</div>
          
        </li>
      
        <li>
          <span class="name">executor,</span>
          <span class="type">(<tt>Executor</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>default is <code>global_io_executor</code></p>
</div>
          
        </li>
      
        <li>
          <span class="name">link,</span>
          <span class="type">(<tt>true</tt>, <tt>false</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>atomically link the actor to its parent (default: true)</p>
</div>
          
        </li>
      
        <li>
          <span class="name">reference</span>
          <span class="type">(<tt>Class</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>a custom descendant of <span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span> to use</p>
</div>
          
        </li>
      
        <li>
          <span class="name">behaviour_definition,</span>
          <span class="type">(<tt><span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>(Behavior::Abstract, <span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>&lt;Object&gt;)&gt;</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>array of pairs
where each pair is behaviour class and its args, see <span class='object_link'><a href="Behaviour.html#basic_behaviour_definition-class_method" title="Concurrent::Actor::Behaviour.basic_behaviour_definition (method)">Behaviour.basic_behaviour_definition</a></span></p>
</div>
          
        </li>
      
        <li>
          <span class="name">initialized,</span>
          <span class="type">(<tt>ResolvableFuture</tt>, <tt>nil</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>if present it&#39;ll be set or failed after <span class='object_link'><a href="Context.html" title="Concurrent::Actor::Context (class)">Concurrent::Actor::Context</a></span> initialization</p>
</div>
          
        </li>
      
        <li>
          <span class="name">parent</span>
          <span class="type">(<tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>, <tt>nil</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p><strong>private api</strong> parent of the actor (the one spawning )</p>
</div>
          
        </li>
      
        <li>
          <span class="name">logger</span>
          <span class="type">(<tt>Proc</tt>, <tt>nil</tt>)</span>
          <span class="default">
            
          </span>
          
            &mdash; <div class='inline'><p>a proc accepting (level, progname, message = nil, &amp;block) params,
can be used to hook actor instance to any logging system, see <span class='object_link'>Concern::Logging</span></p>
</div>
          
        </li>
      
    </ul>
  
    
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


50
51
52
53</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 50</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
  <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_ns_initialize'>ns_initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
  
</div>

  <div id="instance_attr_details" class="attr_details">
    <h2>Instance Attribute Details</h2>
    
      
      <span id=""></span>
      <div class="method_details first">
  <h3 class="signature first" id="actor_class-instance_method">
  
    #<strong>actor_class</strong>  &#x21d2; <tt><span class='object_link'><a href="Context.html" title="Concurrent::Actor::Context (class)">Context</a></span></tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    <p>A subclass of <span class='object_link'><a href="AbstractContext.html" title="Concurrent::Actor::AbstractContext (class)">AbstractContext</a></span> representing Actor&#39;s behaviour.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Context.html" title="Concurrent::Actor::Context (class)">Context</a></span></tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:reference</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:executor</span><span class='comma'>,</span> <span class='symbol'>:context_class</span><span class='comma'>,</span> <span class='symbol'>:context</span><span class='comma'>,</span> <span class='symbol'>:behaviour_definition</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="behaviour_definition-instance_method">
  
    #<strong>behaviour_definition</strong>  &#x21d2; <tt>undocumented</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35
36
37</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='kw'>def</span> <span class='id identifier rubyid_behaviour_definition'>behaviour_definition</span>
  <span class='ivar'>@behaviour_definition</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="context-instance_method">
  
    #<strong>context</strong>  &#x21d2; <tt>undocumented</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35
36
37</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='kw'>def</span> <span class='id identifier rubyid_context'>context</span>
  <span class='ivar'>@context</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="context_class-instance_method">
  
    #<strong>context_class</strong>  &#x21d2; <tt>undocumented</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35
36
37</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='kw'>def</span> <span class='id identifier rubyid_context_class'>context_class</span>
  <span class='ivar'>@context_class</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="executor-instance_method">
  
    #<strong>executor</strong>  &#x21d2; <tt>Executor</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Executor which is used to process messages.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Executor</tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:reference</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:executor</span><span class='comma'>,</span> <span class='symbol'>:context_class</span><span class='comma'>,</span> <span class='symbol'>:context</span><span class='comma'>,</span> <span class='symbol'>:behaviour_definition</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="name-instance_method">
  
    #<strong>name</strong>  &#x21d2; <tt>String</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    <p>The name of actor instance, it should be uniq (not enforced). Allows easier orientation
between actor instances.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:reference</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:executor</span><span class='comma'>,</span> <span class='symbol'>:context_class</span><span class='comma'>,</span> <span class='symbol'>:context</span><span class='comma'>,</span> <span class='symbol'>:behaviour_definition</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="path-instance_method">
  
    #<strong>path</strong>  &#x21d2; <tt>String</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Path of this actor. It is used for easier orientation and logging.
Path is constructed recursively with: <code>parent.path + self.name</code> up to a <span class='object_link'><a href="../Actor.html#root-class_method" title="Concurrent::Actor.root (method)">Concurrent::Actor.root</a></span>,
e.g. <code>/an_actor/its_child</code>.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:reference</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:executor</span><span class='comma'>,</span> <span class='symbol'>:context_class</span><span class='comma'>,</span> <span class='symbol'>:context</span><span class='comma'>,</span> <span class='symbol'>:behaviour_definition</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="reference-instance_method">
  
    #<strong>reference</strong>  &#x21d2; <tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Reference to this actor which can be safely passed around.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35
36
37</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 35</span>

<span class='kw'>def</span> <span class='id identifier rubyid_reference'>reference</span>
  <span class='ivar'>@reference</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>


  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="add_child-instance_method">
  
    #<strong>add_child</strong>(child)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


74
75
76
77
78
79</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 74</span>

<span class='kw'>def</span> <span class='id identifier rubyid_add_child'>add_child</span><span class='lparen'>(</span><span class='id identifier rubyid_child'>child</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_guard!'>guard!</span>
  <span class='id identifier rubyid_Type!'>Type!</span> <span class='id identifier rubyid_child'>child</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></span>
  <span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='id identifier rubyid_child'>child</span>
  <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="allocate_context-instance_method">
  
    #<strong>allocate_context</strong>  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


150
151
152</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 150</span>

<span class='kw'>def</span> <span class='id identifier rubyid_allocate_context'>allocate_context</span>
  <span class='ivar'>@context</span> <span class='op'>=</span> <span class='ivar'>@context_class</span><span class='period'>.</span><span class='id identifier rubyid_allocate'>allocate</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="behaviour-instance_method">
  
    #<strong>behaviour</strong>(behaviour_class)  &#x21d2; <tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt><sup>?</sup> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Returns based on behaviour_class</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>behaviour_class</span>
      
      
        <span class='type'>(<tt>Class</tt>)</span>
      
      
    </li>
  
</ul>

<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt>, <tt>nil</tt>)</span>
      
      
        &mdash;
        <div class='inline'><p>based on behaviour_class</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


138
139
140</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 138</span>

<span class='kw'>def</span> <span class='id identifier rubyid_behaviour'>behaviour</span><span class='lparen'>(</span><span class='id identifier rubyid_behaviour_class'>behaviour_class</span><span class='rparen'>)</span>
  <span class='ivar'>@behaviours</span><span class='lbracket'>[</span><span class='id identifier rubyid_behaviour_class'>behaviour_class</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="behaviour!-instance_method">
  
    #<strong>behaviour!</strong>(behaviour_class)  &#x21d2; <tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Returns based on behaviour_class</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>behaviour_class</span>
      
      
        <span class='type'>(<tt>Class</tt>)</span>
      
      
    </li>
  
</ul>

<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Behaviour/Abstract.html" title="Concurrent::Actor::Behaviour::Abstract (class)">Behaviour::Abstract</a></span></tt>)</span>
      
      
        &mdash;
        <div class='inline'><p>based on behaviour_class</p>
</div>
      
    </li>
  
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
  
    <li>
      
      
        <span class='type'>(<tt>KeyError</tt>)</span>
      
      
        &mdash;
        <div class='inline'><p>when no behaviour</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


145
146
147</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 145</span>

<span class='kw'>def</span> <span class='id identifier rubyid_behaviour!'>behaviour!</span><span class='lparen'>(</span><span class='id identifier rubyid_behaviour_class'>behaviour_class</span><span class='rparen'>)</span>
  <span class='ivar'>@behaviours</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='id identifier rubyid_behaviour_class'>behaviour_class</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="broadcast-instance_method">
  
    #<strong>broadcast</strong>(public, event)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


131
132
133
134</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 131</span>

<span class='kw'>def</span> <span class='id identifier rubyid_broadcast'>broadcast</span><span class='lparen'>(</span><span class='id identifier rubyid_public'>public</span><span class='comma'>,</span> <span class='id identifier rubyid_event'>event</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='const'>DEBUG</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>event: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_event'>event</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_public'>public</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>private</span><span class='tstring_end'>&#39;</span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
  <span class='ivar'>@first_behaviour</span><span class='period'>.</span><span class='id identifier rubyid_on_event'>on_event</span><span class='lparen'>(</span><span class='id identifier rubyid_public'>public</span><span class='comma'>,</span> <span class='id identifier rubyid_event'>event</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="build_context-instance_method">
  
    #<strong>build_context</strong>  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


155
156
157
158</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 155</span>

<span class='kw'>def</span> <span class='id identifier rubyid_build_context'>build_context</span>
  <span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:initialize_core</span><span class='comma'>,</span> <span class='kw'>self</span>
  <span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:initialize</span><span class='comma'>,</span> <span class='op'>*</span><span class='ivar'>@args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@block</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Child!-instance_method">
  
    #<strong>Child!</strong>(value, *types)  &#x21d2; <tt>undocumented</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Child!-instance_method" title="Concurrent::Actor::TypeCheck#Child! (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Child?-instance_method">
  
    #<strong>Child?</strong>(value, *types)  &#x21d2; <tt>Boolean</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Child%3F-instance_method" title="Concurrent::Actor::TypeCheck#Child? (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
    </li>
  
</ul>

</div>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="children-instance_method">
  
    #<strong>children</strong>  &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>&lt;<span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span>&gt;</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Returns of children actors</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Concurrent::Array (class)">Array</a></span>&lt;<span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span>&gt;</tt>)</span>
      
      
        &mdash;
        <div class='inline'><p>of children actors</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


68
69
70
71</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 68</span>

<span class='kw'>def</span> <span class='id identifier rubyid_children'>children</span>
  <span class='id identifier rubyid_guard!'>guard!</span>
  <span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="dead_letter_routing-instance_method">
  
    #<strong>dead_letter_routing</strong>  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

  <p class="tag_title">See Also:</p>
  <ul class="see">
    
      <li><span class='object_link'><a href="AbstractContext.html#dead_letter_routing-instance_method" title="Concurrent::Actor::AbstractContext#dead_letter_routing (method)">AbstractContext#dead_letter_routing</a></span></li>
    
  </ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


63
64
65</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 63</span>

<span class='kw'>def</span> <span class='id identifier rubyid_dead_letter_routing'>dead_letter_routing</span>
  <span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_dead_letter_routing'>dead_letter_routing</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="guard!-instance_method">
  
    #<strong>guard!</strong>  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>ensures that we are inside of the executor</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


102
103
104
105
106</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 102</span>

<span class='kw'>def</span> <span class='id identifier rubyid_guard!'>guard!</span>
  <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="../Actor.html" title="Concurrent::Actor (module)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_current'><span class='object_link'><a href="../Actor.html#current-class_method" title="Concurrent::Actor.current (method)">current</a></span></span> <span class='op'>==</span> <span class='id identifier rubyid_reference'>reference</span>
    <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>can be called only inside actor </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_reference'>reference</span><span class='embexpr_end'>}</span><span class='tstring_content'> but was </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../Actor.html" title="Concurrent::Actor (module)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_current'><span class='object_link'><a href="../Actor.html#current-class_method" title="Concurrent::Actor.current (method)">current</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  <span class='kw'>end</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="log-instance_method">
  
    #<strong>log</strong>(level, message = nil, &amp;block)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


108
109
110</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 108</span>

<span class='kw'>def</span> <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='id identifier rubyid_level'>level</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
  <span class='kw'>super</span> <span class='id identifier rubyid_level'>level</span><span class='comma'>,</span> <span class='ivar'>@path</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Match!-instance_method">
  
    #<strong>Match!</strong>(value, *types)  &#x21d2; <tt>undocumented</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Match!-instance_method" title="Concurrent::Actor::TypeCheck#Match! (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Match?-instance_method">
  
    #<strong>Match?</strong>(value, *types)  &#x21d2; <tt>Boolean</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Match%3F-instance_method" title="Concurrent::Actor::TypeCheck#Match? (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
    </li>
  
</ul>

</div>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="on_envelope-instance_method">
  
    #<strong>on_envelope</strong>(envelope)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>is executed by Reference scheduling processing of new messages
can be called from other alternative Reference implementations</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>envelope</span>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Envelope.html" title="Concurrent::Actor::Envelope (class)">Envelope</a></span></tt>)</span>
      
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


92
93
94
95
96
97
98
99</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 92</span>

<span class='kw'>def</span> <span class='id identifier rubyid_on_envelope'>on_envelope</span><span class='lparen'>(</span><span class='id identifier rubyid_envelope'>envelope</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='const'>DEBUG</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>is  </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_future'>future</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>asked</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>told</span><span class='tstring_end'>&#39;</span></span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> by </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_sender'>sender</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
  <span class='id identifier rubyid_schedule_execution'>schedule_execution</span> <span class='kw'>do</span>
    <span class='id identifier rubyid_log'>log</span><span class='lparen'>(</span><span class='const'>DEBUG</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>was </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_future'>future</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>asked</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>told</span><span class='tstring_end'>&#39;</span></span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> by </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_envelope'>envelope</span><span class='period'>.</span><span class='id identifier rubyid_sender'>sender</span><span class='embexpr_end'>}</span><span class='tstring_content'> - processing</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
    <span class='id identifier rubyid_process_envelope'>process_envelope</span> <span class='id identifier rubyid_envelope'>envelope</span>
  <span class='kw'>end</span>
  <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="parent-instance_method">
  
    #<strong>parent</strong>  &#x21d2; <tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt><sup>?</sup> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>A parent Actor. When actor is spawned the <span class='object_link'><a href="../Actor.html#current-class_method" title="Concurrent::Actor.current (method)">Concurrent::Actor.current</a></span> becomes its parent.
When actor is spawned from a thread outside of an actor (<span class='object_link'><a href="../Actor.html#current-class_method" title="Concurrent::Actor.current (method)">Concurrent::Actor.current</a></span> is nil) <span class='object_link'><a href="../Actor.html#root-class_method" title="Concurrent::Actor.root (method)">Concurrent::Actor.root</a></span> is assigned.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></tt>, <tt>nil</tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


58
59
60</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 58</span>

<span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
  <span class='ivar'>@parent_core</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@parent_core</span><span class='period'>.</span><span class='id identifier rubyid_reference'>reference</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="process_envelope-instance_method">
  
    #<strong>process_envelope</strong>(envelope)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


161
162
163</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 161</span>

<span class='kw'>def</span> <span class='id identifier rubyid_process_envelope'>process_envelope</span><span class='lparen'>(</span><span class='id identifier rubyid_envelope'>envelope</span><span class='rparen'>)</span>
  <span class='ivar'>@first_behaviour</span><span class='period'>.</span><span class='id identifier rubyid_on_envelope'>on_envelope</span> <span class='id identifier rubyid_envelope'>envelope</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="remove_child-instance_method">
  
    #<strong>remove_child</strong>(child)  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


82
83
84
85
86
87</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 82</span>

<span class='kw'>def</span> <span class='id identifier rubyid_remove_child'>remove_child</span><span class='lparen'>(</span><span class='id identifier rubyid_child'>child</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_guard!'>guard!</span>
  <span class='id identifier rubyid_Type!'>Type!</span> <span class='id identifier rubyid_child'>child</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="Reference.html" title="Concurrent::Actor::Reference (class)">Reference</a></span></span>
  <span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_child'>child</span>
  <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="schedule_execution-instance_method">
  
    #<strong>schedule_execution</strong>  &#x21d2; <tt>undocumented</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    <p>Schedules blocks to be executed on executor sequentially,
sets Actress.current</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib-edge/concurrent/actor/core.rb', line 114</span>

<span class='kw'>def</span> <span class='id identifier rubyid_schedule_execution'>schedule_execution</span>
  <span class='ivar'>@serialized_execution</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='ivar'>@executor</span><span class='rparen'>)</span> <span class='kw'>do</span>
    <span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
      <span class='kw'>begin</span>
        <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:__current_actor__</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_reference'>reference</span>
        <span class='kw'>yield</span>
      <span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
        <span class='id identifier rubyid_log'>log</span> <span class='const'>FATAL</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span>
      <span class='kw'>ensure</span>
        <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:__current_actor__</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>nil</span>
      <span class='kw'>end</span>
    <span class='kw'>end</span>
  <span class='kw'>end</span>

  <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Type!-instance_method">
  
    #<strong>Type!</strong>(value, *types)  &#x21d2; <tt>undocumented</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Type!-instance_method" title="Concurrent::Actor::TypeCheck#Type! (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  

</div>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="Type?-instance_method">
  
    #<strong>Type?</strong>(value, *types)  &#x21d2; <tt>Boolean</tt> 
  

    <span class="not_defined_here">
      Originally defined in module
        <span class='object_link'><a href="TypeCheck.html#Type%3F-instance_method" title="Concurrent::Actor::TypeCheck#Type? (method)">TypeCheck</a></span>
    </span>
  
</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
    </li>
  
</ul>

</div>
</div>
    
  </div>

</div>

      <div id="footer">
  Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_blank">yard</a>.
</div>

<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

  ga('create', 'UA-57940973-1', 'auto');
  ga('send', 'pageview');

</script>

    </div>
  </body>
</html>