[This is preliminary documentation and is subject to change.]
The MemoryBufferDestination type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | MemoryBufferDestination | Initializes a new instance of the MemoryBufferDestination class |
![]() | MemoryBufferDestination(String) | Initializes a new instance of the MemoryBufferDestination class |
Methods
Name | Description | |
---|---|---|
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | __setLogSvc | (Inherited from Destination.) |
![]() | ClearBuffer |
Deletes all buffered messages
|
![]() | Close | (Overrides Destination Close .) |
![]() | Configure |
Configures specified destination
(Inherited from Destination.) |
![]() | Destructor | (Overrides Destination Destructor .) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoConfigure |
Override to perform derivative-specific configuration
(Inherited from Destination.) |
![]() | DoPulse |
Provides periodic notification of destinations from central Log thread even if there are no messages to write.
Override to commit internal batching buffers provided by particular destinations
(Inherited from Destination.) |
![]() | DoSend | (Overrides Destination DoSend(Message).) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
(Inherited from Destination.) |
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
(Inherited from Destination.) |
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
(Inherited from Destination.) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Open | (Overrides Destination Open .) |
![]() | Pulse |
Provides periodic notification of destinations from central Log thread even if there are no messages to write.
Override DoPulse to commit internal batching buffers provided by particular destinations
(Inherited from Destination.) |
![]() | Send |
Sends the message into destination doing filter checks first.
(Inherited from Destination.) |
![]() | SendRegularAndFailures | (Inherited from Destination.) |
![]() | SetError |
Notifies log service of exception that surfaced during processing of a particular message
(Inherited from Destination.) |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | After |
Allows to insert a destination right after this one
(Inherited from Destination.) |
![]() | Before |
Allows to insert a destination right before this one
(Inherited from Destination.) |
![]() ![]() | BUFFER_SIZE_DEFAULT | |
![]() | m_Name | (Inherited from Destination.) |
![]() | m_Owner | (Inherited from Destination.) |
Properties
Name | Description | |
---|---|---|
![]() | AverageProcessingTimeMs |
Returns average time it takes destination implementation to write the log message to actual sink.
This property is only computed when MaxProcessingTimeMs limit is imposed, otherwise it returns 0f
(Inherited from Destination.) |
![]() | Buffered |
Returns all buffered log messages, where X = BufferSize property
|
![]() | BufferedTimeAscending |
Returns all buffered log messages ordered by timestamp ascending
|
![]() | BufferedTimeDescending |
Returns all buffered log messages ordered by timestamp descending
|
![]() | BufferSize | |
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | DaysOfWeek |
Imposes a filter on days when this destination handles messages
(Inherited from Destination.) |
![]() | DirectorLog | (Inherited from Destination.) |
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | EndDate |
Imposes a filter that specifies the ending date and time
before which this destination will be processing log messages
(Inherited from Destination.) |
![]() | EndTime |
Imposes a filter that specifies the ending time of the day
before which this destination will be processing log messages
(Inherited from Destination.) |
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
(Inherited from Destination.) |
![]() | Failover |
Sets destination name used for failover of this one
(Inherited from Destination.) |
![]() | Filter |
Gets/sets filter expression for this destination.
Filter expressions get dynamically compiled into filter assembly,
consequently it is not a good practice to create too many different filters.
Filters are heavyweight, and it is advisable to use them ONLY WHEN regular destination filtering (using Min/Max levels, dates and times) can not be used
to achieve the desired result
(Inherited from Destination.) |
![]() | FilterMethod |
References message filtering method or null
(Inherited from Destination.) |
![]() | GenerateFailoverMessages |
Determines whether additional co-related error message should be generated when this destination fails or when it is
used as failover by some other destination. When this property is true an additional error message gets written into failover destination that
describes what message caused failure (error is co-related to original) at what destination. False by default.
(Inherited from Destination.) |
![]() | LastError |
Returns last error that this destination has encountered
(Inherited from Destination.) |
![]() | Levels | (Inherited from Destination.) |
![]() | MaxLevel |
Imposes a maximum log level constraint
(Inherited from Destination.) |
![]() | MaxProcessingTimeMs |
Imposes a time limit on internal message processing (writing into actual sink) by this destination.
If this limit is exceeded, this destination fails and processing is re-tried to be resumed after RestartProcessingAfterMs interval.
The minimum value for this property is 25 ms as lower values compromise timer accuracy
(Inherited from Destination.) |
![]() | MinLevel |
Imposes a minimum log level constraint
(Inherited from Destination.) |
![]() | Name |
Provides mnemonic destination name
(Inherited from Destination.) |
![]() | OnlyFailures |
Indicates whether this destination should only process failures - messages that crashed other destinations.
When set to true regular messages (dispatched by Send(msg)) are ignored
(Inherited from Destination.) |
![]() | Owner |
Returns a composite destination that ownes this destination or null
(Inherited from Destination.) |
![]() | RestartProcessingAfterMs |
Specifies how much time must pass before processing will be tried to resume after failure.
The default value is 60000 ms
(Inherited from Destination.) |
![]() | Service |
References a log service that this destination services
(Inherited from Destination.) |
![]() | StartDate |
Imposes a filter that specifies the starting date and time
after which this destination will start processing log messages
(Inherited from Destination.) |
![]() | StartTime |
Imposes a filter that specifies the starting time of the day
after which this destination will start processing log messages
(Inherited from Destination.) |
![]() | TestOnStart |
Indicates whether this destination should try to test the underlying sink on startup.
For example DB-based destinations will try to connect to server upon log service launch when this property is true
(Inherited from Destination.) |
See Also