<?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: DebugFilter</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">DebugFilter</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/network/protocol/debugfilter_rb.html"> lib/network/protocol/debugfilter.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="5,101,93,149" href="DebugFilter.html" alt="DebugFilter " /> <area shape="rect" coords="13,5,85,53" href="Filter.html" alt="Filter " /> </map> <img src="../dot/f_32.png" usemap="#map" border="0" alt="dot/f_32.png"> </div> <div id="description"> <p> The <a href="DebugFilter.html">DebugFilter</a> class simply logs all that passes through it </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000198">filter_in</a> <a href="#M000199">filter_out</a> <a href="#M000197">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-M000197" class="method-detail"> <a name="M000197"></a> <div class="method-heading"> <a href="#M000197" 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('M000197-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000197-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/debugfilter.rb, line 26</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">pstack</span>) <span class="ruby-keyword kw">super</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-M000198" class="method-detail"> <a name="M000198"></a> <div class="method-heading"> <a href="#M000198" 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="DebugFilter.html#M000198">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('M000198-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000198-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/debugfilter.rb, line 33</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filter_in</span>(<span class="ruby-identifier">str</span>) <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"(#{@pstack.conn.object_id}) INPUT #{str.inspect}"</span> ) <span class="ruby-identifier">str</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000199" class="method-detail"> <a name="M000199"></a> <div class="method-heading"> <a href="#M000199" 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="DebugFilter.html#M000199">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('M000199-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000199-source"> <pre> <span class="ruby-comment cmt"># File lib/network/protocol/debugfilter.rb, line 42</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filter_out</span>(<span class="ruby-identifier">str</span>) <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"(#{@pstack.conn.object_id}) OUTPUT #{str.inspect}"</span> ) <span class="ruby-identifier">str</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>