com.ergotech.secs

Interface LoggerInterface

All Superinterfaces:

java.util.EventListener, SecsEventListener

All Known Implementing Classes:

Log4JLogger, Log4JLogger, Logger, MultiLogger, NetLogger, SyslogLogger, VIBLogger

public interface LoggerInterface
extends SecsEventListener

This is the interface used by the SECS subsystem to log useful and interesting(?) information about what is happening within the SECS system.

Field Summary

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Method Summary

Modifier and Type	Method and Description
void	received(byte[] data) This will be called wheneever raw bytes of data are read from the port.
void	received(SecsMsg msg) Called whenever a message is received.
void	sent(byte[] data) Called whenever data is sent through the port.
void	sent(SecsMsg msg) Called whenever a message is sent.
void	setDisplayBytes(boolean newValue) This allows the logger to control the display of byte data.
void	setDisplayEvents(boolean newValue) This allows the logger to control the display of events.
void	setDisplayMessages(boolean newValue) This allows the logger to control the display of message data.

Methods inherited from interface com.ergotech.secs.SecsEventListener

secsEvent

Method Detail

received

void received(byte[] data)

This will be called wheneever raw bytes of data are read from the port. There is no guarentee the the array will contain a complete message.

received

void received(SecsMsg msg)

Called whenever a message is received. This will be called whenever a message is received after the raw byte stream has been converted to a message.

sent

void sent(byte[] data)

Called whenever data is sent through the port. There is no guarentee that the array will contain a complete message, or even a complete block.

sent

void sent(SecsMsg msg)

Called whenever a message is sent.

setDisplayBytes

void setDisplayBytes(boolean newValue)

This allows the logger to control the display of byte data. This will be called whenever the user wishes to enable or disable the display of byte data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.

setDisplayEvents

void setDisplayEvents(boolean newValue)

This allows the logger to control the display of events. This will be called whenever the user wishes to enable or disable the display of event data. This is a request only, and the logger is free to register for any or all events as is required.

setDisplayMessages

void setDisplayMessages(boolean newValue)

This allows the logger to control the display of message data. This will be called whenever the user wishes to enable or disable the display of message data. Note that this has no impact on whether the methods are called. The SECS system will always call the logger methods, it is the task of the logger to decide what to do with the information, this method is here just to help with that task.