<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: Reactor</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Reactor</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/network/reactor_rb.html"> lib/network/reactor.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="rect" coords="5,5,77,53" href="Reactor.html" alt="Reactor " /> </map> <img src="../dot/f_39.png" usemap="#map" border="0" alt="dot/f_39.png"> </div> <div id="description"> <p> The <a href="Reactor.html">Reactor</a> class defines a representation of a multiplexer based on a non-blocking select() server. </p> <p> The network design is based on the Mesh project NetworkService code which was translated almost directly from C++, warts and all, which in turn is based on Schmidt‘s <a href="Acceptor.html">Acceptor</a>/<a href="Connector.html">Connector</a>/<a href="Reactor.html">Reactor</a> patterns which may be found at <a href="http://citeseer.ist.psu.edu/schmidt97acceptor.html">citeseer.ist.psu.edu/schmidt97acceptor.html</a> for an idea of how all these classes are supposed to interelate. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000147">new</a> <a href="#M000150">poll</a> <a href="#M000151">register</a> <a href="#M000148">start</a> <a href="#M000149">stop</a> <a href="#M000152">unregister</a> </div> </div> </div> <!-- if includes --> <div id="section"> <div id="attribute-list"> <h3 class="section-bar">Attributes</h3> <div class="name-list"> <table> <tr class="top-aligned-row context-row"> <td class="context-item-name">port</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">service_filters</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">service_io</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">service_negotiation</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">service_type</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> </table> </div> </div> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000147" class="method-detail"> <a name="M000147"></a> <div class="method-heading"> <a href="#M000147" class="method-signature"> <span class="method-name">new</span><span class="method-args">(service_port, service_type, service_io, service_negotiation, service_filters, address=nil)</span> </a> </div> <div class="method-description"> <p> Constructor for <a href="Reactor.html">Reactor</a> </p> <dl> <dt><tt>service_port</tt></dt><dd>The port the server will listen on or client will connect to. </dd> <dt><tt>service_type</tt></dt><dd>The type of service (:server or :client) </dd> <dt><tt>service_io</tt></dt><dd>The service io handler (:sockio, :lineio, or :packetio) </dd> <dt><tt>service_negotiation</tt></dt><dd>An array of telnet options the service will try to negotiate </dd> </dl> <pre> Valid options are :sga, :echo, :naws, :ttype, :zmp (negotiate default) :binary </pre> <dl> <dt><tt>service_filters</tt></dt><dd>An array of io filters the service will use. </dd> </dl> <pre> Valid options are :filter - attach dummy filter :debugfilter - attach debug filter (default) :telnetfilter - attach telnet filter (default) :colorfilter - attach color filter (default) :terminalfilter - attach terminal filter </pre> <dl> <dt><tt>address</tt></dt><dd>Optional address for outgoing connection. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000147-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000147-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 55</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">service_port</span>, <span class="ruby-identifier">service_type</span>, <span class="ruby-identifier">service_io</span>, <span class="ruby-identifier">service_negotiation</span>, <span class="ruby-identifier">service_filters</span>, <span class="ruby-identifier">address</span>=<span class="ruby-keyword kw">nil</span>) <span class="ruby-ivar">@port</span> = <span class="ruby-identifier">service_port</span> <span class="ruby-comment cmt"># port server will listen on</span> <span class="ruby-ivar">@shutdown</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-comment cmt"># Flag to indicate that server is shutting down.</span> <span class="ruby-ivar">@acceptor</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># Listening socket for incoming connections.</span> <span class="ruby-ivar">@connector</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># Connecting socket for outgoing connections.</span> <span class="ruby-ivar">@registry</span> = [] <span class="ruby-comment cmt"># list of sessions</span> <span class="ruby-ivar">@address</span> = <span class="ruby-identifier">address</span> <span class="ruby-comment cmt"># Address for Connector.</span> <span class="ruby-ivar">@service_type</span> = <span class="ruby-identifier">service_type</span> <span class="ruby-ivar">@service_io</span> = <span class="ruby-identifier">service_io</span> <span class="ruby-ivar">@service_negotiation</span> = <span class="ruby-identifier">service_negotiation</span> <span class="ruby-ivar">@service_filters</span> = <span class="ruby-identifier">service_filters</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inspect</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000150" class="method-detail"> <a name="M000150"></a> <div class="method-heading"> <a href="#M000150" class="method-signature"> <span class="method-name">poll</span><span class="method-args">(tm_out)</span> </a> </div> <div class="method-description"> <p> <a href="Reactor.html#M000150">poll</a> starts the <a href="Reactor.html">Reactor</a> running to process incoming connection, input and output requests. It also executes commands from input requests. </p> <dl> <dt>+tm_out*</dt><dd>time to <a href="Reactor.html#M000150">poll</a> in seconds </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000150-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000150-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 107</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">poll</span>(<span class="ruby-identifier">tm_out</span>) <span class="ruby-comment cmt"># Reset our socket interest set</span> <span class="ruby-identifier">infds</span> = [];<span class="ruby-identifier">outfds</span> = [];<span class="ruby-identifier">oobfds</span> = [] <span class="ruby-ivar">@registry</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">is_readable?</span> <span class="ruby-identifier">infds</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span> <span class="ruby-identifier">oobfds</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">is_writable?</span> <span class="ruby-identifier">outfds</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># Poll our socket interest set</span> <span class="ruby-identifier">infds</span>,<span class="ruby-identifier">outfds</span>,<span class="ruby-identifier">oobfds</span> = <span class="ruby-identifier">select</span>(<span class="ruby-identifier">infds</span>, <span class="ruby-identifier">outfds</span>, <span class="ruby-identifier">oobfds</span>, <span class="ruby-identifier">tm_out</span>) <span class="ruby-comment cmt"># Dispatch events to handlers</span> <span class="ruby-ivar">@registry</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">handle_output</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">outfds</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">outfds</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span>) <span class="ruby-identifier">s</span>.<span class="ruby-identifier">handle_oob</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">oobfds</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">oobfds</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span>) <span class="ruby-identifier">s</span>.<span class="ruby-identifier">handle_input</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">infds</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">infds</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">sock</span>) <span class="ruby-identifier">s</span>.<span class="ruby-identifier">handle_close</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">closing</span> <span class="ruby-comment cmt"># special handling for Telnet initialization</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@service_filters</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:telnetfilter</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:initdone</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">s</span>.<span class="ruby-identifier">initdone</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">pstack</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">:init_subneg</span>, <span class="ruby-keyword kw">true</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"Reactor#poll"</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">$!</span> <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000151" class="method-detail"> <a name="M000151"></a> <div class="method-heading"> <a href="#M000151" class="method-signature"> <span class="method-name">register</span><span class="method-args">(session)</span> </a> </div> <div class="method-description"> <p> <a href="Reactor.html#M000151">register</a> adds a session to the registry [<tt>session</tt>] </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000151-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000151-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 143</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register</span>(<span class="ruby-identifier">session</span>) <span class="ruby-ivar">@registry</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">session</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000148" class="method-detail"> <a name="M000148"></a> <div class="method-heading"> <a href="#M000148" class="method-signature"> <span class="method-name">start</span><span class="method-args">(engine)</span> </a> </div> <div class="method-description"> <p> Start initializes the reactor and gets it ready to accept incoming connections. </p> <dl> <dt><tt>engine</tt></dt><dd>The client engine that will be observing the acceptor. </dd> <dt><tt>return</tt>‘</dt><dd>true if server boots correctly, false if an error occurs. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000148-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000148-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 75</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>(<span class="ruby-identifier">engine</span>) <span class="ruby-comment cmt"># Create an acceptor to listen for this server.</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@service_type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:client</span> <span class="ruby-ivar">@connector</span> = <span class="ruby-constant">Connector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-ivar">@address</span>) <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">engine</span>) <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">init</span> <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@acceptor</span> = <span class="ruby-constant">Acceptor</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@acceptor</span>.<span class="ruby-identifier">init</span> <span class="ruby-ivar">@acceptor</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">engine</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"Reactor#start"</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">$!</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000149" class="method-detail"> <a name="M000149"></a> <div class="method-heading"> <a href="#M000149" class="method-signature"> <span class="method-name">stop</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> <a href="Reactor.html#M000149">stop</a> requests each of the connections to disconnect in the server‘s user list, deletes the connections, and erases them from the user list. It then closes its own listening port. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000149-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000149-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 96</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span> <span class="ruby-ivar">@registry</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">closing</span> = <span class="ruby-keyword kw">true</span>} <span class="ruby-ivar">@acceptor</span>.<span class="ruby-identifier">unsubscribe_all</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@acceptor</span> <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">unsubscribe_all</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@connector</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Reactor#shutdown: Reactor shutting down"</span> <span class="ruby-comment cmt"># log.close</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000152" class="method-detail"> <a name="M000152"></a> <div class="method-heading"> <a href="#M000152" class="method-signature"> <span class="method-name">unregister</span><span class="method-args">(session)</span> </a> </div> <div class="method-description"> <p> <a href="Reactor.html#M000152">unregister</a> removes a session from the registry [<tt>session</tt>] </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000152-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000152-source"> <pre> <span class="ruby-comment cmt"># File lib/network/reactor.rb, line 149</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unregister</span>(<span class="ruby-identifier">session</span>) <span class="ruby-ivar">@registry</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>