C# Class CK.Monitoring.LogEntry

Encapsulates ILogEntry concrete objects manipulation.

Mostra file Open project: Invenietis/ck-core

Public Methods

Method	Description
CreateCloseGroup ( DateTimeStamp t, LogLevel level, IReadOnlyList c ) : ILogEntry	Creates a ILogEntry for the closing of a group.
CreateLog ( string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : ILogEntry	Creates a ILogEntry for a line.
CreateMulticastCloseGroup ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, DateTimeStamp t, LogLevel level, IReadOnlyList c ) : IMulticastLogEntry	Creates a ILogEntry for the closing of a group.
CreateMulticastLog ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : IMulticastLogEntry	Creates a ILogEntry for a line.
CreateMulticastOpenGroup ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : IMulticastLogEntry	Creates a ILogEntry for an opened group.
CreateOpenGroup ( string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : ILogEntry	Creates a ILogEntry for an opened group.
Read ( CKBinaryReader r, int streamVersion, bool &badEndOfFile ) : ILogEntry	Reads a ILogEntry from the binary reader that can be a IMulticastLogEntry. If the first read byte is 0, read stops and null is returned. The 0 byte is the "end marker" that CKMonWriterClient.Close() write, but this method can read non zero-terminated streams (it catches an EndOfStreamException when reading the first byte and handles it silently). This method can throw any type of exception (System.IO.EndOfStreamException or InvalidDataException for instance) that must be handled by the caller.
WriteCloseGroup ( CKBinaryWriter w, Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, LogLevel level, DateTimeStamp closeTime, IReadOnlyList conclusions ) : void	Binary writes a multicast closing entry.
WriteCloseGroup ( CKBinaryWriter w, LogLevel level, DateTimeStamp closeTime, IReadOnlyList conclusions ) : void	Binary writes a closing entry.
WriteLog ( CKBinaryWriter w, Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, bool isOpenGroup, LogLevel level, DateTimeStamp logTime, string text, CKTrait tags, CKExceptionData ex, string fileName, int lineNumber ) : void	Binary writes a multicast log entry.
WriteLog ( CKBinaryWriter w, bool isOpenGroup, LogLevel level, DateTimeStamp logTime, string text, CKTrait tags, CKExceptionData ex, string fileName, int lineNumber ) : void	Binary writes a log entry.

Private Methods

Method	Description
CreateMissingCloseGroup ( DateTimeStamp knownTime ) : ILogEntry
CreateMissingLine ( DateTimeStamp knownTime ) : ILogEntry
CreateMissingOpenGroup ( DateTimeStamp knownTime ) : ILogEntry
DoWriteCloseGroup ( CKBinaryWriter w, StreamLogType t, LogLevel level, DateTimeStamp closeTime, IReadOnlyList conclusions ) : void
DoWriteLog ( CKBinaryWriter w, StreamLogType t, LogLevel level, DateTimeStamp logTime, string text, CKTrait tags, CKExceptionData ex, string fileName, int lineNumber ) : void
IsMissingLogEntry ( ILogEntry entry ) : bool
ReadGroupClosed ( int streamVersion, CKBinaryReader r, StreamLogType t, LogLevel logLevel ) : ILogEntry
ReadLogTypeAndLevel ( BinaryReader r, StreamLogType &t, LogLevel &l ) : void
ReadMulticastFooter ( int streamVersion, CKBinaryReader r, StreamLogType t, Guid &mId, int &depth, LogEntryType &prevType, DateTimeStamp &prevTime ) : void
UpdateTypeWithPrevious ( StreamLogType type, LogEntryType previousEntryType, DateTimeStamp &previousStamp ) : StreamLogType
WriteLogTypeAndLevel ( BinaryWriter w, StreamLogType t, LogLevel level ) : void
WriteMulticastFooter ( CKBinaryWriter w, Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousStamp, int depth ) : void

Method Details

CreateCloseGroup() public static method

Creates a ILogEntry for the closing of a group.

public static CreateCloseGroup ( DateTimeStamp t, LogLevel level, IReadOnlyList c ) : ILogEntry
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
c	IReadOnlyList	Group conclusions.
return	ILogEntry

CreateLog() public static method

Creates a ILogEntry for a line.

public static CreateLog ( string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : ILogEntry
text	string	Text of the log entry.
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
return	ILogEntry

CreateMulticastCloseGroup() public static method

Creates a ILogEntry for the closing of a group.

public static CreateMulticastCloseGroup ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, DateTimeStamp t, LogLevel level, IReadOnlyList c ) : IMulticastLogEntry
monitorId	Guid	Identifier of the monitor.
previousEntryType	LogEntryType	Log type of the previous entry in the monitor..
previousLogTime	DateTimeStamp	Time stamp of the previous entry in the monitor.
depth	int	Depth of the line (number of opened groups above).
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
c	IReadOnlyList	Group conclusions.
return	IMulticastLogEntry

CreateMulticastLog() public static method

Creates a ILogEntry for a line.

public static CreateMulticastLog ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : IMulticastLogEntry
monitorId	Guid	Identifier of the monitor.
previousEntryType	LogEntryType	Log type of the previous entry in the monitor..
previousLogTime	DateTimeStamp	Time stamp of the previous entry in the monitor.
depth	int	Depth of the line (number of opened groups above).
text	string	Text of the log entry.
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
return	IMulticastLogEntry

CreateMulticastOpenGroup() public static method

Creates a ILogEntry for an opened group.

public static CreateMulticastOpenGroup ( Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : IMulticastLogEntry
monitorId	Guid	Identifier of the monitor.
previousEntryType	LogEntryType	Log type of the previous entry in the monitor..
previousLogTime	DateTimeStamp	Time stamp of the previous entry in the monitor.
depth	int	Depth of the line (number of opened groups above).
text	string	Text of the log entry.
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
return	IMulticastLogEntry

CreateOpenGroup() public static method

Creates a ILogEntry for an opened group.

public static CreateOpenGroup ( string text, DateTimeStamp t, LogLevel level, string fileName, int lineNumber, CKTrait tags, CKExceptionData ex ) : ILogEntry
text	string	Text of the log entry.
t	DateTimeStamp	Time stamp of the log entry.
level	LogLevel	Log level of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
return	ILogEntry

Read() static public method

Reads a ILogEntry from the binary reader that can be a IMulticastLogEntry. If the first read byte is 0, read stops and null is returned. The 0 byte is the "end marker" that CKMonWriterClient.Close() write, but this method can read non zero-terminated streams (it catches an EndOfStreamException when reading the first byte and handles it silently). This method can throw any type of exception (System.IO.EndOfStreamException or InvalidDataException for instance) that must be handled by the caller.

static public Read ( CKBinaryReader r, int streamVersion, bool &badEndOfFile ) : ILogEntry
r	CKBinaryReader	The binary reader.
streamVersion	int	The version of the stream.
badEndOfFile	bool	True whenever the end of file is the result of an .
return	ILogEntry

WriteCloseGroup() static public method

Binary writes a multicast closing entry.

static public WriteCloseGroup ( CKBinaryWriter w, Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, LogLevel level, DateTimeStamp closeTime, IReadOnlyList conclusions ) : void
w	CKBinaryWriter	Binary writer to use.
monitorId	Guid	Identifier of the monitor.
previousEntryType	LogEntryType	Log type of the previous entry in the monitor..
previousLogTime	DateTimeStamp	Time stamp of the previous entry in the monitor.
depth	int	Depth of the group (number of opened groups above).
level	LogLevel	Log level of the log entry.
closeTime	DateTimeStamp	Time stamp of the group closing.
conclusions	IReadOnlyList	Group conclusions.
return	void

WriteCloseGroup() static public method

Binary writes a closing entry.

static public WriteCloseGroup ( CKBinaryWriter w, LogLevel level, DateTimeStamp closeTime, IReadOnlyList conclusions ) : void
w	CKBinaryWriter	Binary writer to use.
level	LogLevel	Log level of the log entry.
closeTime	DateTimeStamp	Time stamp of the group closing.
conclusions	IReadOnlyList	Group conclusions.
return	void

WriteLog() static public method

Binary writes a multicast log entry.

static public WriteLog ( CKBinaryWriter w, Guid monitorId, LogEntryType previousEntryType, DateTimeStamp previousLogTime, int depth, bool isOpenGroup, LogLevel level, DateTimeStamp logTime, string text, CKTrait tags, CKExceptionData ex, string fileName, int lineNumber ) : void
w	CKBinaryWriter	Binary writer to use.
monitorId	Guid	Identifier of the monitor.
previousEntryType	LogEntryType	Log type of the previous entry in the monitor..
previousLogTime	DateTimeStamp	Time stamp of the previous entry in the monitor.
depth	int	Depth of the line (number of opened groups above).
isOpenGroup	bool	True if this the opening of a group. False for a line.
level	LogLevel	Log level of the log entry.
logTime	DateTimeStamp	Time stamp of the log entry.
text	string	Text of the log entry.
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
return	void

WriteLog() static public method

Binary writes a log entry.

static public WriteLog ( CKBinaryWriter w, bool isOpenGroup, LogLevel level, DateTimeStamp logTime, string text, CKTrait tags, CKExceptionData ex, string fileName, int lineNumber ) : void
w	CKBinaryWriter	Binary writer to use.
isOpenGroup	bool	True if this the opening of a group. False for a line.
level	LogLevel	Log level of the log entry.
logTime	DateTimeStamp	Time stamp of the log entry.
text	string	Text of the log entry.
tags	CKTrait	Tags of the log entry
ex	CKExceptionData	Exception of the log entry.
fileName	string	Source file name of the log entry
lineNumber	int	Source line number of the log entry
return	void