<?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: Connector</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">Connector</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/connector_rb.html">
lib/network/connector.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Session.html">
Session
</a>
</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,101,91,149" href="Connector.html" alt="Connector
" />
<area shape="rect" coords="12,5,84,53" href="Session.html" alt="Session
" />
</map>
<img src="../dot/f_26.png" usemap="#map" border="0" alt="dot/f_26.png">
</div>
<div id="description">
<p>
The <a href="Connector.html">Connector</a> class handles outgoing
connections
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000155">handle_close</a>
<a href="#M000154">init</a>
<a href="#M000153">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000153" class="method-detail">
<a name="M000153"></a>
<div class="method-heading">
<a href="#M000153" class="method-signature">
<span class="method-name">new</span><span class="method-args">(server, address)</span>
</a>
</div>
<div class="method-description">
<p>
Create a <a href="Connector.html#M000153">new</a> <a
href="Connector.html">Connector</a> object
</p>
<dl>
<dt><tt>server</tt></dt><dd>The reactor this <a href="Connector.html">Connector</a> is associated with.
</dd>
<dt><tt>address</tt></dt><dd>The address to connect to.
</dd>
<dt><tt>returns</tt></dt><dd>An <a href="Connector.html">Connector</a> object
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000153-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/connector.rb, line 30</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">address</span>)
<span class="ruby-ivar">@address</span> = <span class="ruby-identifier">address</span>
<span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">server</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000155" class="method-detail">
<a name="M000155"></a>
<div class="method-heading">
<a href="#M000155" class="method-signature">
<span class="method-name">handle_close</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Connector.html#M000155">handle_close</a> is called when a close
event occurs for this <a href="Connector.html">Connector</a>.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000155-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000155-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/connector.rb, line 60</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handle_close</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"Connector#handle_close"</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">$!</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000154" class="method-detail">
<a name="M000154"></a>
<div class="method-heading">
<a href="#M000154" class="method-signature">
<span class="method-name">init</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Connector.html#M000154">init</a> is called before using the <a
href="Connector.html">Connector</a>
</p>
<dl>
<dt><tt>returns</tt></dt><dd>true is acceptor is properly initialized
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000154-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000154-source">
<pre>
<span class="ruby-comment cmt"># File lib/network/connector.rb, line 37</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">init</span>
<span class="ruby-comment cmt"># Open a socket for the server to connect on.</span>
<span class="ruby-ivar">@sock</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@address</span> , <span class="ruby-ivar">@server</span>.<span class="ruby-identifier">port</span>)
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">setsockopt</span>(<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_REUSEADDR</span>, <span class="ruby-keyword kw">true</span>)
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">setsockopt</span>(<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOL_SOCKET</span>, <span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SO_LINGER</span>, <span class="ruby-keyword kw">false</span>)
<span class="ruby-keyword kw">unless</span> <span class="ruby-constant">RUBY_PLATFORM</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/win32/</span>
<span class="ruby-ivar">@sock</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_SETFL</span>, <span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">c</span> = <span class="ruby-constant">Connection</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@server</span>, <span class="ruby-ivar">@sock</span>)
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">init</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"(#{c.object_id}) Connection made."</span>
<span class="ruby-identifier">publish</span>(<span class="ruby-identifier">c</span>)
<span class="ruby-keyword kw">true</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"Connector#init"</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>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>