Design of CgiEnv

1 Name

Classname: CgiEnv
Declaration:

class CgiEnv
CgiEnv();
~CgiEnv();
..
};

Based On:

cgi/Defs.H

Properties:

CgiEnv is a class designed to contain the data for the CGI-Environment.

2 Purpose

The CgiEnv-class is the class responsible for getting all the data from the environment and parsing them correctly.

3 Description

3.1 Methods

3.1.1 Basic Mathods
void constructor CgiEnv(void )

Description: Retrieves all the data from the environment and initializes all variables.

void destructor ~CgiEnv(void )

Description: Does the tough job and deletes all the material initialized by the constructor.

3.1.2 Public Methods
char *method getPath(void ) const

Description: Returns the environment-variable PATH

const char *method getPathInfo(void ) const

Description: Returns the environment-variable PATHINFO

const char *method getPathTransl(void ) const

Description: Returns the environment-variable PATHTRANSLATED

const char *method getScriptName(void ) const

Description: Returns the environment-variable SCRIPTNAME

const char *method getRemHost(void ) const

Description: Returns the environment-variable REMOTEHOST

const char *method getRemAddr(void ) const

Description: Returns the environment-variable REMOTEADDRESS

const char *method getRemUser(void ) const

Description: Returns the environment-variable REMOTEUSER

const char *method getRemIdent(void ) const

Description: Returns the environment-variable REMOTEIDENT

const char *method getReqMethod(void ) const

Description: Returns the environment-variable REQUESTMETHOD

const char *method getPostData(void ) const

Description: Returns the post-data

const char *method getQueryString(void ) const

Description: Returns the environment-variable QUERY_STRING

const char *method getCookies(void ) const

Description: Returns the cookie-string

const char *method getContentType(void ) const

Description: Returns the environment-variable CONTENT_TYPE

int method getContentLength(void ) const

Description: Returns the environment-variable CONTENT_LENGTH

3.1.3 Protected Methods
int method safeGetEnv(const char *varName, char& *where) const

Description: For internal use only

void method cleanup(char *variable)

Description: For internal use only

4 Maintenance

Information about bugs, errors, problems, etc. should be sent to stig@ii.uib.no

Written by: Stig Erik Sandų
Version: Document created with SDS v0.20