Michael Stapelberg > AnyEvent-XMPP-0.53 > AnyEvent::XMPP::Ext

Download:
AnyEvent-XMPP-0.53.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source   Latest Release: AnyEvent-XMPP-0.55

NAME ^

AnyEvent::XMPP::Ext - Extension baseclass and documentation

DESCRIPTION ^

This module also has documentation about the supported extensions and also is a base class for all extensions that can be added via the add_extension method of the classes that derive from AnyEvent::XMPP::Extendable. (That are: AnyEvent::XMPP::Client, AnyEvent::XMPP::Connection and AnyEvent::XMPP::IM::Connection)

Methods ^

disco_feature

This method can be overwritten by the extension and should return a list of namespace URIs of the features that the extension enables.

Supportet extensions ^

This is the list of supported XMPP extensions:

XEP-0004 - Data Forms (Version 2.8)

This extension handles data forms as described in XEP-0004. AnyEvent::XMPP::Ext::DataForm allows you to construct, receive and answer data forms. This is neccessary for all sorts of things in XMPP. For example XEP-0055 (Jabber Search) or also In-band registration.

XEP-0030 - Service Discovery (Version 2.3)

This extension allows you to send service discovery requests and define a set of discoverable information. See also AnyEvent::XMPP::Ext::Disco.

XEP-0054 - vcard-temp (Version 1.1)

This extension allows the retrieval and storage of XMPP vcards as defined in XEP-0054. It is implemented by AnyEvent::XMPP::Ext::VCard.

XEP-0066 - Out of Band Data (Version 1.5)

This extension allows to receive and send out of band data URLs and provides helper functions to handle jabber:x:oob data. See also AnyEvent::XMPP::Ext::OOB.

XEP-0077 - In-Band Registration (Version 2.2)

This extension lets you register new accounts "in-band". For details please take a look at AnyEvent::XMPP::Ext::Registration.

XEP-0078 - Non-SASL Authentication (Version 2.3)

After lots of sweat and curses I implemented finally iq auth. Unfortunately the XEP-0078 specifies things that are not implemented, in fact the only server that worked was openfire and psyced.org.

So I de-analyzed the iq auth and now it just barfs the IQ set out on the stream with the username and the password.

If you insist on XEP-0078 behaviour enable the anal_iq_auth option when creating the stream.

You can also completely disable iq auth, well, just see the documentation of AnyEvent::XMPP::Connection

XEP-0082 - XMPP Date and Time Profiles (Version 1.0)

Implemented some functions to deal with XMPP timestamps, see AnyEvent::XMPP::Util to_xmpp_time, to_xmpp_datetime, from_xmpp_datetime.

They are meant as simple formatters for you, you will still need to handle timezone stuff and such yourself.

XEP-0086 - Error Condition Mappings (Version 1.0)
   "A mapping to enable legacy entities to correctly handle errors from XMPP-aware entities."

This extension will enable sending of the old error codes when generating a stanza error with for example the write_error_tag method of AnyEvent::XMPP::Writer.

Also if only the old numeric codes are supplied the AnyEvent::XMPP::Error::Stanza class tries to map the numeric codes to the new error conditions if possible.

XEP-0091 - Delayed Delivery (Version 1.3)

See also XEP-0203 below.

XEP-0092 - Software Version (Version 1.1)

The ability to answer to software version, name and operating system requests and being able to send such requests is implemented in AnyEvent::XMPP::Ext::Version.

XEP-0114 - Jabber Component Protocol (Version 1.5)

This extension allows you to connect to a server as a component and makes it possible to implement services like pubsub, muc, or whatever you can imagine (even gateways). See documentation of AnyEvent::XMPP::Component and the example samples/simple_component.

XEP-0153 - vCard-Based Avatars (Version 1.0)

This extension allows to store and retrive avatars from vcards. On top of that it will also signal others that you support avatars and that they might have changed. See AnyEvent::XMPP::Ext::VCard.

XEP-0199 - XMPP Ping (Version 1.0)

You can send ping requests to other entities and also are able to reply to them. On top of that the AnyEvent::XMPP::Ext::Ping extension implements a connection timeout mechanism based on this.

XEP-0203 - Delayed Delivery (Version 1.0)

Both delayed delivery XEPs are supported and are implemented by AnyEvent::XMPP::IM::Delayed which is a super class of AnyEvent::XMPP::IM::Message and AnyEvent::XMPP::IM::Presence.

If you need to fetch delay from stanzas you caught yourself in an event you can use a AnyEvent::XMPP::IM::Delayed object to parse/fetch the delay out of the AnyEvent::XMPP::Node.

Use the functions described above in the XEP-0082 item to decode the timestamps of delays.

AUTHOR ^

Robin Redeker, <elmex at ta-sa.org>, JID: <elmex at jabber.org>

COPYRIGHT & LICENSE ^

Copyright 2007, 2008 Robin Redeker, all rights reserved.

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

syntax highlighting: