<?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: ProtocolStack</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">ProtocolStack</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/protocol/protocolstack_rb.html">
lib/network/protocol/protocolstack.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="57,17,151,65" href="ProtocolStack.html" alt="ProtocolStack
">
</map>
<img src="../dot/f_37.png" usemap="#map" border=0 alt="TopLevel">
</div>
<div id="description">
<p>
The <a href="ProtocolStack.html">ProtocolStack</a> class implements a stack
of input and output filters. It also maintains some interesting state
variables that are shared amongst filters.
</p>
<table>
<tr><td valign="top">Remarks:</td><td>This should have its own configuration file.
</td></tr>
</table>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000294">filter_call</a>
<a href="#M000293">new</a>
<a href="#M000295">query</a>
<a href="#M000296">set</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">binary_on</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">color_on</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">conn</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">echo_on</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">eorec_on</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">hide_on</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">terminal</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">theight</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">twidth</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">urgent_on</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">zmp_on</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-M000293" class="method-detail">
<a name="M000293"></a>
<div class="method-heading">
<a href="ProtocolStack.src/M000293.html" target="Code" class="method-signature"
onclick="popupCode('ProtocolStack.src/M000293.html');return false;">
<span class="method-name">new</span><span class="method-args">(conn)</span>
</a>
</div>
<div class="method-description">
<p>
Construct a <a href="ProtocolStack.html">ProtocolStack</a>
</p>
<dl>
<dt><tt>conn</tt></dt><dd>The connection associated with this filter
</dd>
</dl>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000294" class="method-detail">
<a name="M000294"></a>
<div class="method-heading">
<a href="ProtocolStack.src/M000294.html" target="Code" class="method-signature"
onclick="popupCode('ProtocolStack.src/M000294.html');return false;">
<span class="method-name">filter_call</span><span class="method-args">(method, args)</span>
</a>
</div>
<div class="method-description">
<p>
A method is called on each filter in the stack in order.
</p>
<p>
[<tt>method</tt>] [<tt>args</tt>]
</p>
</div>
</div>
<div id="method-M000295" class="method-detail">
<a name="M000295"></a>
<div class="method-heading">
<a href="ProtocolStack.src/M000295.html" target="Code" class="method-signature"
onclick="popupCode('ProtocolStack.src/M000295.html');return false;">
<span class="method-name">query</span><span class="method-args">(attr)</span>
</a>
</div>
<div class="method-description">
<p>
The filter_query method returns state information for the filter.
</p>
<dl>
<dt><tt>attr</tt></dt><dd>A symbol representing the attribute being queried.
</dd>
<dt><tt>return</tt></dt><dd>An attr/value pair or false if not defined in this filter
</dd>
</dl>
</div>
</div>
<div id="method-M000296" class="method-detail">
<a name="M000296"></a>
<div class="method-heading">
<a href="ProtocolStack.src/M000296.html" target="Code" class="method-signature"
onclick="popupCode('ProtocolStack.src/M000296.html');return false;">
<span class="method-name">set</span><span class="method-args">(attr, value)</span>
</a>
</div>
<div class="method-description">
<p>
The filter_set method sets state information on the filter.
</p>
<dl>
<dt><tt>pair</tt></dt><dd>An attr/value pair [:symbol, value]
</dd>
<dt><tt>return</tt></dt><dd>true if attr not defined in this filter, false if not
</dd>
</dl>
</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>
