Martin Atkins > DJabberd > DJabberd::Component::Node

Download:
DJabberd-0.85.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  6
Open  0
View/Report Bugs
Source  

NAME ^

DJabberd::Component::Node - Specialization of DJabberd::Agent::Node that knows it belongs to a component

DESCRIPTION ^

This abstract class is a specialization of DJabberd::Agent::Node. The only difference between this class and its parent is that nodes represented by this class "know" that they belong to a component and have a reference to that component stored.

SYNOPSIS ^

Create your node class as a subclass of this class:

    package MyPackage::DJabberd::MyNode;
    use base DJabberd::Component::Node;
    
    # Example of an agent that responds to incoming chat messages
    
    sub handle_message {
        my ($self, $vhost, $stanza) = @_;
        
        my $response = $stanza->make_response();
        $response->set_raw("<body>Hello. I'm a software agent.</body>");
        $response->deliver($vhost);
    }

The class can then be instantiated from inside a method in a DJabberd::Component instance:

    # $self here is a DJabberd::Component object
    my $node = MyPackage::DJabberd::MyNode->new(
        component => $self,
        nodename => "bob",
    );

The above created instance will accept stanzas addressed to the node "bob" inside the domain owned by the given component.

It is not possible to directly use subclasses of this class as delivery plugins, since they must be associated with a component at runtime.

SEE ALSO ^

See also DJabberd::Agent::Node, DJabberd::Component.

COPYRIGHT ^

Copyright 2007-2008 Martin Atkins

This module is part of the DJabberd distribution and is covered by the distribution's overall licence.

syntax highlighting: