 | LimitingTargetWrapper Class |
Limits the number of messages written per timespan to the wrapped target.
Inheritance HierarchySystemObject
NLog.TargetsTarget
NLog.Targets.WrappersWrapperTargetBase
NLog.Targets.WrappersLimitingTargetWrapper
NLog.TargetsTarget
NLog.Targets.WrappersWrapperTargetBase
NLog.Targets.WrappersLimitingTargetWrapper
Namespace: NLog.Targets.Wrappers
Assembly: NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
SyntaxThe LimitingTargetWrapper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LimitingTargetWrapper |
Initializes a new instance of the LimitingTargetWrapper class.
|
| LimitingTargetWrapper(Target) |
Initializes a new instance of the LimitingTargetWrapper class.
|
| LimitingTargetWrapper(String, Target) |
Initializes a new instance of the LimitingTargetWrapper class.
|
| LimitingTargetWrapper(Target, Int32, TimeSpan) |
Initializes a new instance of the LimitingTargetWrapper class.
|
Properties| Name | Description | |
|---|---|---|
 | Interval |
Gets or sets the interval in which messages will be written up to the MessageLimit number of messages.
|
 | IsInitialized |
Gets a value indicating whether the target has been initialized.
(Inherited from Target.) |
| LoggingConfiguration |
Gets the logging configuration this target is part of.
(Inherited from Target.) |
| MessageLimit |
Gets or sets the maximum allowed number of messages written per Interval.
|
| MessagesWrittenCount |
Gets the number of AsyncLogEventInfo written in the current Interval.
|
| Name |
Gets or sets the name of the target.
(Inherited from Target.) |
| SyncRoot |
Gets the object which can be used to synchronize asynchronous operations that must rely on the .
(Inherited from Target.) |
| WrappedTarget |
Gets or sets the target that is wrapped by this target.
(Inherited from WrapperTargetBase.) |
Methods| Name | Description | |
|---|---|---|
 | CloseTarget |
Closes the target to release any initialized resources
(Inherited from Target.) |
| Dispose |
Closes the target.
(Inherited from Target.) |
| Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
(Inherited from Target.) |
| Flush |
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.) |
| FlushAsync |
Flush any pending log messages
(Inherited from WrapperTargetBase.) |
| InitializeTarget |
Initializes the target and resets the current Interval and MessagesWrittenCount.
(Overrides TargetInitializeTarget.) |
| PrecalculateVolatileLayouts |
Calls the Precalculate(LogEventInfo) on each volatile layout
used by this target.
This method won't prerender if all layouts in this target are thread-agnostic.
(Inherited from Target.) |
| RenderLogEvent(Layout, LogEventInfo) |
Renders the logevent into a string-result using the provided layout
(Inherited from Target.) |
| RenderLogEventT(LayoutT, LogEventInfo, T) |
Renders the logevent into a result-value by using the provided layout
(Inherited from Target.) |
| ResolveServiceT |
Resolve from DI ServiceRepository (Inherited from Target.) |
| ToString | Returns a string that represents the current object. (Inherited from WrapperTargetBase.) |
| Write(AsyncLogEventInfo) |
Writes log event to the wrapped target if the current MessagesWrittenCount is lower than MessageLimit.
If the MessageLimit is already reached, no log event will be written to the wrapped target.
MessagesWrittenCount resets when the current Interval is expired.
(Overrides TargetWrite(AsyncLogEventInfo).) |
| Write(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target. By default it iterates on all
events and passes them to "Write" method. Inheriting classes can use this method to
optimize batch writes.
(Inherited from Target.) |
| Write(LogEventInfo) |
Writes logging event to the log target. Must be overridden in inheriting
classes.
(Inherited from WrapperTargetBase.) |
| WriteAsyncLogEvent |
Writes the log to the target.
(Inherited from Target.) |
| WriteAsyncLogEvents(AsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) |
| WriteAsyncLogEvents(IListAsyncLogEventInfo) |
Writes the array of log events.
(Inherited from Target.) |
| WriteAsyncThreadSafe(AsyncLogEventInfo) |
Writes a log event to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) |
| WriteAsyncThreadSafe(IListAsyncLogEventInfo) |
Writes an array of logging events to the log target, in a thread safe manner.
Any override of this method has to provide their own synchronization mechanism.
!WARNING! Custom targets should only override this method if able to provide their
own synchronization mechanism. Layout-objects are not guaranteed to be
thread-safe, so using them without a SyncRoot-object can be dangerous.
(Inherited from Target.) |
| WriteFailedNotInitialized |
LogEvent is written to target, but target failed to successfully initialize
(Inherited from Target.) |
RemarksSee Also