TextFileDestination MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The TextFileDestination type exposes the following members.
Constructors

  NameDescription
Protected methodTextFileDestination
Initializes a new instance of the TextFileDestination class
Back to Top
Methods

  NameDescription
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected method__setLogSvc (Inherited from Destination.)
Public methodClose (Inherited from FileDestination.)
Public methodConfigure
Configures specified destination
(Inherited from Destination.)
Protected methodDestructor (Inherited from Destination.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoCloseStream (Overrides FileDestination DoCloseStream .)
Protected methodDoConfigure
Override to perform derivative-specific configuration
(Inherited from Destination.)
Protected methodDoFormatMessage
Called when message is to be written to stream
Protected methodDoOpenStream (Overrides FileDestination DoOpenStream .)
Protected methodDoPulse (Overrides FileDestination DoPulse .)
Protected methodDoSend
Override DoFormatMessage() instead
(Inherited from FileDestination.)
Protected methodDoWriteMessage
Warning: don't override this method in derived destinations, use DoFormatMessage() instead!
(Overrides FileDestination DoWriteMessage(Message).)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from Destination.)
Public methodExternalParametersForGroups
Returns named parameters that can be used to control this component
(Inherited from Destination.)
Public methodExternalSetParameter
Sets external parameter value returning true if parameter was found and set
(Inherited from Destination.)
Protected methodFinalize (Inherited from DisposableObject.)
Protected methodGetDestinationFileName (Inherited from FileDestination.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOpen (Inherited from FileDestination.)
Public methodPulse
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.)
Public methodSend
Sends the message into destination doing filter checks first.
(Inherited from Destination.)
Protected methodSendRegularAndFailures (Inherited from Destination.)
Protected methodSetError
Notifies log service of exception that surfaced during processing of a particular message
(Inherited from Destination.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldAfter
Allows to insert a destination right after this one
(Inherited from Destination.)
Public fieldBefore
Allows to insert a destination right before this one
(Inherited from Destination.)
Protected fieldm_FileName (Inherited from FileDestination.)
Protected fieldm_Name (Inherited from Destination.)
Protected fieldm_Owner (Inherited from Destination.)
Protected fieldm_Path (Inherited from FileDestination.)
Protected fieldm_Stream (Inherited from FileDestination.)
Back to Top
Properties

  NameDescription
Public propertyAverageProcessingTimeMs
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.)
Public propertyComponentCommonName
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.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Public propertyDaysOfWeek
Imposes a filter on days when this destination handles messages
(Inherited from Destination.)
Protected propertyDefaultFileName (Inherited from FileDestination.)
Public propertyDirectorLog (Inherited from Destination.)
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyEndDate
Imposes a filter that specifies the ending date and time before which this destination will be processing log messages
(Inherited from Destination.)
Public propertyEndTime
Imposes a filter that specifies the ending time of the day before which this destination will be processing log messages
(Inherited from Destination.)
Public propertyExternalParameters
Returns named parameters that can be used to control this component
(Inherited from Destination.)
Public propertyFailover
Sets destination name used for failover of this one
(Inherited from Destination.)
Public propertyFileName
File name may include environment variables (e.g. ~home), and use macros to specify time "$(~home)$(@::now fmt=yyyyMMdd utc=false)-$($name).log". Pass "utc=true" argument to use UTC
(Inherited from FileDestination.)
Public propertyFilter
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.)
Public propertyFilterMethod
References message filtering method or null
(Inherited from Destination.)
Public propertyGenerateFailoverMessages
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.)
Public propertyLastError
Returns last error that this destination has encountered
(Inherited from Destination.)
Public propertyLevels (Inherited from Destination.)
Public propertyMaxLevel
Imposes a maximum log level constraint
(Inherited from Destination.)
Public propertyMaxProcessingTimeMs
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.)
Public propertyMinLevel
Imposes a minimum log level constraint
(Inherited from Destination.)
Public propertyName
Provides mnemonic destination name
(Inherited from Destination.)
Public propertyOnlyFailures
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.)
Public propertyOwner
Returns a composite destination that ownes this destination or null
(Inherited from Destination.)
Public propertyPath (Inherited from FileDestination.)
Public propertyRestartProcessingAfterMs
Specifies how much time must pass before processing will be tried to resume after failure. The default value is 60000 ms
(Inherited from Destination.)
Public propertyService
References a log service that this destination services
(Inherited from Destination.)
Public propertyStartDate
Imposes a filter that specifies the starting date and time after which this destination will start processing log messages
(Inherited from Destination.)
Public propertyStartTime
Imposes a filter that specifies the starting time of the day after which this destination will start processing log messages
(Inherited from Destination.)
Public propertyTestOnStart
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.)
Back to Top
See Also