Mark A. Hershberger > POE-Component-Jabber-1.0 > POE::Component::Jabber::Client::Legacy

Download:
POE-Component-Jabber-1.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Module Version: 1.0   Source  

NAME ^

POE::Component::Jabber::Client::Legacy - A POE Component for communicating over Jabber

SYNOPSIS ^

 use POE qw/ Component::Jabber::Client::Legacy Component::Jabber::Error /;
 use POE::Filter::XML::Node;
 use POE::Filter::XML::NS qw/ :JABBER :IQ /;

 POE::Component::Jabber::Client::Legacy->new(
   IP => 'jabber.server',
   PORT => '5222'
   HOSTNAME => 'jabber.server',
   USERNAME => 'username',
   PASSWORD => 'password',
   ALIAS => 'POCO',
   STATE_PARENT => 'My_Session',
   STATES => {
         INITFINISH => 'My_Init_Finished',
         INPUTEVENT => 'My_Input_Handler',
         ERROREVENT => 'My_Error_Handler',
   }
 );
 
 $poe_kernel->post('POCO', 'output_handler, $node);
 $poe_kernel->post('POCO', 'return_to_sender', $node);

DESCRIPTION ^

POE::Component::Jabber::Client::Legacy is a simple connection broker to enable communication using the legacy Jabber protocol prior to the IETF Proposed Standard XMPP. All of the steps to initiate the connection and authenticate inband with plain text or DIGEST-SHA1 are handled for the end developer. Once INITFINISH is fired the developer has a completed Jabber connection for which to send either raw XML or POE::Filter::XML::Nodes.

METHODS ^

new()

Accepts many arguments:

IP

The IP address in dotted quad, or the FQDN for the server.

PORT

The remote port of the server to connect.

HOSTNAME

The hostname of the server. Used in addressing.

USERNAME

The username to be used in inband authentication.

PASSWORD

The password to be used in inband authentication.

RESOURCE

The resource used in inband authentiation and addressing.

PLAINTEXT

If bool true, sends the password as plain text over the wire.

ALIAS

The alias the component should register for use within POE. Defaults to the class name.

STATE_PARENT

The alias or session id of the session you want the component to contact.

STATES

A hashref containing the event names the component should fire upon finishing initialization and receiving input from the server.

INITFINISH, INPUTEVENT, and ERROREVENT must be defined.

INITFINISH is fired after connection setup and authentication.

ARG0 in INITFINISH will be your jid as a string. ARG0 in INPUTEVENT will be the payload as a POE::Filter::XML::Node. ARG0 in ERROREVENT will be a POE::Component::Jabber::Error

See POE::Component::Jabber::Error for possible error types and constants.

See POE::Filter::XML and its accompanying documentation to properly manipulate incoming data in your INPUTEVENT, and creation of outbound data.

DEBUG

If bool true, will enable debugging and tracing within the component. All XML sent or received through the component will be printed to STDERR

EVENTS ^

'output_handler'

This is the event that you use to push data over the wire. Accepts either raw XML or POE::Filter::XML::Nodes.

'return_to_sender'

This event takes (1) a POE::Filter::XML::Node and gives it a unique id, and (2) a return event and places it in the state machine. Upon receipt of response to the request, the return event is fired with the response packet.

'shutdown_socket'

One argument, time in seconds to call shutdown on the underlying Client::TCP

NOTES AND BUGS ^

This is a connection broker. We are not going to wipe your ass for you :)

AUTHOR ^

Copyright (c) 2003, 2004 Nicholas Perez. Distributed under the GPL.

syntax highlighting: