Module: Jabber

Module | Jabber
In: | lib/xmpp4r/bytestreams/helper/ibb/target.rb lib/xmpp4r/bytestreams/helper/ibb/base.rb lib/xmpp4r/bytestreams/helper/ibb/initiator.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb lib/xmpp4r/bytestreams/helper/filetransfer.rb lib/xmpp4r/bytestreams/iq/bytestreams.rb lib/xmpp4r/bytestreams/iq/si.rb lib/xmpp4r/caps/c.rb lib/xmpp4r/caps/helper/generator.rb lib/xmpp4r/caps/helper/helper.rb lib/xmpp4r/command/helper/responder.rb lib/xmpp4r/command/iq/command.rb lib/xmpp4r/dataforms/x/data.rb lib/xmpp4r/delay/x/delay.rb lib/xmpp4r/discovery/helper/responder.rb lib/xmpp4r/discovery/iq/discoinfo.rb lib/xmpp4r/discovery/iq/discoitems.rb lib/xmpp4r/feature_negotiation/iq/feature.rb lib/xmpp4r/framework/base.rb lib/xmpp4r/framework/bot.rb lib/xmpp4r/httpbinding/client.rb lib/xmpp4r/idgenerator.rb lib/xmpp4r/muc/helper/mucbrowser.rb lib/xmpp4r/muc/helper/simplemucclient.rb lib/xmpp4r/muc/helper/mucclient.rb lib/xmpp4r/muc/iq/mucadmin.rb lib/xmpp4r/muc/iq/mucadminitem.rb lib/xmpp4r/muc/iq/mucowner.rb lib/xmpp4r/muc/x/muc.rb lib/xmpp4r/muc/x/mucuseritem.rb lib/xmpp4r/muc/x/mucuserinvite.rb lib/xmpp4r/muc/item.rb lib/xmpp4r/presence.rb lib/xmpp4r/pubsub/helper/nodebrowser.rb lib/xmpp4r/pubsub/helper/nodehelper.rb lib/xmpp4r/pubsub/helper/servicehelper.rb lib/xmpp4r/pubsub/iq/pubsub.rb lib/xmpp4r/pubsub/children/configuration.rb lib/xmpp4r/pubsub/children/event.rb lib/xmpp4r/pubsub/children/item.rb lib/xmpp4r/pubsub/children/items.rb lib/xmpp4r/pubsub/children/node_config.rb lib/xmpp4r/pubsub/children/publish.rb lib/xmpp4r/pubsub/children/subscription.rb lib/xmpp4r/pubsub/children/unsubscribe.rb lib/xmpp4r/pubsub/children/subscription_config.rb lib/xmpp4r/query.rb lib/xmpp4r/roster/helper/roster.rb lib/xmpp4r/roster/iq/roster.rb lib/xmpp4r/roster/x/roster.rb lib/xmpp4r/rpc/helper/client.rb lib/xmpp4r/rpc/helper/server.rb lib/xmpp4r/rpc/iq/rpc.rb lib/xmpp4r/semaphore.rb lib/xmpp4r/tune/helper/helper.rb lib/xmpp4r/tune/tune.rb lib/xmpp4r/vcard/helper/vcard.rb lib/xmpp4r/vcard/iq/vcard.rb lib/xmpp4r/version/helper/responder.rb lib/xmpp4r/version/helper/simpleresponder.rb lib/xmpp4r/version/iq/version.rb lib/xmpp4r/x.rb lib/xmpp4r/xhtml/html.rb lib/xmpp4r/callbacks.rb lib/xmpp4r/component.rb lib/xmpp4r/connection.rb lib/xmpp4r/errors.rb lib/xmpp4r/iq.rb lib/xmpp4r/jid.rb lib/xmpp4r/message.rb lib/xmpp4r/sasl.rb lib/xmpp4r/stream.rb lib/xmpp4r/streamparser.rb lib/xmpp4r/xmppelement.rb lib/xmpp4r/xmppstanza.rb lib/xmpp4r/debuglog.rb lib/xmpp4r/xmpp4r.rb lib/xmpp4r/client.rb

The Jabber module is the root namespace of the library.

### Methods

debug debug= debuglog logger logger=

### 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::MUC
Module Jabber::PubSub
Module Jabber::RPC
Module Jabber::Roster
Module Jabber::SASL
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::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::Stream
Class Jabber::StreamParser
Class Jabber::X
Class Jabber::XMPPElement
Class Jabber::XMPPStanza

### Constants

XMPP4R_VERSION | = | '0.4' |  | 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 31
    31:   def Jabber::debug
    32:     @@debug
    33:   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 22
    22:   def Jabber::debug=(debug)
    23:     @@debug = debug
    24:     if @@debug
    25:       debuglog('Debugging mode enabled.')
    26:     end
    27:   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 38
    38:   def Jabber::debuglog(string)
    39:     return if not @@debug
    40:     logger.debug string.chomp.gsub("\n", "\n    ")
    41:   end

logger()

[Source]

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

logger=(logger)

[Source]

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

[Validate]