LogListener

Ecng.Logging

The base class that monitors the event Log and saves to some storage.

继承自: Disposable

实现: ILogListener, IPersistable, IDisposable, IAsyncLogListener

构造函数

LogListener
protected LogListener()
logListener = LogListener()

Initialize LogListener.

属性

CanSave
public virtual bool CanSave { get; }
value = logListener.CanSave

Can save listener.

DateFormat
public string DateFormat { get; set; }
value = logListener.DateFormat
logListener.DateFormat = value

Date format. By default yyyy/MM/dd.

Filters
public IList<Func<LogMessage, bool>> Filters { get; }
value = logListener.Filters

Messages filters that specify which messages should be handled.

IsLocalTime
public bool IsLocalTime { get; set; }
value = logListener.IsLocalTime
logListener.IsLocalTime = value

To convert message time to local time.

TimeFormat
public string TimeFormat { get; set; }
value = logListener.TimeFormat
logListener.TimeFormat = value

Time format. By default HH:mm:ss.fff.

方法

ConvertToLocalTime
protected virtual DateTime ConvertToLocalTime(DateTime time)
result = logListener.ConvertToLocalTime(time)

To convert message time to local time.

time
A time to convert.

返回值: Converted time.

Load
public virtual void Load(SettingsStorage storage)
logListener.Load(storage)

Load settings.

storage
Settings storage.
OnWriteMessage
protected virtual void OnWriteMessage(LogMessage message)
logListener.OnWriteMessage(message)

To record a message.

message
A debug message.
OnWriteMessages
protected virtual void OnWriteMessages(IEnumerable<LogMessage> messages)
logListener.OnWriteMessages(messages)

To record messages.

messages
Debug messages.
OnWriteMessagesAsync
protected virtual ValueTask OnWriteMessagesAsync(IEnumerable<LogMessage> messages, CancellationToken cancellationToken)
result = logListener.OnWriteMessagesAsync(messages, cancellationToken)

To record messages asynchronously.

messages
Debug messages.
cancellationToken
Cancellation token.

返回值: A task that represents the asynchronous write operation.

Save
public virtual void Save(SettingsStorage storage)
logListener.Save(storage)

Save settings.

storage
Settings storage.
WriteMessages
public void WriteMessages(IEnumerable<LogMessage> messages)
logListener.WriteMessages(messages)

To record messages.

messages
Debug messages.
WriteMessagesAsync
public virtual ValueTask WriteMessagesAsync(IEnumerable<LogMessage> messages, CancellationToken cancellationToken)
result = logListener.WriteMessagesAsync(messages, cancellationToken)

To record messages asynchronously.

messages
Debug messages.
cancellationToken
Cancellation token.

返回值: A task that represents the asynchronous write operation.