Module: Jabber

Defined in:
lib/xmpp4r/jid.rb,
lib/xmpp4r/x.rb,
lib/xmpp4r/iq.rb,
lib/xmpp4r/sasl.rb,
lib/xmpp4r/error.rb,
lib/xmpp4r/query.rb,
lib/xmpp4r/client.rb,
lib/xmpp4r/stream.rb,
lib/xmpp4r/xmpp4r.rb,
lib/xmpp4r/message.rb,
lib/xmpp4r/debuglog.rb,
lib/xmpp4r/presence.rb,
lib/xmpp4r/callbacks.rb,
lib/xmpp4r/component.rb,
lib/xmpp4r/muc/x/muc.rb,
lib/xmpp4r/semaphore.rb,
lib/xmpp4r/connection.rb,
lib/xmpp4r/rpc/iq/rpc.rb,
lib/xmpp4r/xmppstanza.rb,
lib/xmpp4r/idgenerator.rb,
lib/xmpp4r/xmppelement.rb,
lib/xmpp4r/streamparser.rb,
lib/xmpp4r/delay/x/delay.rb,
lib/xmpp4r/errorexception.rb,
lib/xmpp4r/vcard/iq/vcard.rb,
lib/xmpp4r/muc/iq/mucowner.rb,
lib/xmpp4r/roster/x/roster.rb,
lib/xmpp4r/dataforms/x/data.rb,
lib/xmpp4r/pubsub/iq/pubsub.rb,
lib/xmpp4r/roster/iq/roster.rb,
lib/xmpp4r/bytestreams/iq/si.rb,
lib/xmpp4r/muc/x/mucuseritem.rb,
lib/xmpp4r/rpc/helper/client.rb,
lib/xmpp4r/rpc/helper/server.rb,
lib/xmpp4r/command/iq/command.rb,
lib/xmpp4r/httpbinding/client.rb,
lib/xmpp4r/vcard/helper/vcard.rb,
lib/xmpp4r/version/iq/version.rb,
lib/xmpp4r/muc/x/mucuserinvite.rb,
lib/xmpp4r/pubsub/stanzas/item.rb,
lib/xmpp4r/muc/helper/mucclient.rb,
lib/xmpp4r/pubsub/stanzas/event.rb,
lib/xmpp4r/pubsub/stanzas/items.rb,
lib/xmpp4r/roster/helper/roster.rb,
lib/xmpp4r/authenticationfailure.rb,
lib/xmpp4r/muc/helper/mucbrowser.rb,
lib/xmpp4r/discovery/iq/discoinfo.rb,
lib/xmpp4r/discovery/iq/discoitems.rb,
lib/xmpp4r/command/helper/responder.rb,
lib/xmpp4r/pubsub/helper/nodehelper.rb,
lib/xmpp4r/version/helper/responder.rb,
lib/xmpp4r/pubsub/helper/nodebrowser.rb,
lib/xmpp4r/bytestreams/iq/bytestreams.rb,
lib/xmpp4r/muc/helper/simplemucclient.rb,
lib/xmpp4r/bytestreams/helper/ibb/base.rb,
lib/xmpp4r/pubsub/helper/servicehelper.rb,
lib/xmpp4r/pubsub/stanzas/subscription.rb,
lib/xmpp4r/bytestreams/helper/ibb/target.rb,
lib/xmpp4r/feature_negotiation/iq/feature.rb,
lib/xmpp4r/version/helper/simpleresponder.rb,
lib/xmpp4r/bytestreams/helper/filetransfer.rb,
lib/xmpp4r/bytestreams/helper/ibb/initiator.rb,
lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb,
lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb,
lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb,
lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb,
lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb

Overview

XMPP4R - XMPP Library for Ruby

License

Ruby’s license (see the LICENSE file) or GNU GPL, at your option.

Website::home.gna.org/xmpp4r/

Defined Under Namespace

Modules: Bytestreams, Command, Dataforms, Delay, Discovery, FeatureNegotiation, FileTransfer, HTTPBinding, MUC, PubSub, RPC, Roster, SASL, Vcard, Version, XParent Classes: AuthenticationFailure, Callback, CallbackList, Client, Component, Connection, Error, ErrorException, IdGenerator, Iq, IqQuery, JID, Message, NoNameXmlnsRegistered, Presence, Semaphore, Stream, StreamParser, X, XMPPElement, XMPPStanza

Constant Summary collapse

XMPP4R_VERSION =

XMPP4R Version number

'0.3.2'
@@debug =

Is debugging mode enabled ?

false

Class Method Summary collapse

Class Method Details

.debug ⇒ Object

returns true if debugging mode is enabled. If you just want to log something if debugging is enabled, use Jabber::debuglog instead.



21
22
23
 
# File 'lib/xmpp4r/debuglog.rb', line 21

def Jabber::debug
  @@debug
end

.debug=(debug) ⇒ Object

Enable/disable debugging mode. When debug mode is enabled, information can be logged using Jabber::debuglog. When debug mode is disabled, calls to Jabber::debuglog are just ignored.



12
13
14
15
16
17
 
# File 'lib/xmpp4r/debuglog.rb', line 12

def Jabber::debug=(debug)
  @@debug = debug
  if @@debug
    debuglog('Debugging mode enabled.')
  end
end

.debuglog(string) ⇒ Object

Outputs a string only if debugging mode is enabled. If the string includes several lines, 4 spaces are added at the begginning of each line but the first one. Time is prepended to the string.



28
29
30
31
32
33
 
# File 'lib/xmpp4r/debuglog.rb', line 28

def Jabber::debuglog(string)
  return if not @@debug
  s = string.chomp.gsub("\n", "\n    ")
  t = Time::new.strftime('%H:%M:%S')
  puts "#{t} #{s}"
end