/ 
Agent-TCLI-0.032
River stage one • 1 direct dependent • 1 total dependent
/ Agent::TCLI::Package::XMPP

NAME

Agent::TCLI::Package::XMPP - A package of commands to access the XMPP transport

SYNOPSIS

# Within a TCLI Agent script

use Agent::TCLI::Transport::XMPP;
use Agent::TCLI::Package::XMPP;

my @packages = (
	Agent::TCLI::Package::XMPP->new(),
);

Agent::TCLI::Transport::XMPP->new(
    'control_options'	=> {
	    'packages' 		=> \@packages,
     },
);

DESCRIPTION

This package provides commands for the control of the XMPP Transport from within a TLCI Agent. One would typically want to have this command package loaded when using the XMPP Transport, but it is not required.

This is still poorly documented. I apologize for the inconvenience.

INTERFACE

ATTRIBUTES

The following attributes are accessible through standard <attribute> methods unless otherwise noted.

These attrbiutes are generally internal and are probably only useful to someone trying to enhance the functionality of this Package module.

METHODS

Most of these methods are for internal use within the TCLI system and may be of interest only to developers trying to enhance TCLI.

new ( hash of attributes )

Usually the only attributes that are useful on creation are the verbose and do_verbose attrbiutes that are inherited from Agent::TCLI::Base.

peer

This POE event handler executes the peer commands.

change

This POE event handler executes the change command.

show

This POE event handler executes the show commands.

shutdown

This POE event handler executes the shutdown command.

start

This POE event handler executes the start command. It is not exactly clear when this would be useful currently, but we have a shutdown command and balance must be maintained. Hopefully other transports will be available in the future and this command might be more useful.

INHERITED METHODS

This module is an Object::InsideOut object that inherits from Agent::TCLI::Package::Base. It inherits methods from both. Please refer to their documentation for more details.

AUTHOR

Eric Hacker <hacker at cpan.org>

BUGS

Test scripts not thorough enough.

Probably many others.

LICENSE

Copyright (c) 2007, Alcatel Lucent, All rights resevred.

This package is free software; you may redistribute it and/or modify it under the same terms as Perl itself.