Class Mongrel::HttpParser
In: ext/http11/http11.c
Parent: Object

call-seq: 

   uc.resolve("/someuri") -> "/someuri", "", handler
   uc.resolve("/someuri/pathinfo") -> "/someuri", "/pathinfo", handler
   uc.resolve("/notfound/orhere") -> nil, nil, nil
   uc.resolve("/") -> "/", "/", handler  # if uc.register("/", handler)
   uc.resolve("/path/from/root") -> "/", "/path/from/root", handler  # if uc.register("/", handler)

Attempts to resolve either the whole URI or at the longest prefix, returning the prefix (as script_info), path (as path_info), and registered handler (usually an HttpHandler). If it doesn‘t find a handler registered at the longest match then it returns nil,nil,nil.

Because the resolver uses a trie you are able to register a handler at any character in the URI and it will be handled as long as it‘s the longest prefix. So, if you registered handler 1 at "/something/lik", and 2 at "/something/like/that", then a a search for "/something/like" would give you 1. A search for "/something/like/that/too" would give you 2.

This is very powerful since it means you can also attach handlers to parts of the ; (semi-colon) separated path params, any part of the path, use off chars, anything really. It also means that it‘s very efficient to do this only taking as long as the URI has characters.

A slight modification to the CGI 1.2 standard is given for handlers registered to "/". CGI expects all CGI scripts to be at some script path, so it doesn‘t really say anything about a script that handles the root. To make this work, the resolver will detect that the requested handler is at "/", and return that for script_name, and then simply return the full URI back as path_info.

It expects strings with no embedded ’\0’ characters. Don‘t try other string-like stuff yet.

Methods

error?   execute   finish   finished?   new   nread   reset  

Public Class methods

parser.new → parser

Creates a new parser.

Public Instance methods

parser.error? → true/false

Tells you whether the parser is in an error state.

parser.execute(req_hash, data, start) → Integer

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.

This function now throws an exception when there is a parsing error. This makes the logic for working with the parser much easier. You can still test for an error, but now you need to wrap the parser with an exception handling block.

The third argument allows for parsing a partial request and then continuing the parsing from that position. It needs all of the original data as well so you have to append to the data buffer as you read.

parser.finish → true/false

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.

parser.finished? → true/false

Tells you whether the parser is finished or not and in a good state.

parser.nread → Integer

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.

parser.reset → nil

Resets the parser to it‘s initial state so that you can reuse it rather than making new ones.

[Validate]