org.walluck.oscar.tools
Class MiscTool

java.lang.Object
  extended by org.walluck.oscar.tools.Tool
      extended by org.walluck.oscar.tools.MiscTool
All Implemented Interfaces:
Listener, MiscListener

public class MiscTool
extends Tool
implements MiscListener

Misc tool.

Since:
1.0
Version:
1.0
Author:
David Walluck

Field Summary
 
Fields inherited from class org.walluck.oscar.tools.Tool
listeners
 
Constructor Summary
MiscTool()
          Creates a new Misc tool.
 
Method Summary
 void bosConnectionAvailable()
          Method called by the LoginTool once the BOS connection is available.
 void icbmRemoveCookie(AIMSession sess, MsgCookie cookie)
          Describe icbmRemoveCookie method here.
 void shutdown(AIMSession sess)
          Called when the tool is shutting down.
 void snacError(AIMSession sess, AIMFrame frame, int error, Object data)
          Describe snacError method here.
 void snacRequestTimedOut(AIMSession sess, SNAC snac)
          Describe snacRequestTimedOut method here.
 void unhandledFrame(AIMSession sess, AIMFrame frame)
          Describe unhandledFrame method here.
 
Methods inherited from class org.walluck.oscar.tools.Tool
getFamily, getId, getSession, getToolData, getVersion, setFamily, setId, setSession, setToolData, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MiscTool

public MiscTool()
Creates a new Misc tool. Family 0xffff.

Method Detail

shutdown

public void shutdown(AIMSession sess)
Called when the tool is shutting down.

Specified by:
shutdown in class Tool
Parameters:
sess - the oscar session

bosConnectionAvailable

public void bosConnectionAvailable()
Method called by the LoginTool once the BOS connection is available. This allows the other tools to get registered and get involved in the process.

Specified by:
bosConnectionAvailable in class Tool

snacError

public void snacError(AIMSession sess,
                      AIMFrame frame,
                      int error,
                      Object data)
Describe snacError method here.

Specified by:
snacError in interface MiscListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
error - an int value
data - an Object value

icbmRemoveCookie

public void icbmRemoveCookie(AIMSession sess,
                             MsgCookie cookie)
Describe icbmRemoveCookie method here.

Specified by:
icbmRemoveCookie in interface MiscListener
Parameters:
sess - an AIMSession value
cookie - a MsgCookie value

snacRequestTimedOut

public void snacRequestTimedOut(AIMSession sess,
                                SNAC snac)
Describe snacRequestTimedOut method here.

Specified by:
snacRequestTimedOut in interface MiscListener
Parameters:
sess - an AIMSession value
snac - a SNAC value

unhandledFrame

public void unhandledFrame(AIMSession sess,
                           AIMFrame frame)
Describe unhandledFrame method here.

Specified by:
unhandledFrame in interface MiscListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value