[This is preliminary documentation and is subject to change.]
The Destination type exposes the following members.Constructors
| Name | Description | |
|---|---|---|
 | Destination | Initializes a new instance of the Destination class |
| Destination(String) | Initializes a new instance of the Destination class |
Methods
| Name | Description | |
|---|---|---|
 | __setComponentDirector | (Inherited from ApplicationComponent.) |
| __setLogSvc | |
| Close |
Deactivates destination
|
| Configure |
Configures specified destination
|
| Destructor | (Overrides ApplicationComponent Destructor .) |
| Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
| DoConfigure |
Override to perform derivative-specific configuration
|
| 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
|
| DoSend |
Performs physical send, i.e. storage in file for FileDestinations
|
| EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
|  Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExternalGetParameter |
Gets external parameter value returning true if parameter was found
|
| ExternalParametersForGroups |
Returns named parameters that can be used to control this component
|
| ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
|
| Finalize | (Inherited from DisposableObject.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| Open |
Activates destination by preparing it to start operation
|
 | ParseLevels |
Parses levels into a tuple list of level ranges
|
| 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
|
| Send |
Sends the message into destination doing filter checks first.
|
| SendRegularAndFailures | |
| SetError |
Notifies log service of exception that surfaced during processing of a particular message
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
Fields
| Name | Description | |
|---|---|---|
 | After |
Allows to insert a destination right after this one
|
| Before |
Allows to insert a destination right before this one
|
| CONFIG_DAYS_OF_WEEK_ATTR | |
| CONFIG_END_DATE_ATTR | |
| CONFIG_END_TIME_ATTR | |
| CONFIG_FAILOVER_ATTR | |
| CONFIG_FILTER_ATTR | |
| CONFIG_GENERATE_FAILOVER_MSG_ATTR | |
| CONFIG_LEVELS_ATTR | |
| CONFIG_MAX_LEVEL_ATTR | |
| CONFIG_MAX_PROCESSING_TIME_MS_ATTR | |
| CONFIG_MAX_PROCESSING_TIME_MS_MIN_VALUE | |
| CONFIG_MIN_LEVEL_ATTR | |
| CONFIG_NAME_ATTR | |
| CONFIG_NAME_DEFAULT | |
| CONFIG_ONLY_FAILURES_ATTR | |
| CONFIG_RESTART_PROCESSING_AFTER_MS_ATTR | |
| CONFIG_RESTART_PROCESSING_AFTER_MS_DEFAULT | |
| CONFIG_START_DATE_ATTR | |
| CONFIG_START_TIME_ATTR | |
| CONFIG_TEST_ON_START_ATTR | |
 | m_Name | |
| m_Owner | |
| PROCESSING_TIME_EMA_FILTER |
Defines how much smoothing the processing time filter does - the lower the number the more smoothing is done.
Smoothing makes MaxProcessingTimeMs detection insensitive to some seldom delays that may happen every now and then
while destination performs actual write into its sink
|
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
|
| 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
|
| DirectorLog | |
| 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
|
| EndTime |
Imposes a filter that specifies the ending time of the day
before which this destination will be processing log messages
|
| ExternalParameters |
Returns named parameters that can be used to control this component
|
| Failover |
Sets destination name used for failover of this one
|
| 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
|
| FilterMethod |
References message filtering method or null
|
| 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.
|
| LastError |
Returns last error that this destination has encountered
|
| Levels | |
| MaxLevel |
Imposes a maximum log level constraint
|
| 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
|
| MinLevel |
Imposes a minimum log level constraint
|
| Name |
Provides mnemonic destination name
|
| 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
|
| Owner |
Returns a composite destination that ownes this destination or null
|
| RestartProcessingAfterMs |
Specifies how much time must pass before processing will be tried to resume after failure.
The default value is 60000 ms
|
| Service |
References a log service that this destination services
|
| StartDate |
Imposes a filter that specifies the starting date and time
after which this destination will start processing log messages
|
| StartTime |
Imposes a filter that specifies the starting time of the day
after which this destination will start processing log messages
|
| 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
|
See Also