Kevin L. Esteb > XAS-0.04 > XAS::Spooler::Factory

Download:
XAS-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source   Latest Release: XAS-0.05

NAME ^

XAS::Spooler::Factory - A factory method to load spool processors

SYNOPSIS ^

This module is used to create multiple spool processeors from a configuration file.

 my $processor = XAS::Spooler::Factory->load(
    -connector => 'connector',
    -logger    => 'logger',
    -config    => 'spools.ini'
 );

DESCRIPTION ^

This module will take a configuration file and start all the spool processeors defined within. The file format follows the familiar Win32 .ini format.

  ; My configuration file
  ;
  [spool:nmon]
  alias = alert
  directory = alerts
  schedule = '*/1 * * * *'
  queue = /queue/xas
  packet-type = xas-alert
o Item names are case sensitve.
o A ";" indicates the start of a comment.
o The section header must be unique and start with "spool:".

These configuration items have corresponding parameters in XAS::Spooler::Processor.

ITEMS

alias

The alias for the POE Session. Defaults to 'spooler'.

directory

The spool directory to monitor. It defaults to the root of the XAS spool directory.

schedule

A cron style schedule to use when scanning the directory. Defaults to '*/1 * * * *'.

packet-type

The DDC packet type. Defaults to 'unknown'.

queue

The queue to send the message too. Defaults to '/queue/xas'.

METHODS ^

load

This loads the configuration file and starts the spool processors.

shutdown

This method will shutdown the spool processors.

stop_scan

This method will stop the scanning process of the spool processors.

start_scan

This method will start the scanning process of the spool processors.

SEE ALSO ^

XAS

AUTHOR ^

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 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.5 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: