.\" -*- 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 "AnyEvent::XMPP::Ext::Pubsub 3" .TH AnyEvent::XMPP::Ext::Pubsub 3 2024-07-13 "perl v5.38.2" "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 AnyEvent::XMPP::Ext::Pubsub \- Implements XEP\-0060: Publish\-Subscribe .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& my $con = AnyEvent::XMPP::Connection\->new (...); \& $con\->add_extension (my $ps = AnyEvent::XMPP::Ext::Pubsub\->new); \& ... .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module implements all tasks of handling the publish subscribe mechanism. (partially implemented) .SH METHODS .IX Header "METHODS" .IP \fBnew\fR 4 .IX Item "new" This is the constructor for a pubsub object. It takes no further arguments. .ie n .IP "\fBdelete_node($con, \fR\fB$uri\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $cb is the callback" 4 .el .IP "\fBdelete_node($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$cb\fR is the callback" 4 .IX Item "delete_node($con, $uri, $cb) $con is the connection already established, $uri is the name of the node to be created $cb is the callback" Try to remove a node. .ie n .IP "\fBcreate_node ($con, \fR\fB$uri\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $cb is the callback" 4 .el .IP "\fBcreate_node ($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$cb\fR is the callback" 4 .IX Item "create_node ($con, $uri, $cb) $con is the connection already established, $uri is the name of the node to be created $cb is the callback" Try to create a node. .ie n .IP "\fBsubscribe_node($con, \fR\fB$uri\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $cb is the callback" 4 .el .IP "\fBsubscribe_node($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$cb\fR is the callback" 4 .IX Item "subscribe_node($con, $uri, $cb) $con is the connection already established, $uri is the name of the node to be created $cb is the callback" Try to retrieve items. .ie n .IP "\fBunsubscribe_node\fR($con, $uri, $bc)> $con is the connection already established, $uri is the name of the node to be created $cb is the callback" 4 .el .IP "\fBunsubscribe_node\fR($con, \f(CW$uri\fR, \f(CW$bc\fR)> \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$cb\fR is the callback" 4 .IX Item "unsubscribe_node($con, $uri, $bc)> $con is the connection already established, $uri is the name of the node to be created $cb is the callback" Try to unsubscribe from a node. .ie n .IP "\fBpublish_item($con, \fR\fB$uri\fR\fB, \fR\fB$create_cb\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $create_cb is the callback $cb is the callback" 4 .el .IP "\fBpublish_item($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$create_cb\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$create_cb\fR is the callback \f(CW$cb\fR is the callback" 4 .IX Item "publish_item($con, $uri, $create_cb, $cb) $con is the connection already established, $uri is the name of the node to be created $create_cb is the callback $cb is the callback" Try to publish an item. .ie n .IP "\fBretrive_items($con, \fR\fB$uri\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $cb is the callback" 4 .el .IP "\fBretrive_items($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$cb\fR is the callback" 4 .IX Item "retrive_items($con, $uri, $cb) $con is the connection already established, $uri is the name of the node to be created $cb is the callback" Try to retrieve items. .ie n .IP "\fBretrive_item($con, \fR\fB$uri\fR\fB, \fR\fB$id\fR\fB, \fR\fB$cb\fR\fB)\fR $con is the connection already established, $uri is the name of the node to be created $id is the id of the entry to be retrieved $cb is the cb" 4 .el .IP "\fBretrive_item($con, \fR\f(CB$uri\fR\fB, \fR\f(CB$id\fR\fB, \fR\f(CB$cb\fR\fB)\fR \f(CW$con\fR is the connection already established, \f(CW$uri\fR is the name of the node to be created \f(CW$id\fR is the id of the entry to be retrieved \f(CW$cb\fR is the cb" 4 .IX Item "retrive_item($con, $uri, $id, $cb) $con is the connection already established, $uri is the name of the node to be created $id is the id of the entry to be retrieved $cb is the cb" Try to retrieve item. .SH AUTHOR .IX Header "AUTHOR" Robin Redeker, \f(CW\*(C`\*(C'\fR, JID: \f(CW\*(C`\*(C'\fR .SH CONTRIBUTORS .IX Header "CONTRIBUTORS" Chris Miceli \- additional work on the pubsub extension .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2007, 2008 Robin Redeker, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.