C# Class CK.Core.ActivityMonitorClient

Inheritance: IActivityMonitorClient

Mostra file Open project: Invenietis/ck-core Class Usage Examples

Public Properties

Property	Type	Description
Empty	ActivityMonitorClient

Public Methods

Method	Description
ActivityMonitorClient ( ) : System	Initialize a new ActivityMonitorClient that does nothing.
CreateMultipleRegisterOnBoundClientException ( IActivityMonitorBoundClient boundClient ) : InvalidOperationException	Creates a standardized exception that can be thrown by IActivityMonitorBoundClient.SetMonitor.

Protected Methods

Method	Description
OnAutoTagsChanged ( CKTrait newTags ) : void	Called when IActivityMonitor.AutoTags changed. Does nothing by default.
OnGroupClosed ( IActivityLogGroup group, IReadOnlyList conclusions ) : void	Called when the group is actually closed. Does nothing by default.
OnGroupClosing ( IActivityLogGroup group, List &conclusions ) : void	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.
OnOpenGroup ( IActivityLogGroup group ) : void	Called for each IActivityMonitor.UnfilteredOpenGroup. Does nothing by default.
OnTopicChanged ( string newTopic, string fileName, int lineNumber ) : void	Called when IActivityMonitor.Topic changed. Does nothing by default.
OnUnfilteredLog ( ActivityMonitorLogData data ) : void	Called for each IActivityMonitor.UnfilteredLog. Does nothing by default. The ActivityMonitorLogData.Exception is always null since exceptions are carried by groups.

Private Methods

Method	Description
IActivityMonitorClient ( ActivityMonitorLogData data ) : void
IActivityMonitorClient ( CKTrait newTags ) : void
IActivityMonitorClient ( IActivityLogGroup group ) : void
IActivityMonitorClient ( IActivityLogGroup group, IReadOnlyList conclusions ) : void
IActivityMonitorClient ( IActivityLogGroup group, List &conclusions ) : void
IActivityMonitorClient ( string newTopic, string fileName, int lineNumber ) : void

Method Details

ActivityMonitorClient() public method

Initialize a new ActivityMonitorClient that does nothing.

public ActivityMonitorClient ( ) : System
return	System

CreateMultipleRegisterOnBoundClientException() static public method

Creates a standardized exception that can be thrown by IActivityMonitorBoundClient.SetMonitor.

static public CreateMultipleRegisterOnBoundClientException ( IActivityMonitorBoundClient boundClient ) : InvalidOperationException
boundClient	IActivityMonitorBoundClient	The bound client.
return	System.InvalidOperationException

OnAutoTagsChanged() protected method

Called when IActivityMonitor.AutoTags changed. Does nothing by default.

protected OnAutoTagsChanged ( CKTrait newTags ) : void
newTags	CKTrait	The new auto tags.
return	void

OnGroupClosed() protected method

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

protected OnGroupClosed ( IActivityLogGroup group, IReadOnlyList conclusions ) : void
group	IActivityLogGroup	The closed group.
conclusions	IReadOnlyList	Text that conclude the group. Never null but can be empty.
return	void

OnGroupClosing() protected method

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.

protected OnGroupClosing ( IActivityLogGroup group, List &conclusions ) : void
group	IActivityLogGroup	The closing group.
conclusions	List	/// 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. ///
return	void

OnOpenGroup() protected method

Called for each IActivityMonitor.UnfilteredOpenGroup. Does nothing by default.

protected OnOpenGroup ( IActivityLogGroup group ) : void
group	IActivityLogGroup	The newly opened .
return	void

OnTopicChanged() protected method

Called when IActivityMonitor.Topic changed. Does nothing by default.

protected OnTopicChanged ( string newTopic, string fileName, int lineNumber ) : void
newTopic	string	The new topic.
fileName	string	Source file name where has been called.
lineNumber	int	Source line number where IActivityMonitor.SetTopic has been called.
return	void

OnUnfilteredLog() protected method

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

protected OnUnfilteredLog ( ActivityMonitorLogData data ) : void
data	ActivityMonitorLogData	Log data. Never null.
return	void

Property Details

Empty public_oe static_oe property

Empty IActivityMonitorClient (null object design pattern).

public static ActivityMonitorClient,CK.Core Empty
return	ActivityMonitorClient