Home >> All >> org >> relayirc >> [ chatengine Javadoc ]

• org.relayirc.chatengine: Javadoc index of package org.relayirc.chatengine.


Package Samples:

• org.relayirc.chatengine

Classes:

• ChatEngine: Manages a connection to an IRC server and handles incoming messages by creating channel objects, routing messages to channel objects and routing events to chat engine listeners. After you have constructed a chat engine, add a ChatEngineListener to be notified of server connection and disconnection, channel joins and parts and status messages from the engine. Connect to the chat server using the connect() method and use the sendJoin() and sendPart() commands to join and leave chat channels. When a channel is joined, your listener will be informed and you may add a ChannelListener to the channel ...
• User: Represent a user that has been added to the favorites collection. TODO: Perhaps a user object should query/listen-to the chat engine to determine if user is online and which channels the user is on. TODO: Perhaps a user object should support message, kick, ban and other methods. TODO: Should provide property change support.
• IRCConnection: A socket connection to a RFC-1459 compatible IRC server. Parses incoming IRC messages, replies, commands and errors and notifies all listeners of such. Also provides a writeln() method for sending commands to the IRC server. FIX: Currently, only one listener is allowed.
• ChannelSearch: Channel searcher. Works closely with a chat engine to search for channels that match the search criteria, notify listeners of each such matching channel as it is found and build a collection of matching channels.
• ChannelSearchListener: Inteface for listening to progress of a channel search. Implement this interface to be notified of beginning of search, each channel that is found to meet the search criteria and the end of the search.
• IRCConnectionListener: Implement this interface to listen to an IRCConnection. ISSUE: To follow the Java Bean conventions, should every method accept one argument of type IRCConnectionEvent? Does it matter?
• ChatOptions: User's option settings. Includes identification information like nick name and user name. Includes name of currently select IRC server and a list of other IRC servers.
• Server: Currently, a server object just holds information about an IRC server. It might make sense to have an openConnection() method which returns an IRC connection object.
• Channel: An IRC channel class that includes methods for joining, parting, kicking, banning, adding/removing channel listeners and property change support.
• ChatEngineEvent: Event fired by a ChatEngine. Has either a Channel object, a Server object, a string status message or no value; other fields will be null.
• IdentServer: Implments a "one-shot" ident authentication server. This is needed for systems that do not have an ident authentication server.
• ChatEngineListener: Implement this interface to listen for server connection and disconnection, channel joins and parts and status messages.
• ServerList: A list of IRC servers that can be constructed by reading a MIRC servers.ini file. TODO: Finish exportMircFile()
• ChatOptionListener: Currently not used: ChatOption provides standard beans property change support and thats good enough for now.
• IRCConnectionAdapter: Do-nothing implementation of IRCConnectionListener to make it easy to derive new connection listeners.
• ChannelListener: Implement this interface to listen to channel events incuding messages, joins, parts, bans and kicks.
• ChannelEvent: Event fired by a channel. The source of a ChannelEvent is always a Channel object.
• IChatEngine: Interface for a chat engine. Where possible, use it instead of ChatEngine.
• ChatEngineAdapter: Provides a default do-nothing implementation of ChatEngineListener
• ChannelAdapter: Provides a default do-nothing implementation of ChannelListener.
• IRCConstants: IRC reply and error numbers specified in RFC-1459.
• IChatApp: Interface for an IRC chat application.

Home | Contact Us | Privacy Policy | Terms of Service