<?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: Filter</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">Filter</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/network/protocol/filter_rb.html"> lib/network/protocol/filter.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="Filter.html" alt="Filter " /> </map> <img src="../dot/f_33.png" usemap="#map" border="0" alt="dot/f_33.png"> </div> <div id="description"> <p> The <a href="Filter.html">Filter</a> class is an abstract class defining the minimal methods needed to filter data. </p> <p> A <a href="Filter.html">Filter</a> can keep state and partial data </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000195">filter_in</a> <a href="#M000196">filter_out</a> <a href="#M000194">init</a> <a href="#M000193">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-M000193" class="method-detail"> <a name="M000193"></a> <div class="method-heading"> <a href="#M000193" class="method-signature"> <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> <p><a class="source-toggle" href="#" onclick="toggleCode('M000193-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000193-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/filter.rb, line 24</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">pstack</span>) <span class="ruby-ivar">@pstack</span> = <span class="ruby-identifier">pstack</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000195" class="method-detail"> <a name="M000195"></a> <div class="method-heading"> <a href="#M000195" class="method-signature"> <span class="method-name">filter_in</span><span class="method-args">(str)</span> </a> </div> <div class="method-description"> <p> The <a href="Filter.html#M000195">filter_in</a> method filters input 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> <p><a class="source-toggle" href="#" onclick="toggleCode('M000195-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000195-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/filter.rb, line 37</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filter_in</span>(<span class="ruby-identifier">str</span>) <span class="ruby-identifier">str</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000196" class="method-detail"> <a name="M000196"></a> <div class="method-heading"> <a href="#M000196" class="method-signature"> <span class="method-name">filter_out</span><span class="method-args">(str)</span> </a> </div> <div class="method-description"> <p> The <a href="Filter.html#M000196">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> <p><a class="source-toggle" href="#" onclick="toggleCode('M000196-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000196-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/filter.rb, line 44</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filter_out</span>(<span class="ruby-identifier">str</span>) <span class="ruby-identifier">str</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000194" class="method-detail"> <a name="M000194"></a> <div class="method-heading"> <a href="#M000194" class="method-signature"> <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> <p><a class="source-toggle" href="#" onclick="toggleCode('M000194-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000194-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/filter.rb, line 30</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">init</span>(<span class="ruby-identifier">args</span>=<span class="ruby-keyword kw">nil</span>) <span class="ruby-keyword kw">true</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>