ruleprocessor.specs.txt

JK Proxy Project - Version 0.1 ------------------------------ This was going to be a proxy serve

ruleprocessor.cpp specifications
-------------------------

This a more or less detailled description of what the code in this file
does, how it works and how it should be used.


Overview
--------
The rule processor handles the checking of a match of rules against 
incoming messages. 

There is only one public (exported) function in this module:

CheckMsg()

This function takes two parameters: 
- the first parameter contains the message to be checked, a zero-
  terminated string
- the second parameter is the RULEFILE struct which contains the set of
  rules which shall be used for checking. This struct must be generated
  by LoadRules() in rulefile.cpp before.


How it works
------------
The function CheckMsg() iterates through all rules in the ruleset and
applies them seperately. For string comparision it uses the function
pointer which was saved in the RULEFILE struct for each rule in 
rulefile.cpp.

Additionally this module uses string caching. That is all entitys which
are extracted from the header (e.g. "subject" or "from") are saved in
a cache-map so they don't have to be extracted again. (reading from the
map is way faster then extracting an element).