Module: Jabber

Classes and Modules

Module Jabber::Bytestreams
Module Jabber::Caps
Module Jabber::Command
Module Jabber::Dataforms
Module Jabber::Delay
Module Jabber::Discovery
Module Jabber::FeatureNegotiation
Module Jabber::FileTransfer
Module Jabber::Framework
Module Jabber::HTTPBinding
Module Jabber::LastActivity
Module Jabber::MUC
Module Jabber::PubSub
Module Jabber::RPC
Module Jabber::Reliable
Module Jabber::Roster
Module Jabber::SASL
Module Jabber::Test
Module Jabber::UserLocation
Module Jabber::UserTune
Module Jabber::Vcard
Module Jabber::Version
Module Jabber::XHTML
Module Jabber::XParent
Class Jabber::ArgumentError
Class Jabber::Callback
Class Jabber::CallbackList
Class Jabber::Client
Class Jabber::ClientAuthenticationFailure
Class Jabber::Component
Class Jabber::ComponentAuthenticationFailure
Class Jabber::Connection
Class Jabber::ErrorResponse
Class Jabber::IdGenerator
Class Jabber::InvalidChatState
Class Jabber::Iq
Class Jabber::IqQuery
Class Jabber::JID
Class Jabber::JabberError
Class Jabber::Message
Class Jabber::NoNameXmlnsRegistered
Class Jabber::Presence
Class Jabber::SOCKS5Error
Class Jabber::Semaphore
Class Jabber::ServerDisconnected
Class Jabber::Stream
Class Jabber::StreamParser
Class Jabber::X
Class Jabber::XMPPElement
Class Jabber::XMPPStanza

Constants

XMPP4R_VERSION = '0.5' XMPP4R Version number. This is the ONLY place where the version number should be specified. This constant is used to determine the version of package tarballs and generated gems.

Public Class methods

debug()

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

[Source]

    # File lib/xmpp4r/debuglog.rb, line 45
45:   def Jabber::debug
46:     @@debug
47:   end

debug=(debug)

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.

[Source]

    # File lib/xmpp4r/debuglog.rb, line 26
26:   def Jabber::debug=(debug)
27:     @@debug = debug
28:     if @@debug
29:       debuglog('Debugging mode enabled.')
30:       #if debug is enabled, we should automatically enable warnings too
31:       Jabber::warnings = true
32:     end
33:   end

debuglog(string)

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

[Source]

    # File lib/xmpp4r/debuglog.rb, line 52
52:   def Jabber::debuglog(string)
53:     return if not @@debug
54:     logger.debug string.chomp.gsub("\n", "\n    ")
55:   end

logger()

[Source]

    # File lib/xmpp4r/debuglog.rb, line 8
 8:   def Jabber::logger
 9:     @@logger ||= Logger.new($stderr)
10:   end

logger=(logger)

Set the logger to use for debug and warn (if enabled)

[Source]

    # File lib/xmpp4r/debuglog.rb, line 13
13:   def Jabber::logger=(logger)
14:     @@logger = logger
15:   end

warnings=(warnings)

Enable/disable warnings mode.

[Source]

    # File lib/xmpp4r/debuglog.rb, line 36
36:   def Jabber::warnings=(warnings)
37:     @@warnings = warnings
38:     if @@warnings
39:       warnlog('Warnings mode enabled.')
40:     end
41:   end

warnlog(string)

Outputs a string only if warnings mode is enabled.

[Source]

    # File lib/xmpp4r/debuglog.rb, line 58
58:   def Jabber::warnlog(string)
59:     return if not @@warnings
60:     logger.warn string.chomp.gsub("\n", "\n    ")
61:   end

XMPP4R - XMPP Library for Ruby

Methods

Classes and Modules

Constants

Public Class methods