com.telestax.core

Class ThreadAuditor

java.lang.Object

com.telestax.core.ThreadAuditor

public class ThreadAuditor
extends Object

Thread Auditor class: - Provides a mechanism for applications to check the health of internal threads - The mechanism is fairly simple: - Threads register with the auditor at startup and "ping" the auditor every so often. - The application queries the auditor about the health of the system periodically. The auditor reports if the threads are healthy or if any of them failed to ping and are considered dead or stuck. - The main implication for the monitored threads is that they can no longer block waiting for an event forever. Any wait() must be implemented with a timeout so that the thread can periodically ping the auditor. This code is in the public domain.

Version:

1.2

Author:

R. Borba (Natural Convergence)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ThreadAuditor.ThreadHandle

Constructor Summary

Constructors

Constructor and Description
ThreadAuditor()

Method Summary

Methods

Modifier and Type	Method and Description
ThreadAuditor.ThreadHandle	addCurrentThread()
String	auditThreads() Audits the sanity of all threads
long	getPingIntervalInMillisecs()
boolean	isEnabled()
void	ping(ThreadAuditor.ThreadHandle threadHandle)
void	removeThread(Thread thread)
void	reset()
void	setPingIntervalInMillisecs(long value)
String	toString() Returns a string representation of the object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ThreadAuditor

public ThreadAuditor()

Method Detail

getPingIntervalInMillisecs

public long getPingIntervalInMillisecs()

setPingIntervalInMillisecs

public void setPingIntervalInMillisecs(long value)

isEnabled

public boolean isEnabled()

addCurrentThread

public ThreadAuditor.ThreadHandle addCurrentThread()

removeThread

public void removeThread(Thread thread)

ping

public void ping(ThreadAuditor.ThreadHandle threadHandle)

reset

public void reset()

auditThreads

public String auditThreads()

Audits the sanity of all threads

Returns:

An audit report string (multiple lines), or null if all is well

toString

public String toString()

Returns a string representation of the object

Overrides:

toString in class Object

Returns:

a string representation of the object