Interface ITraceWriter

Defines the interface for a class that provides methods to record an execution flow.

Inherited Members

System.IDisposable.Dispose()

Namespace: Nevatech.Vsb.Repository.Diagnostics

Assembly: Nevatech.Vsb.Repository.dll

Syntax

public interface ITraceWriter : IDisposable

Properties

IsEnabled

Gets flag indicating if tracing is enabled. If false then Write methods do nothing.

Declaration

bool IsEnabled { get; }

Property Value

Type	Description
System.Boolean

Methods

WriteCustomElement(String, String, IDictionary<String, String>)

Writes a custom XML element with provided name, text value, and attributes.

Declaration

void WriteCustomElement(string name, string text, IDictionary<string, string> attributes = null)

Parameters

Type	Name	Description
System.String	name	Element name.
System.String	text	Optional element text (string value).
System.Collections.Generic.IDictionary<System.String, System.String>	attributes	Optional collection of XML attributes where key is the attribute name, and the value is the attribute value.

WriteEnd(TraceMark)

Writes the message indicating the ending of a component execution.

Declaration

void WriteEnd(TraceMark startMark)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.

WriteEnd(TraceMark, Exception, String, Object[])

Writes the message indicating the failing of a component execution.

Declaration

void WriteEnd(TraceMark startMark, Exception exception, string message = null, params object[] args)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.
System.Exception	exception	An exception that component has failed with.
System.String	message	Optional message clarifying the error.
System.Object[]	args	Optional format parameters to the error message.

WriteEnd(TraceMark, Object)

Writes the message indicating the ending of a component execution.

Declaration

void WriteEnd(TraceMark startMark, object result)

Parameters

Type	Name	Description
TraceMark	startMark	An object that was returned when the start message was recorded.
System.Object	result	The result of the component execution to be recorded.

WriteError(Exception, String, Object[])

Writes an exception details to the log.

Declaration

void WriteError(Exception exception, string message = null, params object[] args)

Parameters

Type	Name	Description
System.Exception	exception	Exception to be recorded.
System.String	message	Optional message clarifying the error.
System.Object[]	args	Optional format parameters to the error message.

WriteMessage(String, Object[])

Writes an arbitrary log message.

Declaration

void WriteMessage(string message, params object[] args)

Parameters

Type	Name	Description
System.String	message	Message to be recorded.
System.Object[]	args	Optional format parameters to the log message.

WriteStart(String, String)

Writes the message indicating the beginning of a component execution.

Declaration

TraceMark WriteStart(string name, string id = null)

Parameters

Type	Name	Description
System.String	name	Name of the executing component.
System.String	id	Optional identifier of the executing component.

Returns

Type	Description
TraceMark	An object to be used for writing the ending of the component execution. It carries the component name and execution statistics.

WriteXml(String)

Writes an XML string to the log.

Declaration

void WriteXml(string data)

Parameters

Type	Name	Description
System.String	data	XML string to be recorded.