/ 
XAS-0.02
River stage one • 6 direct dependents • 6 total dependents
/ XAS::Monitor::Database

NAME

XAS::Monitor::Database - A Perl extension for the XAS environment

SYNOPSIS

use XAS::Monitor::Database

my $monitor = XAS::Monitor::Database->new(
    -alias     => 'monitor',
    -logger    => 'logger',
    -schedule  => '*/1 * * * *',
);

DESCRIPTION

This module inherits from XAS::Monitor::Base and provides a base class for monitors that monitor items within a databae.

METHODS

new

This method initializes the module and take these three parameters:

-alias

The name of this session.

-logger

The alias for the logger session.

-schedule

The schedule to follow when monitoring. It defaults to: "*/1 * * * *". Which is do something once a minute.

initialize

This method declares the event "monitor" and opens the connection to the database.

cleanup

This method stops the "monitor" processing and closes the database connection.

monitor

The method that does the actual monitoring. By default it does nothing and needs to be overridden. The overridden method takes two parameters:

$kernel

A handle to the POE kernel.

$self

A reference to it's self.

PUBLIC EVENTS

startup

This event schedules the processing of "monitor" with the supplied schedule.

shutdown

This is triggered by a "shutdown" event and calls the cleanup() method.

monitor

This is triggered by the schedule and calls the monitor() method.

SEE ALSO

XAS

AUTHOR

Kevin Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.