C# Class NContext.Extensions.Logging.Targets.LogTargetBase

Defines a log target abstraction.
Inheritance: ILogTarget
Show file Open project: PowerDMS/NContext

Public Methods

Method Description
Complete ( ) : void

Signals to the T:System.Threading.Tasks.Dataflow.IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.
Fault ( Exception exception ) : void

Causes the T:System.Threading.Tasks.Dataflow.IDataflowBlock to complete in a F:System.Threading.Tasks.TaskStatus.Faulted state.
OfferMessage ( DataflowMessageHeader messageHeader, LogEntry messageValue, ISourceBlock source, System.Boolean consumeToAccept ) : DataflowMessageStatus

Offers the message.
ShouldLog ( LogEntry logEntry ) : System.Boolean

Predicate which determines whether or not the target instance should log this entry.

Protected Methods

Method Description
Log ( LogEntry logEntry ) : void

Logs the specified log entry.
LogTargetBase ( ) : System

Initializes a new instance of the LogTargetBase class.
LogTargetBase ( Int32 maxDegreeOfParallelism ) : System

Initializes a new instance of the LogTargetBase class.

Method Details

Complete() public method

Signals to the T:System.Threading.Tasks.Dataflow.IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.
public Complete ( ) : void
return void

Fault() public method

Causes the T:System.Threading.Tasks.Dataflow.IDataflowBlock to complete in a F:System.Threading.Tasks.TaskStatus.Faulted state.
public Fault ( Exception exception ) : void
exception System.Exception The that caused the faulting.
return void

Log() protected abstract method

Logs the specified log entry.
protected abstract Log ( LogEntry logEntry ) : void
logEntry LogEntry The log entry.
return void

LogTargetBase() protected method

Initializes a new instance of the LogTargetBase class.
protected LogTargetBase ( ) : System
return System

LogTargetBase() protected method

Initializes a new instance of the LogTargetBase class.
protected LogTargetBase ( Int32 maxDegreeOfParallelism ) : System
maxDegreeOfParallelism System.Int32 /// The max degree of parallelism the target instance will log entries (ie. method). ///
return System

OfferMessage() public method

Offers the message.
public OfferMessage ( DataflowMessageHeader messageHeader, LogEntry messageValue, ISourceBlock source, System.Boolean consumeToAccept ) : DataflowMessageStatus
messageHeader DataflowMessageHeader The message header.
messageValue LogEntry The message value.
source ISourceBlock The source.
consumeToAccept System.Boolean The consume to accept.
return DataflowMessageStatus

ShouldLog() public abstract method

Predicate which determines whether or not the target instance should log this entry.
public abstract ShouldLog ( LogEntry logEntry ) : System.Boolean
logEntry LogEntry The log entry.
return System.Boolean