Home >> All

•	jackbot.plugin.* (4)	•	jackbot.plugin.cheddarbot.* (3)	•	jackbot.scripting.* (9)
•	jackbot.scripting.ecma.* (7)

• jackbot: Javadoc index of package jackbot.


Package Samples:

• jackbot.plugin.cheddarbot
• jackbot.plugin
• jackbot.scripting.ecma
• jackbot.scripting

Classes:

• FloodControlIRCClient: Extends IRCClient and adds support for writing to the IRC server with flood control. Flood control is implemented using a seperate thread to actually send messages to the server. The ircWrite() method does not write to the server immediately, instead adding the message to a queue of outgoing messages. It then wakes up the send thread to send the message, in order to minimize latency. The flood control thread assigns a weight value to every message sent, and adds that value to an internal counter. If the counter passes some threshold, then the message is not sent. Every second, another thread decrements ...
• IRCMessageWait: The IRCMessageWait class can be used to implement message loops external to the EventIRCClient class. This is especially useful when trying to provide the illusion of synchronous work in the asynchronous IRC environment See the IRCMessageWaitRestore class for a more robust solution that allows you to automatically return the input queue to its state before the waiting occurred.
• IRCMessageWaitRestore: Like the IRCMessageWait class, the IRCMessageWaitRestore class will wait on an EventIRCClient . However, it provides the restore() 55 method for returning methods that have been retrieved back to the input queue.
• EventIRCClient: An IRC client that allows for arbitrary listeners to register to be informed when an IRC message arrives from the server. This class also will continually ping the server in order to make sure the connection is still in operation. If it detects a disconnect, the run() method will throw an exception in order for an attempt at reconnection.
• IRCClient: Implements an IRC client with minimal functionality. This includes: connection, logon, logoff, disconnection. This code is based on the Java IRC bot by David Seagler. http://www-106.ibm.com/developerworks/java/library/j-javabot/#h2
• BasicIRCFunctions: A basic plugin for providing handling very basic IRC functions. Currently, this handles the PING message, returning the requisite PONG. It also handles the !quit command, although this will eventually be moved into a script.
• IRCException: A class for exceptions occuring inside the IRC bot. The IRCException class extends regular Exceptions by allowing for inner exceptions, which are an exception that caused this exception to be throw.
• Exec: A native executed process on the JackBot host system. On creation, this class creates a child process and takes it's stdout stream and makes it available in an iterator-like format.
• Bot: ECMAScript host object Bot . The Bot class is the top-level object of the IRC Object Model (IOM). It's children include the Channel class.
• IRC: A final class defining the constants defined by RFC 1459. See ftp://ftp.irc.org/irc/docs/rfc1459.txt for more information.
• IRCMessageQueue: A queue of IRCMessage objects. This class is not synchronized, and should be manually synchronized for multi-threaded operations.
• HostObject: The base class of all Host Objects in the JackBot ECMAScript engine. This class provides basic event handler functionality.
• ECMAEngine: A JackBot scripting engine that utilizes the Rhino JavaScript engine to provide ECMAScript scripting capabilities.
• CTCPMessage: A Client-to-Client Protocol (CTCP) message that has been received from the server embedded in an IRC message.
• ScriptException: An exception that is thrown by JackBot scripting engines. Check the inner exception for more details.
• Channel: ECMAScript host object Channel . This represents a channel in the host object model.
• HostObjectFactory: A class for encapsulating the complexities of setting up host objects in the Rhino runtime.
• Configurable: The interface for items that can be configured. Used with the Config class.
• Server: A server to which the bot can connect. These are read from the configuration file.
• Config: A class that loads configuration information from an XML file.
• IRCConnectionLostException: Indicates the network connection to the server has been lost.
• UtilityIRCClient: Provides some helpful IRC client methods to subclasses.
• IRCMessageListener: Interface that defines a listener for IRC Messages.

Home | Contact Us | Privacy Policy | Terms of Service