|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.yammer.metrics.reporting.AbstractReporter
com.yammer.metrics.reporting.AbstractPollingReporter
public abstract class AbstractPollingReporter
An abstract base class for all reporter implementations which periodically poll registered metrics (e.g., to send the data to another service).
Constructor Summary | |
---|---|
protected |
AbstractPollingReporter(MetricsRegistry registry,
String name)
Creates a new AbstractPollingReporter instance. |
Method Summary | |
---|---|
abstract void |
run()
The method called when a a poll is scheduled to occur. |
void |
shutdown()
Stops the reporter and closes any internal resources. |
void |
shutdown(long timeout,
TimeUnit unit)
Shuts down the reporter polling, waiting the specific amount of time for any current polls to complete. |
void |
start(long period,
TimeUnit unit)
Starts the reporter polling at the given period. |
Methods inherited from class com.yammer.metrics.reporting.AbstractReporter |
---|
getMetricsRegistry |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractPollingReporter(MetricsRegistry registry, String name)
AbstractPollingReporter
instance.
registry
- the MetricsRegistry
containing the metrics this reporter will
reportname
- the reporter's nameAbstractReporter.AbstractReporter(MetricsRegistry)
Method Detail |
---|
public void start(long period, TimeUnit unit)
period
- the amount of time between pollsunit
- the unit for period
public void shutdown(long timeout, TimeUnit unit) throws InterruptedException
timeout
- the maximum time to waitunit
- the unit for timeout
InterruptedException
- if interrupted while waitingpublic void shutdown()
AbstractReporter
shutdown
in class AbstractReporter
public abstract void run()
run
in interface Runnable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |