ePages 7.26.0 - DE_EPAGES/Presentation/API/Object/Monitor.pm

Package DE_EPAGES::Presentation::API::Object::Monitor

provides a facility to report status of long-running processes

Base
DE_EPAGES::Core::API::Object::MonitorShared

Functions

finish
new
readResponse
start
writeResponse

finish

Called by run after the main processing funtion has finished if a timeout occured during processing. Updates the monitor status file to redirect the browser to the actual result page.

Syntax
$Monitor->finish;

new

Create a new monitor object, which covers the content pages and is triggered at timeout and response.

Syntax
$Monitor = DE_EPAGES::Presentation::API::Object::Monitor->new( %Options );
Input
%Options (ref.hash)
Return
$Monitor (DE_EPAGES::Presentation::API::Object::Monitor)
Monitor object

readResponse

Updates the given Response object with Response which was saved via writeResponse.

Syntax
DE_EPAGES::Presentation::API::Object::Monitor->readResponse($Response, $GUID);
Input
$Response (object)
HTTP::Response object
$GUID (string)
unique monitor identifier

start

Starts the monitor. Writes the monitor page to the file system and then redirect the Browser to this file.

Syntax
$Monitor->start;

writeResponse

write the given Response to file system. The GUID is the identifier to identify the response later via readResponse.

Syntax
DE_EPAGES::Presentation::API::Object::Monitor->->writeResponse($Response, $GUID);
Input
$Response (object)
HTTP::Response object
$GUID (string)
unique monitor identifier