org.apache.hadoop.chukwa.util

Class ConstRateAdaptor

java.lang.Object

java.lang.Thread

org.apache.hadoop.chukwa.util.ConstRateAdaptor

All Implemented Interfaces:

Runnable, Adaptor

public class ConstRateAdaptor
extends Thread
implements Adaptor

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ConstRateAdaptor()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCurrentStatus() Return the adaptor's state Should not include class name, datatype or byte offset, which are written by caller.
String	getStreamName() Return the stream name
String	getType()
void	hardStop() Signals this adaptor to come to an abrupt stop, as quickly as it can.
void	run()
long	shutdown() Signals this adaptor to come to an orderly stop.
void	start(long adaptor, String type, String bytesPerSecParam, long offset, ChunkReceiver dest) Start this adaptor
String	toString()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstRateAdaptor

public ConstRateAdaptor()

Method Detail

getCurrentStatus

public String getCurrentStatus()
                        throws AdaptorException

Description copied from interface: Adaptor

Return the adaptor's state Should not include class name, datatype or byte offset, which are written by caller.

Specified by:

getCurrentStatus in interface Adaptor

Returns:

the adaptor state as a string

Throws:

AdaptorException

start

public void start(long adaptor,
         String type,
         String bytesPerSecParam,
         long offset,
         ChunkReceiver dest)
           throws AdaptorException

Description copied from interface: Adaptor

Start this adaptor

Specified by:

start in interface Adaptor

type - the application type, who is starting this adaptor

bytesPerSecParam - the status string to use for configuration.

offset - the stream offset of the first byte sent by this adaptor

Throws:

AdaptorException

getStreamName

public String getStreamName()

Description copied from interface: Adaptor

Return the stream name

Specified by:

getStreamName in interface Adaptor

Returns:

Stream name as a string

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

toString

public String toString()

Overrides:

toString in class Thread

hardStop

public void hardStop()
              throws AdaptorException

Description copied from interface: Adaptor

Signals this adaptor to come to an abrupt stop, as quickly as it can. The use case here is "Whups, I didn't mean to start that adaptor tailing a gigabyte file, stop it now". Adaptors might need to do something nontrivial here, e.g., in the case in which they have registered periodic timer interrupts, or use a shared worker thread from which they need to disengage. This method is synchronous: In other words, after shutdown() returns, no new data should be written.

Specified by:

hardStop in interface Adaptor

Throws:

AdaptorException

shutdown

public long shutdown()
              throws AdaptorException

Description copied from interface: Adaptor

Signals this adaptor to come to an orderly stop. The adaptor ought to push out all the data it can before exiting. This method is synchronous: In other words, after shutdown() returns, no new data should be written.

Specified by:

shutdown in interface Adaptor

Returns:

the logical offset at which the adaptor stops

Throws:

AdaptorException

getType

public String getType()

Specified by:

getType in interface Adaptor