Class ActivityMonitorOutput

Implementation of IActivityMonitorOutput for Output.

Inheritance
Object
ActivityMonitorOutput
Inherited Members
Namespace: CK.Core.Impl
Assembly: CK.ActivityMonitor.dll
Syntax
public class ActivityMonitorOutput : IActivityMonitorOutput

Constructors

| Improve this Doc View Source

ActivityMonitorOutput(IActivityMonitorImpl)

Initializes a new ActivityMonitorOutput bound to a IActivityMonitor.

Declaration
public ActivityMonitorOutput(IActivityMonitorImpl monitor)
Parameters
Type Name Description
IActivityMonitorImpl monitor

Properties

| Improve this Doc View Source

BridgeTarget

Gets an entry point for other monitors: by registering ActivityMonitorBridge in other Output bound to this ActivityMonitorBridgeTarget, log streams can easily be merged.

Declaration
public ActivityMonitorBridgeTarget BridgeTarget { get; }
Property Value
Type Description
ActivityMonitorBridgeTarget
Implements
| Improve this Doc View Source

Clients

Gets the list of registered IActivityMonitorClient.

Declaration
public IReadOnlyList<IActivityMonitorClient> Clients { get; }
Property Value
Type Description
IReadOnlyList<IActivityMonitorClient>
Implements
| Improve this Doc View Source

Monitor

Gets the associated IActivityMonitor.

Declaration
protected IActivityMonitorImpl Monitor { get; }
Property Value
Type Description
IActivityMonitorImpl

Methods

| Improve this Doc View Source

RegisterClient(IActivityMonitorClient, out Boolean)

Registers an IActivityMonitorClient to the Clients list. Duplicate IActivityMonitorClient are silently ignored.

Declaration
public IActivityMonitorClient RegisterClient(IActivityMonitorClient client, out bool added)
Parameters
Type Name Description
IActivityMonitorClient client

An IActivityMonitorClient implementation.
Boolean added

True if the client has been added, false if it was already registered.
Returns
Type Description
IActivityMonitorClient

The registered client.
Implements
| Improve this Doc View Source

RegisterClient<T>(T, out Boolean)

Registers a typed IActivityMonitorClient.

Declaration
public T RegisterClient<T>(T client, out bool added)where T : IActivityMonitorClient
Parameters
Type Name Description
T client

Clients to register.
Boolean added

True if the client has been added, false if it was already registered.
Returns
Type Description
T

The registered client.
Type Parameters
Name Description
T

Any type that specializes IActivityMonitorClient.
Implements
| Improve this Doc View Source

RegisterUniqueClient<T>(Func<T, Boolean>, Func<T>)

Registers a IActivityMonitorClient that must be unique in a sense.

Declaration
public T RegisterUniqueClient<T>(Func<T, bool> tester, Func<T> factory)where T : IActivityMonitorClient
Parameters
Type Name Description
Func<T, Boolean> tester

Predicate that must be satisfied for at least one registered client.
Func<T> factory

Factory that will be called if no existing client satisfies tester.
Returns
Type Description
T

The existing or newly created client or null if the factory returned null.
Type Parameters
Name Description
T
Implements
Remarks

The factory function MUST return null OR a client that satisfies the tester function otherwise a InvalidOperationException is thrown. When null is returned by the factory function, nothing is added and null is returned. The factory is called only when the no client satisfies the tester function: this makes the 'added' out parameter useless.

| Improve this Doc View Source

UnregisterClient(IActivityMonitorClient)

Unregisters the given IActivityMonitorClient from the Clients list. Silently ignores unregistered client.

Declaration
public IActivityMonitorClient UnregisterClient(IActivityMonitorClient client)
Parameters
Type Name Description
IActivityMonitorClient client

An IActivityMonitorClient implementation.
Returns
Type Description
IActivityMonitorClient

The unregistered client or null if it has not been found.
Implements

Extension Methods