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

Download:
XAS-0.04.tar.gz

Dependencies

Annotate this POD

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

NAME ^

XAS::Collector::Factory - A factory method to load collector processors

SYNOPSIS ^

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

 my $collectors = XAS::Collector::Factory->load(
    -connector => 'connector',
    -logger    => 'logger',
    -configs   => 'collectors.ini'
 );

DESCRIPTION ^

This module will take a configuration file and starts all the collectors defined within.

Configuration File

The configuraton file has the following cavets:

o Item names are case sensitve.
o A ";" indicates the start of a comment.
o The section header must be unique and start with "collector:".

The file format follows the familiar Win32 .ini format.

  ; My configuration file
  ;
  [collector: alert]
  alias = alert
  queue = /queue/alert
  packet-type = xas-alert
  module = XAS::Collector::Alert

Configuration Items

alias

The alias for the POE Session.

packet-type

The XAS packet type. Defaults to 'unknown'.

module

The module to load to handle this packet type.

queue

The queue to listen on for packets. Defaults to '/queue/xas'.

METHODS ^

load

This loads the configuration file and starts the collectors.

ACCESSORS ^

collectors

Returns a list of collectors.

queues

Returns a list of queues that will be listened on.

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: