Sébastien Aperghis-Tramoni > POE-Component-Client-BigBrother > POE::Component::Client::BigBrother

Download:
POE-Component-Client-BigBrother-1.00.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.00   Source  

NAME ^

POE::Component::Client::BigBrother - a POE Component for sending Big Brother commands

VERSION ^

Version 0.01

SYNOPSIS ^

    use strict;
    use POE qw< Component::Client::BigBrother >;

    POE::Session->create(
        inline_states => {
            _start => sub {
                POE::Component::Client::BigBrother->send(
                    host    => $bbhost,
                    event   => "_result",
                    command_type    => "status",
                    command_fields  => {
                        host        => "front01.domain.net",
                        service     => "cpu",
                        color       => "red",
                        message     => "load average is 105.45",
                    },
                );
            },
            _result => sub {
                my $result = $_[ARG0];
            },
        },
    );

DESCRIPTION ^

POE::Component::Client::BigBrother is a POE component which can be used to send commands to a Big Brother server.

This module tries to follow POE::Component::Client::NSCA API whenever possible.

METHODS ^

send()

Parameters

COMMANDS ^

status and page commands

disable command

enable command

event command

OUTPUT EVENT ^

This event is generated by the component. ARG0 will be a hash reference with the following keys:

DIAGNOSTICS ^

'%' command requires a '%' field

(E) The caller did not provide the indicated field for the given command.

%s requires a '%s' parameter

(E) The caller did not provide the indicated parameter to the component.

Could not resolve 'session' to a valid POE session

(E) The value of the given session parameter could not be resolved to a running POE session.

Unknown command type '%'

(E) An illegal value was given for the command_type parameter.

AUTHOR ^

Sébastien Aperghis-Tramoni, <sebastien at aperghis.net>

BUGS ^

Please report any bugs or feature requests to bug-poe-component-client-bigbrother at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Dist/Display.html?Name=POE-Component-Client-BigBrother. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc POE::Component::Client::BigBrother

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2010 Sébastien Aperghis-Tramoni.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: