|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Adaptor
An adaptor is a component that runs within the Local Agent, producing chunks of monitoring data. An adaptor can, but need not, have an associated thread. If an adaptor lacks a thread, it needs to arrange some mechanism to periodically get control and send reports such as a callback somewhere. Adaptors must be able to stop and resume without losing data, using a byte offset in the stream. If an adaptor crashes at byte offset n, and is restarted at byte offset k, with k < n, it is allowed to send different values for bytes k through n the second time around. However, the stream must still be parseable, assuming that bytes 0-k come from the first run,and bytes k - n come from the second.
Method Summary | |
---|---|
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. |
long |
shutdown()
Signals this adaptor to come to an orderly stop. |
void |
start(long adaptorID,
String type,
String status,
long offset,
ChunkReceiver dest)
Start this adaptor |
Method Detail |
---|
void start(long adaptorID, String type, String status, long offset, ChunkReceiver dest) throws AdaptorException
type
- the application type, who is starting this adaptorstatus
- the status string to use for configuration.offset
- the stream offset of the first byte sent by this adaptor
AdaptorException
String getCurrentStatus() throws AdaptorException
AdaptorException
String getType()
String getStreamName()
long shutdown() throws AdaptorException
AdaptorException
void hardStop() throws AdaptorException
AdaptorException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |