org.apache.mina.management
Class StatCollector

java.lang.Object
  extended by org.apache.mina.management.StatCollector

public class StatCollector
extends Object

Collects statistics of an IoService. It's polling all the sessions of a given IoService. It's attaching a IoSessionStat object to all the sessions polled and filling the throughput values. Usage :

 IoService service = ...
 StatCollector collector = new StatCollector( service );
 collector.start();
 
By default the StatCollector is polling the sessions every 5 seconds. You can give a different polling time using a second constructor.

Version:
$Rev: 447146 $, $Date: 2006-09-17 23:09:05 +0200 (Sun, 17 Sep 2006) $
Author:
The Apache Directory Project (mina-dev@directory.apache.org)

Field Summary
static String KEY
          The session attribute key for IoSessionStat.
 
Constructor Summary
StatCollector(IoService service)
          Create a stat collector for the given service with a default polling time of 5 seconds.
StatCollector(IoService service, int pollingInterval)
          create a stat collector for the given given service
 
Method Summary
 boolean isRunning()
          is the stat collector started and polling the IoSession of the IoService
 void start()
          Start collecting stats for the IoSession of the service.
 void stop()
          Stop collecting stats.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY

public static final String KEY
The session attribute key for IoSessionStat.

Constructor Detail

StatCollector

public StatCollector(IoService service)
Create a stat collector for the given service with a default polling time of 5 seconds.

Parameters:
service - the IoService to inspect

StatCollector

public StatCollector(IoService service,
                     int pollingInterval)
create a stat collector for the given given service

Parameters:
service - the IoService to inspect
pollingInterval - milliseconds
Method Detail

start

public void start()
Start collecting stats for the IoSession of the service. New sessions or destroyed will be automaticly added or removed.


stop

public void stop()
Stop collecting stats. all the IoSessionStat object will be removed of the polled session attachements.


isRunning

public boolean isRunning()
is the stat collector started and polling the IoSession of the IoService

Returns:
true if started