<?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: Session</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">Session</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/session_rb.html">
lib/network/session.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="33,113,105,161" href="Session.html" alt="Session
">
<area shape="RECT" coords="33,17,105,65" href="Publisher.html" alt="Publisher
">
</map>
<img src="../dot/f_30.png" usemap="#map" border=0 alt="TopLevel">
</div>
<div id="description">
<p>
The session class is a base class contains the minimum amount of attributes
to reasonably maintain a socket session with a client.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000139">handle_close</a>
<a href="#M000137">handle_input</a>
<a href="#M000140">handle_oob</a>
<a href="#M000138">handle_output</a>
<a href="#M000136">init</a>
<a href="#M000141">is_readable?</a>
<a href="#M000142">is_writable?</a>
<a href="#M000135">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>
<div id="includes-list">
<span class="include-name"><a href="Publisher.html">Publisher</a></span>
</div>
</div>
<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">accepting</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">closing</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">connected</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">sock</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">write_blocked</td>
<td class="context-item-value"> [RW] </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-M000135" class="method-detail">
<a name="M000135"></a>
<div class="method-heading">
<a href="Session.src/M000135.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000135.html');return false;">
<span class="method-name">new</span><span class="method-args">(server, sock=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Create a new session object Used when opening both an acceptor or
connection.
</p>
<dl>
<dt><tt>server</tt></dt><dd>The reactor or connector this session is associated with.
</dd>
<dt><tt>sock</tt></dt><dd>Nil for acceptors or the socket for connections.
</dd>
<dt><tt>returns</tt></dt><dd>A session object.
</dd>
</dl>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000139" class="method-detail">
<a name="M000139"></a>
<div class="method-heading">
<a href="Session.src/M000139.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000139.html');return false;">
<span class="method-name">handle_close</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000139">handle_close</a> is called when a close
event occurs for this session.
</p>
</div>
</div>
<div id="method-M000137" class="method-detail">
<a name="M000137"></a>
<div class="method-heading">
<a href="Session.src/M000137.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000137.html');return false;">
<span class="method-name">handle_input</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000137">handle_input</a> is called when an input
event occurs for this session.
</p>
</div>
</div>
<div id="method-M000140" class="method-detail">
<a name="M000140"></a>
<div class="method-heading">
<a href="Session.src/M000140.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000140.html');return false;">
<span class="method-name">handle_oob</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000140">handle_oob</a> is called when an out of band
data event occurs for this session.
</p>
</div>
</div>
<div id="method-M000138" class="method-detail">
<a name="M000138"></a>
<div class="method-heading">
<a href="Session.src/M000138.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000138.html');return false;">
<span class="method-name">handle_output</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000138">handle_output</a> is called when an output
event occurs for this session.
</p>
</div>
</div>
<div id="method-M000136" class="method-detail">
<a name="M000136"></a>
<div class="method-heading">
<a href="Session.src/M000136.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000136.html');return false;">
<span class="method-name">init</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
init is called before using the session.
</p>
<dl>
<dt><tt>returns</tt></dt><dd>true is session object properly initialized
</dd>
</dl>
</div>
</div>
<div id="method-M000141" class="method-detail">
<a name="M000141"></a>
<div class="method-heading">
<a href="Session.src/M000141.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000141.html');return false;">
<span class="method-name">is_readable?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000141">is_readable?</a> tests if the socket is a
candidate for select read {<tt>return</tt>] true if so, false if not
</p>
</div>
</div>
<div id="method-M000142" class="method-detail">
<a name="M000142"></a>
<div class="method-heading">
<a href="Session.src/M000142.html" target="Code" class="method-signature"
onclick="popupCode('Session.src/M000142.html');return false;">
<span class="method-name">is_writable?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Session.html#M000142">is_writable?</a> tests if the socket is a
candidate for select write {<tt>return</tt>] true if so, false if not
</p>
</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>
