org.walluck.oscar.tools
Class StatsTool

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

public class StatsTool
extends Tool
implements StatsListener

Stats tool.

Since:
1.0
Version:
1.0
Author:
David Walluck

Field Summary
 
Fields inherited from class org.walluck.oscar.tools.Tool
listeners
 
Constructor Summary
StatsTool()
          Creates a new Stats tool.
 
Method Summary
 void bosConnectionAvailable()
          Method called by the LoginTool once the BOS connection is available.
 void reportAck(AIMSession sess, AIMFrame frame, AIMInputStream buffer)
          Describe reportAck method here.
 void reportInterval(AIMSession sess, AIMFrame frame, int interval)
          Describe reportInterval method here.
 void shutdown(AIMSession sess)
          Called when the tool is shutting down.
 
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

StatsTool

public StatsTool()
Creates a new Stats tool. Family 0x000b.

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

reportInterval

public void reportInterval(AIMSession sess,
                           AIMFrame frame,
                           int interval)
Describe reportInterval method here.

Specified by:
reportInterval in interface StatsListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
interval - an int value

reportAck

public void reportAck(AIMSession sess,
                      AIMFrame frame,
                      AIMInputStream buffer)
Describe reportAck method here.

Specified by:
reportAck in interface StatsListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
buffer - an AIMInputStream value