diff options
Diffstat (limited to 'doc/rdoc/classes/Mongrel/HttpParser.html')
-rw-r--r-- | doc/rdoc/classes/Mongrel/HttpParser.html | 265 |
1 files changed, 265 insertions, 0 deletions
diff --git a/doc/rdoc/classes/Mongrel/HttpParser.html b/doc/rdoc/classes/Mongrel/HttpParser.html new file mode 100644 index 0000000..13cc01c --- /dev/null +++ b/doc/rdoc/classes/Mongrel/HttpParser.html @@ -0,0 +1,265 @@ +<?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: Mongrel::HttpParser</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">Mongrel::HttpParser</td> + </tr> + <tr class="top-aligned-row"> + <td><strong>In:</strong></td> + <td> + <a href="../../files/ext/http11/http11_c.html"> + ext/http11/http11.c + </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> + + <div id="method-list"> + <h3 class="section-bar">Methods</h3> + + <div class="name-list"> + <a href="#M000005">error?</a> + <a href="#M000004">execute</a> + <a href="#M000003">finish</a> + <a href="#M000006">finished?</a> + <a href="#M000001">new</a> + <a href="#M000007">nread</a> + <a href="#M000002">reset</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-M000001" class="method-detail"> + <a name="M000001"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000001.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000001.html');return false;"> + <span class="method-name">parser.new → parser<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Creates a new parser. +</p> + </div> + </div> + + <h3 class="section-bar">Public Instance methods</h3> + + <div id="method-M000005" class="method-detail"> + <a name="M000005"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000005.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000005.html');return false;"> + <span class="method-name">parser.error? → true/false<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Tells you whether the parser is in an error state. +</p> + </div> + </div> + + <div id="method-M000004" class="method-detail"> + <a name="M000004"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000004.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000004.html');return false;"> + <span class="method-name">parser.execute(req_hash, data) → Integer<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Takes a Hash and a String of data, parses the String of data filling in the +Hash returning an Integer to indicate how much of the data has been read. +No matter what the return value, you should call HttpParser#finished? and +HttpParser#error? to figure out if it’s done parsing or there was an +error. +</p> + </div> + </div> + + <div id="method-M000003" class="method-detail"> + <a name="M000003"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000003.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000003.html');return false;"> + <span class="method-name">parser.finish → true/false<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Finishes a parser early which could put in a "good" or bad state. +You should call reset after finish it or bad things will happen. +</p> + </div> + </div> + + <div id="method-M000006" class="method-detail"> + <a name="M000006"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000006.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000006.html');return false;"> + <span class="method-name">parser.finished? → true/false<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Tells you whether the parser is finished or not and in a good state. +</p> + </div> + </div> + + <div id="method-M000007" class="method-detail"> + <a name="M000007"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000007.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000007.html');return false;"> + <span class="method-name">parser.nread → Integer<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Returns the amount of data processed so far during this processing cycle. +It is set to 0 on initialize or reset calls and is incremented each time +execute is called. +</p> + </div> + </div> + + <div id="method-M000002" class="method-detail"> + <a name="M000002"></a> + + <div class="method-heading"> + <a href="HttpParser.src/M000002.html" target="Code" class="method-signature" + onclick="popupCode('HttpParser.src/M000002.html');return false;"> + <span class="method-name">parser.reset → nil<br /> +</span> + </a> + </div> + + <div class="method-description"> + <p> +Resets the parser to it’s initial state so that you can reuse it +rather than making new ones. +</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>
\ No newline at end of file |