.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DJabberd::Component::Node 3" .TH DJabberd::Component::Node 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME DJabberd::Component::Node \- Specialization of DJabberd::Agent::Node that knows it belongs to a component .SH DESCRIPTION .IX Header "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. .SH SYNOPSIS .IX Header "SYNOPSIS" Create your node class as a subclass of this class: .PP .Vb 2 \& 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("Hello. I\*(Aqm a software agent."); \& $response\->deliver($vhost); \& } .Ve .PP The class can then be instantiated from inside a method in a DJabberd::Component instance: .PP .Vb 5 \& # $self here is a DJabberd::Component object \& my $node = MyPackage::DJabberd::MyNode\->new( \& component => $self, \& nodename => "bob", \& ); .Ve .PP The above created instance will accept stanzas addressed to the node "bob" inside the domain owned by the given component. .PP It is not possible to directly use subclasses of this class as delivery plugins, since they must be associated with a component at runtime. .SH "SEE ALSO" .IX Header "SEE ALSO" See also DJabberd::Agent::Node, DJabberd::Component. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2008 Martin Atkins .PP This module is part of the DJabberd distribution and is covered by the distribution's overall licence.