<?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: TerminalFilter</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">TerminalFilter</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/network/protocol/terminalfilter_rb.html">
lib/network/protocol/terminalfilter.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Filter.html">
Filter
</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="105,113,196,161" href="TerminalFilter.html" alt="TerminalFilter
">
<area shape="RECT" coords="7,17,84,65" href="ASCIICodes.html" alt="ASCIICodes
">
<area shape="RECT" coords="108,17,193,65" href="VT100Codes.html" alt="VT100Codes
">
<area shape="RECT" coords="217,17,289,65" href="Filter.html" alt="Filter
">
</map>
<img src="../dot/f_40.png" usemap="#map" border=0 alt="TopLevel">
</div>
<div id="description">
<p>
The <a href="TerminalFilter.html">TerminalFilter</a> class implements a
subset of ANSI/VT100 protocol.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000289">echo</a>
<a href="#M000290">execute</a>
<a href="#M000287">filter_in</a>
<a href="#M000288">filter_out</a>
<a href="#M000286">init</a>
<a href="#M000291">mode?</a>
<a href="#M000285">new</a>
<a href="#M000292">set_mode</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="ASCIICodes.html">ASCIICodes</a></span>
<span class="include-name"><a href="VT100Codes.html">VT100Codes</a></span>
</div>
</div>
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000285" class="method-detail">
<a name="M000285"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000285.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000285.html');return false;">
<span class="method-name">new</span><span class="method-args">(pstack)</span>
</a>
</div>
<div class="method-description">
<p>
Construct filter
</p>
<dl>
<dt><tt>pstack</tt></dt><dd>The <a href="ProtocolStack.html">ProtocolStack</a> associated with this
filter
</dd>
</dl>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000289" class="method-detail">
<a name="M000289"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000289.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000289.html');return false;">
<span class="method-name">echo</span><span class="method-args">(ch)</span>
</a>
</div>
<div class="method-description">
<p>
Handle server-side echo
</p>
</div>
</div>
<div id="method-M000290" class="method-detail">
<a name="M000290"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000290.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000290.html');return false;">
<span class="method-name">execute</span><span class="method-args">(b)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000287" class="method-detail">
<a name="M000287"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000287.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000287.html');return false;">
<span class="method-name">filter_in</span><span class="method-args">(str)</span>
</a>
</div>
<div class="method-description">
<p>
The <a href="TerminalFilter.html#M000287">filter_in</a> method filters out
VTxx terminal data and inserts format strings into the input stream.
</p>
<dl>
<dt><tt>str</tt></dt><dd>The string to be processed
</dd>
<dt><tt>return</tt></dt><dd>The filtered data
</dd>
</dl>
</div>
</div>
<div id="method-M000288" class="method-detail">
<a name="M000288"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000288.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000288.html');return false;">
<span class="method-name">filter_out</span><span class="method-args">(str)</span>
</a>
</div>
<div class="method-description">
<p>
The <a href="TerminalFilter.html#M000288">filter_out</a> method filters
output data
</p>
<dl>
<dt><tt>str</tt></dt><dd>The string to be processed
</dd>
<dt><tt>return</tt></dt><dd>The filtered data
</dd>
</dl>
</div>
</div>
<div id="method-M000286" class="method-detail">
<a name="M000286"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000286.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000286.html');return false;">
<span class="method-name">init</span><span class="method-args">(args=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Run any post-contruction initialization
</p>
<dl>
<dt><tt>args</tt></dt><dd>Optional initial options
</dd>
</dl>
</div>
</div>
<div id="method-M000291" class="method-detail">
<a name="M000291"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000291.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000291.html');return false;">
<span class="method-name">mode?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Get current parse mode
</p>
<dl>
<dt><tt>return</tt></dt><dd>The current parse mode
</dd>
</dl>
</div>
</div>
<div id="method-M000292" class="method-detail">
<a name="M000292"></a>
<div class="method-heading">
<a href="TerminalFilter.src/M000292.html" target="Code" class="method-signature"
onclick="popupCode('TerminalFilter.src/M000292.html');return false;">
<span class="method-name">set_mode</span><span class="method-args">(m)</span>
</a>
</div>
<div class="method-description">
<p>
set current parse mode
</p>
<dl>
<dt><tt>m</tt></dt><dd>Mode to set it to
</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>
