.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 >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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Net::Jabber::Component 3pm" .TH Net::Jabber::Component 3pm "2017-10-19" "perl v5.26.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" Net::Jabber::Component \- Jabber Component Library .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& Net::Jabber::Component is a module that provides a developer easy \& access to developing server components in the Jabber Instant Messaging \& protocol. .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .Vb 4 \& Component.pm seeks to provide enough high level APIs and automation of \& the low level APIs that writing a Jabber Component in Perl is trivial. \& For those that wish to work with the low level you can do that too, \& but those functions are covered in the documentation for each module. \& \& Net::Jabber::Component provides functions to connect to a Jabber \& server, login, send and receive messages, operate as a server side \& component, and disconnect. You can use all or none of the functions, \& there is no requirement. \& \& For more information on how the details for how Net::Jabber is written \& please see the help for Net::Jabber itself. \& \& For a full list of high level functions available please see \& Net::Jabber::Protocol and Net::XMPP::Protocol. .Ve .SS "Basic Functions" .IX Subsection "Basic Functions" .Vb 1 \& use Net::Jabber; \& \& $Con = new Net::Jabber::Component(); \& \& $Con\->Execute(hostname=>"jabber.org", \& componentname=>"service.jabber.org", \& secret=>"XXXX" \& ); \& \& # \& # For the list of available functions see Net::XMPP::Protocol. \& # \& \& $Con\->Disconnect(); .Ve .SH "METHODS" .IX Header "METHODS" .SS "Basic Functions" .IX Subsection "Basic Functions" .Vb 8 \& new(debuglevel=>0|1|2, \- creates the Component object. debugfile \& debugfile=>string, should be set to the path for the debug \& debugtime=>0|1) log to be written. If set to "stdout" \& then the debug will go there. debuglevel \& controls the amount of debug. For more \& information about the valid setting for \& debuglevel, debugfile, and debugtime see \& Net::Jabber::Debug. \& \& AuthSend(secret=>string) \- Perform the handshake and authenticate \& with the server. \& \& Connect(hostname=>string, \- opens a connection to the server \& port=>integer, based on the value of \& componentname=>string, connectiontype. The only valid \& connectiontype=>string) setting is: \& accept \- TCP/IP remote connection \& In the future this might be used \& again by offering new features. \& If accept then it connects to the \& server listed in the hostname \& value, on the port listed. The \& defaults for the two are localhost \& and 5269. \& \& Note: A change from previous \& versions is that Component now \& shares its core with Client. To \& that end, the secret should no \& longer be used. Call AuthSend \& after connecting. Better yet, \& use Execute. \& \& Connected() \- returns 1 if the Component is connected to the server, \& and 0 if not. \& \& Disconnect() \- closes the connection to the server. \& \& Execute(hostname=>string, \- Generic inner loop to handle \& port=>int, connecting to the server, calling \& secret=>string, Process, and reconnecting if the \& componentname=>string, connection is lost. There are four \& connectiontype=>string, callbacks available that are called \& connectattempts=>int, at various places in the loop. \& connectsleep=>int) onconnect \- when the component \& connects to the \& server. \& onauth \- when the component has \& completed its handshake \& with the server this \& will be called. \& onprocess \- this is the most \& inner loop and so \& gets called the most. \& Be very very careful \& what you put here \& since it can \& *DRASTICALLY* affect \& performance. \& ondisconnect \- when connection is \& lost. \& onexit \- when the function gives \& up trying to connect and \& exits. \& The arguments are passed straight \& on to the Connect function, except \& for connectattempts and \& connectsleep. connectattempts is \& the number of time that the \& Component should try to connect \& before giving up. \-1 means try \& forever. The default is \-1. \& connectsleep is the number of \& seconds to sleep between each \& connection attempt. \& \& Process(integer) \- takes the timeout period as an argument. If no \& timeout is listed then the function blocks until \& a packet is received. Otherwise it waits that \& number of seconds and then exits so your program \& can continue doing useful things. NOTE: This is \& important for GUIs. You need to leave time to \& process GUI commands even if you are waiting for \& packets. The following are the possible return \& values, and what they mean: \& \& 1 \- Status ok, data received. \& 0 \- Status ok, no data received. \& undef \- Status not ok, stop processing. \& \& IMPORTANT: You need to check the output of every \& Process. If you get an undef then the connection \& died and you should behave accordingly. .Ve .SH "AUTHOR" .IX Header "AUTHOR" Ryan Eatmon .SH "COPYRIGHT" .IX Header "COPYRIGHT" This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.