.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::XMPP 3pm"
.TH Net::XMPP 3pm "2014-04-11" "perl v5.18.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"
Net::XMPP \- XMPP Perl Library
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& Net::XMPP provides a Perl user with access to the Extensible
\& Messaging and Presence Protocol (XMPP).
\&
\& For more information about XMPP visit:
\&
\& http://www.xmpp.org
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 6
\& Net::XMPP is a convenient tool to use for any perl script that would
\& like to utilize the XMPP Instant Messaging protocol. While not a
\& client in and of itself, it provides all of the necessary back\-end
\& functions to make a CGI client or command\-line perl client feasible
\& and easy to use. Net::XMPP is a wrapper around the rest of the
\& official Net::XMPP::xxxxxx packages.
\&
\& There is are example scripts in the example directory that provide you
\& with examples of very simple XMPP programs.
\&
\&
\& NOTE: The parser that XML::Stream::Parser provides, as are most Perl
\& parsers, is synchronous. If you are in the middle of parsing a packet
\& and call a user defined callback, the Parser is blocked until your
\& callback finishes. This means you cannot be operating on a packet,
\& send out another packet and wait for a response to that packet. It
\& will never get to you. Threading might solve this, but as of this
\& writing threading in Perl is not quite up to par yet. This issue will
\& be revisted in the future.
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\& use Net::XMPP;
\& my $client = new Net::XMPP::Client();
.Ve
.SH "METHODS"
.IX Header "METHODS"
.Vb 6
\& The Net::XMPP module does not define any methods that you will call
\& directly in your code. Instead you will instantiate objects that call
\& functions from this module to do work. The three main objects that
\& you will work with are the Message, Presence, and IQ modules. Each one
\& corresponds to the Jabber equivalent and allows you get and set all
\& parts of those packets.
\&
\& There are a few functions that are the same across all of the objects:
.Ve
.SS "Retrieval functions"
.IX Subsection "Retrieval functions"
.Vb 2
\& GetXML() \- returns the XML string that represents the data contained
\& in the object.
\&
\& $xml = $obj\->GetXML();
\&
\& GetChild() \- returns an array of Net::XMPP::Stanza objects
\& GetChild(namespace) that represent all of the stanzas in the object
\& that are namespaced. If you specify a namespace
\& then only stanza objects with that XMLNS are
\& returned.
\&
\& @xObj = $obj\->GetChild();
\& @xObj = $obj\->GetChild("my:namespace");
\&
\& GetTag() \- return the root tag name of the packet.
\&
\& GetTree() \- return the XML::Stream::Node object that contains the data.
\& See XML::Stream::Node for methods you can call on this
\& object.
.Ve
.SS "Creation functions"
.IX Subsection "Creation functions"
.Vb 7
\& NewChild(namespace) \- creates a new Net::XMPP::Stanza object with
\& NewChild(namespace,tag) the specified namespace and root tag of
\& whatever the namespace says its root tag
\& should be. Optionally you may specify
\& another root tag if the default is not
\& desired, or the namespace requres you to set
\& one.
\&
\& $xObj = $obj\->NewChild("my:namespace");
\& $xObj = $obj\->NewChild("my:namespace","foo");
\& ie.
\&
\& InsertRawXML(string) \- puts the specified string raw into the XML
\& packet that you call this on.
\&
\& $message\->InsertRawXML("")
\& ...
\&
\& $x = $message\->NewChild(..);
\& $x\->InsertRawXML("test");
\&
\& $query = $iq\->GetChild(..);
\& $query\->InsertRawXML("test");
\&
\& ClearRawXML() \- removes the raw XML from the packet.
.Ve
.SS "Removal functions"
.IX Subsection "Removal functions"
.Vb 4
\& RemoveChild() \- removes all of the namespaces child elements
\& RemoveChild(namespace) from the object. If a namespace is provided,
\& then only the children with that namespace are
\& removed.
.Ve
.SS "Test functions"
.IX Subsection "Test functions"
.Vb 5
\& DefinedChild() \- returns 1 if there are any known namespaced
\& DefinedChild(namespace) stanzas in the packet, 0 otherwise.
\& Optionally you can specify a namespace and
\& determine if there are any stanzas with that
\& namespace.
\&
\& $test = $obj\->DefinedChild();
\& $test = $obj\->DefinedChild("my:namespace");
.Ve
.SH "PACKAGES"
.IX Header "PACKAGES"
.Vb 2
\& For more information on each of these packages, please see the man page
\& for each one.
.Ve
.SS "Net::XMPP::Client"
.IX Subsection "Net::XMPP::Client"
.Vb 4
\& This package contains the code needed to communicate with an XMPP
\& server: login, wait for messages, send messages, and logout. It uses
\& XML::Stream to read the stream from the server and based on what kind
\& of tag it encounters it calls a function to handle the tag.
.Ve
.SS "Net::XMPP::Protocol"
.IX Subsection "Net::XMPP::Protocol"
.Vb 2
\& A collection of high\-level functions that Client uses to make their
\& lives easier. These methods are inherited by the Client.
.Ve
.SS "Net::XMPP::JID"
.IX Subsection "Net::XMPP::JID"
.Vb 3
\& The XMPP IDs consist of three parts: user id, server, and resource.
\& This module gives you access to those components without having to
\& parse the string yourself.
.Ve
.SS "Net::XMPP::Message"
.IX Subsection "Net::XMPP::Message"
.Vb 2
\& Everything needed to create and read a received from the
\& server.
.Ve
.SS "Net::XMPP::Presence"
.IX Subsection "Net::XMPP::Presence"
.Vb 2
\& Everything needed to create and read a received from the
\& server.
.Ve
.SS "Net::XMPP::IQ"
.IX Subsection "Net::XMPP::IQ"
.Vb 2
\& IQ is a wrapper around a number of modules that provide support for
\& the various Info/Query namespaces that XMPP recognizes.
.Ve
.SS "Net::XMPP::Stanza"
.IX Subsection "Net::XMPP::Stanza"
.Vb 2
\& This module represents a namespaced stanza that is used to extend a
\& , , and .
\&
\& The man page for Net::XMPP::Stanza contains a listing of all supported
\& namespaces, and the methods that are supported by the objects that
\& represent those namespaces.
.Ve
.SS "Net::XMPP::Namespaces"
.IX Subsection "Net::XMPP::Namespaces"
.Vb 5
\& XMPP allows for any stanza to be extended by any bit of XML. This
\& module contains all of the internals for defining the XMPP based
\& extensions defined by the IETF. The documentation for this module
\& explains more about how to add your own custom namespace and have it
\& be supported.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Ryan Eatmon
Currently maintained by Eric Hacker.
.SH "BUGS"
.IX Header "BUGS"
Probably. There is at least one issue with XLM::Stream providing different node
structures depending on how the node is created. Net::XMPP should now be able to
handle this, but who knows what else lurks.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is free software, you can redistribute it and/or modify it
under the \s-1LGPL.\s0