C# Class NLog.Targets.Target

Represents logging target.
Inheritance: ISupportsInitialize, INLogConfigurationItem, IDisposable
Show file Open project: shiftkey/winrt-backport-hilarity Class Usage Examples

Public Methods

Method Description
Dispose ( ) : void

Closes the target.

Flush ( AsyncContinuation asyncContinuation ) : void

Flush any pending log messages (in case of asynchronous targets).

PrecalculateVolatileLayouts ( LogEventInfo logEvent ) : void

Calls the Layout.Precalculate on each volatile layout used by this target.

ToString ( ) : string

Returns a System.String that represents this instance.

WriteAsyncLogEvent ( NLog.Common.AsyncLogEventInfo logEvent ) : void

Writes the log to the target.

WriteAsyncLogEvents ( ) : void

Writes the array of log events.

Protected Methods

Method Description
CloseTarget ( ) : void

Closes the target and releases any unmanaged resources.

Dispose ( bool disposing ) : void

Releases unmanaged and - optionally - managed resources.

FlushAsync ( AsyncContinuation asyncContinuation ) : void

Flush any pending log messages asynchronously (in case of asynchronous targets).

InitializeTarget ( ) : void

Initializes the target. Can be used by inheriting classes to initialize logging.

Write ( NLog.Common.AsyncLogEventInfo logEvent ) : void

Writes log event to the log target. Must be overridden in inheriting classes.

Write ( LogEventInfo logEvent ) : void

Writes logging event to the log target. classes.

Private Methods

Method Description
Close ( ) : void

Closes this instance.

CreateInitException ( ) : Exception
GetAllLayouts ( ) : void
ISupportsInitialize ( ) : void

Closes this instance.

ISupportsInitialize ( LoggingConfiguration configuration ) : void

Initializes this instance.

Initialize ( LoggingConfiguration configuration ) : void

Initializes this instance.

WriteAsyncLogEvents ( NLog.Common.AsyncLogEventInfo logEventInfos, AsyncContinuation continuation ) : void

Method Details

CloseTarget() protected method

Closes the target and releases any unmanaged resources.
protected CloseTarget ( ) : void
return void

Dispose() public method

Closes the target.
public Dispose ( ) : void
return void

Dispose() protected method

Releases unmanaged and - optionally - managed resources.
protected Dispose ( bool disposing ) : void
disposing bool True to release both managed and unmanaged resources; false to release only unmanaged resources.
return void

Flush() public method

Flush any pending log messages (in case of asynchronous targets).
public Flush ( AsyncContinuation asyncContinuation ) : void
asyncContinuation AsyncContinuation The asynchronous continuation.
return void

FlushAsync() protected method

Flush any pending log messages asynchronously (in case of asynchronous targets).
protected FlushAsync ( AsyncContinuation asyncContinuation ) : void
asyncContinuation AsyncContinuation The asynchronous continuation.
return void

InitializeTarget() protected method

Initializes the target. Can be used by inheriting classes to initialize logging.
protected InitializeTarget ( ) : void
return void

PrecalculateVolatileLayouts() public method

Calls the Layout.Precalculate on each volatile layout used by this target.
public PrecalculateVolatileLayouts ( LogEventInfo logEvent ) : void
logEvent LogEventInfo /// The log event. ///
return void

ToString() public method

Returns a System.String that represents this instance.
public ToString ( ) : string
return string

Write() protected method

Writes log event to the log target. Must be overridden in inheriting classes.
protected Write ( NLog.Common.AsyncLogEventInfo logEvent ) : void
logEvent NLog.Common.AsyncLogEventInfo Log event to be written out.
return void

Write() protected method

Writes logging event to the log target. classes.
protected Write ( LogEventInfo logEvent ) : void
logEvent LogEventInfo /// Logging event to be written out. ///
return void

WriteAsyncLogEvent() public method

Writes the log to the target.
public WriteAsyncLogEvent ( NLog.Common.AsyncLogEventInfo logEvent ) : void
logEvent NLog.Common.AsyncLogEventInfo Log event to write.
return void

WriteAsyncLogEvents() public method

Writes the array of log events.
public WriteAsyncLogEvents ( ) : void
return void