Class ActivityMonitorClient

Base class that explicitly implements IActivityMonitorClient (to hide it from public interface, except its MinimalFilter).

Inheritance
Object
ActivityMonitorClient
ActivityMonitorErrorCounter
ActivityMonitorPathCatcher
Inherited Members
Namespace: CK.Core
Assembly: CK.ActivityMonitor.dll
Syntax
public class ActivityMonitorClient : IActivityMonitorClient

Constructors

| Improve this Doc View Source

ActivityMonitorClient()

Initialize a new ActivityMonitorClient that does nothing.

Declaration
public ActivityMonitorClient()

Fields

| Improve this Doc View Source

Empty

Empty IActivityMonitorClient (null object design pattern).

Declaration
public static readonly ActivityMonitorClient Empty
Field Value
Type Description
ActivityMonitorClient

Properties

| Improve this Doc View Source

MinimalFilter

Gets the minimal log level that this Client expects: defaults to Undefined.

Declaration
public virtual LogFilter MinimalFilter { get; }
Property Value
Type Description
LogFilter

Methods

| Improve this Doc View Source

CreateMultipleRegisterOnBoundClientException(IActivityMonitorBoundClient)

Creates a standardized exception that can be thrown by SetMonitor(IActivityMonitorImpl, Boolean).

Declaration
public static InvalidOperationException CreateMultipleRegisterOnBoundClientException(IActivityMonitorBoundClient boundClient)
Parameters
Type Name Description
IActivityMonitorBoundClient boundClient

The bound client.
Returns
Type Description
InvalidOperationException

An exception with an explicit message.
| Improve this Doc View Source

OnAutoTagsChanged(CKTrait)

Called when AutoTags changed. Does nothing by default.

Declaration
protected virtual void OnAutoTagsChanged(CKTrait newTags)
Parameters
Type Name Description
CK.Core.CKTrait newTags

The new auto tags.
| Improve this Doc View Source

OnGroupClosed(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)

Called when the group is actually closed. Does nothing by default.

Declaration
protected virtual void OnGroupClosed(IActivityLogGroup group, IReadOnlyList<ActivityLogGroupConclusion> conclusions)
Parameters
Type Name Description
IActivityLogGroup group

The closed group.
IReadOnlyList<ActivityLogGroupConclusion> conclusions

Text that conclude the group. Never null but can be empty.
| Improve this Doc View Source

OnGroupClosing(IActivityLogGroup, ref List<ActivityLogGroupConclusion>)

Called once the user conclusions are known at the group level but before the group is actually closed: clients can update the conclusions for the group. Does nothing by default.

Declaration
protected virtual void OnGroupClosing(IActivityLogGroup group, ref List<ActivityLogGroupConclusion> conclusions)
Parameters
Type Name Description
IActivityLogGroup group

The closing group.
List<ActivityLogGroupConclusion> conclusions

Mutable conclusions associated to the closing group. This can be null if no conclusions have been added yet. It is up to the first client that wants to add a conclusion to instantiate a new List object to carry the conclusions.
| Improve this Doc View Source

OnOpenGroup(IActivityLogGroup)

Called for each UnfilteredOpenGroup(ActivityMonitorGroupData). Does nothing by default.

Declaration
protected virtual void OnOpenGroup(IActivityLogGroup group)
Parameters
Type Name Description
IActivityLogGroup group

The newly opened IActivityLogGroup.
| Improve this Doc View Source

OnTopicChanged(String, String, Int32)

Called when Topic changed. Does nothing by default.

Declaration
protected virtual void OnTopicChanged(string newTopic, string fileName, int lineNumber)
Parameters
Type Name Description
String newTopic

The new topic.
String fileName

Source file name where SetTopic(String, String, Int32) has been called.
Int32 lineNumber

Source line number where IActivityMonitor.SetTopic has been called.
| Improve this Doc View Source

OnUnfilteredLog(ActivityMonitorLogData)

Called for each UnfilteredLog(ActivityMonitorLogData). Does nothing by default. The Exception is always null since exceptions are carried by groups.

Declaration
protected virtual void OnUnfilteredLog(ActivityMonitorLogData data)
Parameters
Type Name Description
ActivityMonitorLogData data

Log data. Never null.

Explicit Interface Implementations

| Improve this Doc View Source

IActivityMonitorClient.OnAutoTagsChanged(CKTrait)

Declaration
void IActivityMonitorClient.OnAutoTagsChanged(CKTrait newTags)
Parameters
Type Name Description
CK.Core.CKTrait newTags
Implements
| Improve this Doc View Source

IActivityMonitorClient.OnGroupClosed(IActivityLogGroup, IReadOnlyList<ActivityLogGroupConclusion>)

Declaration
void IActivityMonitorClient.OnGroupClosed(IActivityLogGroup group, IReadOnlyList<ActivityLogGroupConclusion> conclusions)
Parameters
Type Name Description
IActivityLogGroup group
IReadOnlyList<ActivityLogGroupConclusion> conclusions
Implements
| Improve this Doc View Source

IActivityMonitorClient.OnGroupClosing(IActivityLogGroup, ref List<ActivityLogGroupConclusion>)

Declaration
void IActivityMonitorClient.OnGroupClosing(IActivityLogGroup group, ref List<ActivityLogGroupConclusion> conclusions)
Parameters
Type Name Description
IActivityLogGroup group
List<ActivityLogGroupConclusion> conclusions
Implements
| Improve this Doc View Source

IActivityMonitorClient.OnOpenGroup(IActivityLogGroup)

Declaration
void IActivityMonitorClient.OnOpenGroup(IActivityLogGroup group)
Parameters
Type Name Description
IActivityLogGroup group
Implements
| Improve this Doc View Source

IActivityMonitorClient.OnTopicChanged(String, String, Int32)

Declaration
void IActivityMonitorClient.OnTopicChanged(string newTopic, string fileName, int lineNumber)
Parameters
Type Name Description
String newTopic
String fileName
Int32 lineNumber
Implements
| Improve this Doc View Source

IActivityMonitorClient.OnUnfilteredLog(ActivityMonitorLogData)

Declaration
void IActivityMonitorClient.OnUnfilteredLog(ActivityMonitorLogData data)
Parameters
Type Name Description
ActivityMonitorLogData data
Implements