Package com.gurock.smartinspect

Interface Summary

Interface	Description
ConnectionsParserListener	This interface is used as callback for the ConnectionsParser.parse method.
OptionsParserListener	This interface is used as callback for the OptionsParser.parse method.
ProtocolListener	This listener interface is used in the Protocol class for error and exception reporting.
SmartInspectListener	This listener interface is used in the SmartInspect class for all kinds of event reporting.

Class Summary

Class	Description
BinaryContext	This is the base class for all viewer contexts, which deal with binary data.
BinaryFormatter	Responsible for formatting and writing a packet in the standard SmartInspect binary format.
BinaryViewerContext	Represents the binary viewer in the Console which can display binary data in a read-only hex editor.
Clock	Provides access to the current date and time, optionally with a high resolution.
ClockResolution	Represents the timestamp resolution mode for the Clock class.
Configuration	This class is responsible for handling the SmartInspect configuration and loading it from a file.
ConfigurationTimer	A configurable timer for monitoring and reloading SmartInspect configuration files on changes.
ConnectionsBuilder	Assists in building a SmartInspect connections string.
ConnectionsParser	Responsible for parsing a SmartInspect connections string.
ConnectionsParserEvent	This class is used by the ConnectionsParser.parse method.
ControlCommand	Represents the Control Command packet type which is used for administrative tasks like resetting or clearing the Console.
ControlCommandEvent	This class is used by the SmartInspectListener.onControlCommand event of the SmartInspect class.
ControlCommandType	Represents the type of a ControlCommand packet.
DataViewerContext	Represents the data viewer in the Console which can display simple and unformatted text.
ErrorEvent	This class is used by the SmartInspectListener.onError event of the SmartInspect class and the ProtocolListener.onError event of the Protocol class.
FileHelper
FileProtocol	The FileProtocol serves as a standard SmartInspect protocol for writing log packets to a log file.
FileRotate	Specifies the log rotate mode for the FileProtocol class and derived classes.
FileRotater	Responsible for the log file rotate management as used by the FileProtocol class.
FilterEvent	This class is used by the SmartInspectListener.onFilter event of the SmartInspect class.
Formatter	Responsible for formatting and writing a packet.
GraphicId	Used by the GraphicViewerContext class to specify the desired picture type.
GraphicViewerContext	Represents the graphic viewer in the Console which can display images.
InspectorViewerContext	Represents the inspector viewer in the Console which displays key/value pairs in an object inspector control.
Level	Represents the log level in the SmartInspect Java library.
ListViewerContext	Represents the list viewer in the Console which can display simple lists of text data.
LogEntry	Represents the Log Entry packet type which is used for nearly all logging methods in the Session class.
LogEntryEvent	This class is used by the SmartInspectListener.onLogEntry event of the SmartInspect class.
LogEntryType	Represents the type of LogEntry packet.
LogHeader	Represents the Log Header packet type which is used for storing and transferring log metadata.
LookupTable	Represents a simple collection of key/value pairs.
MemoryProtocol	Used for writing log data to memory and saving it to a stream or protocol object on request.
OptionsParser	Responsible for parsing the options part of a SmartInspect connections string.
OptionsParserEvent	This class is used by the OptionsParser class to inform interested parties about found options.
Packet	This is the abstract base class for all packets in the SmartInspect Java library.
PacketQueue	Manages a memory size limited queue of packets.
PacketType	Represents the type of packet.
Path	Provides static methods to perform certain operations on strings which represent a path.
PatternParser	Capable of parsing and expanding a pattern string as used in the TextProtocol and TextFormatter classes.
PipeProtocol	Used for sending packets to a local SmartInspect Console over a named pipe connection.
ProcessFlow	Represents the Process Flow packet type which is used in the enter/leave methods in the Session class.
ProcessFlowEvent	This class is used by the SmartInspectListener.onProcessFlow event of the SmartInspect class.
ProcessFlowType	Represents the type of ProcessFlow packet.
Protocol	This is the abstract base class for a protocol.
ProtocolAdapter	Represents the adapter class for the ProtocolListener event interface of the Protocol class.
ProtocolCommand	Represents a custom protocol action command as used by the Protocol.dispatch method.
ProtocolFactory	Creates Protocol instances and registers custom protocols.
ProtocolVariables	Manages connection variables.
Scheduler	Responsible for scheduling protocol operations and executing them asynchronously in a different thread of control.
SchedulerAction	Represents a scheduler action to execute when a protocol is operating in asynchronous mode.
SchedulerCommand	Represents a scheduler command as used by the Scheduler class and the asynchronous protocol mode.
SchedulerQueue	Manages a queue of scheduler commands.
Session	Logs all kind of data and variables to the SmartInspect Console or to a log file.
SessionDefaults	Specifies the default property values for newly created sessions.
SessionManager	Manages and configures Session instances.
SiAuto	Provides automatically created objects for using the SmartInspect and Session classes.
SmartInspect	SmartInspect is the most important class in the SmartInspect Java library.
SmartInspectAdapter	Represents the adapter class for the SmartInspectListener event interface of the SmartInspect class.
SourceId	Used in the logSource methods of the Session class to specify the type of source code.
SourceViewerContext	Represents the source viewer in the Console which can display text data as source code with syntax highlighting.
TableViewerContext	Represents the table viewer in the Console which can display text data as a table.
TcpProtocol	Used for sending packets to the SmartInspect Console over a TCP socket connection.
TextContext	Is the base class for all viewer contexts, which deal with text data.
TextFormatter	Responsible for creating a text representation of a packet and writing it to a stream.
TextProtocol	Used for writing customizable plain text log files.
Token	Represents a token in the pattern string of the TextProtocol protocol.
TokenFactory	Creates instances of Token subclasses.
ValueListViewerContext	Represents the value list viewer in the Console which can display data as a key/value list.
ViewerContext	Is the abstract base class for a viewer context.
ViewerId	Specifies the viewer for displaying the title or data of a Log Entry in the Console.
Watch	Represents the Watch packet type which is used in the watch methods in the Session classes.
WatchEvent	This class is used by the SmartInspectListener.onWatch event of the SmartInspect class.
WatchType	Represents the type of Watch packet.
WebViewerContext	Represents the web viewer in the Console which can display HTML text content as web pages.

Exception Summary

Exception	Description
InvalidConnectionsException	Used to report errors concerning the connections string in the SmartInspect class.
LoadConfigurationException	Used to report errors concerning the SmartInspect.loadConfiguration method.
LoadConnectionsException	Used to report errors concerning the SmartInspect.loadConnections method.
ProtocolException	This class is used to report any errors concerning the protocol classes.
SmartInspectException	Used internally to report any kind of error.