Maxscape::Daemon::HTTPD Package

Synopsis

use Maxscape::Daemon::HTTPD;

Description

Maxscape::Daemon::HTTPD is the main package of the internal HTTP daemon. It implements the server's main loop, creates the required objects and calls the methods to answer HTTP requests. It is SSL aware and can be configured in forking or a non forking mode.

List of Member Functions

1. askUserPassword
2. AuthenticateViaDB
3. BenchmarkResult
4. checkHostAuthorization
5. checkUserAuthorization
6. closeSocket
7. configure
8. Control
9. detachTerminal
10. Encryption
11. freeSSLContext
12. GetConnection
13. getMimeType
14. getRequest
15. http_date
16. ip_match
17. IsInbuildMimeType
18. logControl
19. mainloop
20. moreClones
21. new
22. newSSLContext
23. PID
24. queryUser
25. readFileHandle
26. reaper
27. registerHostAccessRights
28. responseRequest
29. restartProcess
30. send_plain
31. sendDirectory
32. sendDynamicContent
33. sendError
34. sendFile
35. sendRedirect
36. ServerName
37. ServerSocketTimeout
38. setServerSocket
39. setup
40. setup
41. term_handler
42. to_ipaddress
43. waitEvent
44. write_PID_File
45. writeToAccessLog

Member Functions

new

Synopsis

my $HTTPD = Maxscape::Daemon::HTTPD->new ();

Description

Creates a Maxscape::Daemon::HTTPD object.

configure

Synopsis

my $Value = $HTTPD->configure ();

Description

setup

Synopsis

my $Value = $HTTPD->evaluateVariables ($Text);

Description

Evaluates the embedded variables of a text.

setup

Synopsis

my $Value = $HTTPD->setup ();

Description

Setup of a virtual server.

mainloop

Synopsis

my $Value = $HTTPD->mainloop ();

Description

HTTPD main loop.

waitEvent

Synopsis

my $Value = $HTTPD->waitEvent ();

Description

Waits for an event.

GetConnection

Synopsis

my $Value = $HTTPD->GetConnection ();

Description

Gets a connection to a client.

getRequest

Synopsis

my $Value = $HTTPD->getRequest ();

Description

Gets the request of a client.

responseRequest

Synopsis

my $Value = $HTTPD->responseRequest ();

Description

Responses to a client's request.

sendDynamicContent

Synopsis

my $Value = $HTTPD->sendDynamicContent ();

Description

Sends dynamically generated content to a client. Three gateway interfaces are available. CGI, DSGI, and SGGI. With DCGI an appliction is build into the HTTPD, while with SCGI an own appliction process is used, similar to FCGI.

sendFile

Synopsis

my $Value = $HTTPD->sendFile ();

Description

Sends a reguested file to the client.

sendDirectory

Synopsis

my $Value = $HTTPD->sendDirectory ();

Description

Sends a directory listing to a client.

sendRedirect

Synopsis

my $Value = $HTTPD->sendRedirect ();

Description

Sends a redirect to the client.

sendError

Synopsis

my $Value = $HTTPD->sendError ();

Description

Sends an error to the client. E.g.: if a file is not found.

askUserPassword

Synopsis

my $Value = $HTTPD->askUserPassword ();

Description

Asks a user for a user name and password.

Encryption

Synopsis

my $Value = $HTTPD->Encryption ();

Description

Returns the encryption method (e.g. SSL).

newSSLContext

Synopsis

my $Value = $HTTPD->newSSLContext ();

Description

Creates a SSL context from the SSLCertificateFile and SSLCertificateKeyFile files.

freeSSLContext

Synopsis

my $Value = $HTTPD->freeSSLContext ();

Description

Frees the SSL context.

closeSocket

Synopsis

my $Value = $HTTPD->closeSocket ();

Description

Closes the server socket.

setServerSocket

Synopsis

my $Value = $HTTPD->setServerSocket ();

Description

Setup of the daemon server socket.

IsInbuildMimeType

Synopsis

my $Value = $HTTPD->IsInbuildMimeType ();

Description

Checks if a mime type is buid in.

getMimeType

Synopsis

my $Value = $HTTPD->getMimeType ();

Description

Gets the MIME type of a requested file.

readFileHandle

Synopsis

my $Value = $HTTPD->readFileHandle ();

Description

Reads from a file handle.

ServerName

Synopsis

my $Value = $HTTPD->ServerName ();

Description

Return the Server name.

registerHostAccessRights

Synopsis

my $Value = $HTTPD->registerHostAccessRights ();

Description

Registers the access rights of client hosts. So far, not implemented ok.

to_ipaddress

Synopsis

my $Value = $HTTPD->to_ipaddress ();

Description

To do.

checkHostAuthorization

Synopsis

my $Value = $HTTPD->checkHostAuthorization ();

Description

Checks the client host for authorization rights.

ip_match

Synopsis

my $Value = $HTTPD->ip_match ();

Description

To do.

checkUserAuthorization

Synopsis

my $Value = $HTTPD->checkUserAuthorization ();

Description

Checks the user authorization.

moreClones

Synopsis

my $Value = $HTTPD->moreClones ();

Description

Makes more clones.

detachTerminal

Synopsis

my $Value = $HTTPD->detachTerminal ();

Description

Split from the controlling terminal.

write_PID_File

Synopsis

my $Value = $HTTPD->write_PID_File ();

Description

Writes the PID file.

PID

Synopsis

my $Value = $HTTPD->PID ();

Description

PID of a process.

restartProcess

Synopsis

my $Value = $HTTPD->restartProcess ();

Description

Restarts a prosess.

reaper

Synopsis

my $Value = $HTTPD->reaper ();

Description

To do.

term_handler

Synopsis

my $Value = $HTTPD->term_handler ();

Description

To do.

http_date

Synopsis

my $Value = $HTTPD->http_date ();

Description

To do.

writeToAccessLog

Synopsis

my $Value = $HTTPD->writeToAccessLog ();

Description

To do.

send_plain

Synopsis

my $Value = $HTTPD->send_plain ();

Description

Sends a plain file.

Control

Synopsis

my $Value = $HTTPD->Control ();

Description

To do.

ServerSocketTimeout

Synopsis

my $Value = $HTTPD->ServerSocketTimeout ();

Description

To do.

logControl

Synopsis

my $Value = $HTTPD->logControl ();

Description

To do.

BenchmarkResult

Synopsis

my $Value = $HTTPD->BenchmarkResult ();

Description

To do.

AuthenticateViaDB

Synopsis

my $Value = $HTTPD->AuthenticateViaDB ();

Description

To do.

queryUser

Synopsis

my $Value = $HTTPD->queryUser ();

Description

To do.

1