[This is preliminary documentation and is subject to change.]
The LogService type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | LogService |
Creates a new logging service instance
|
![]() | LogService(Service) |
Creates a new logging service instance
|
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.) |
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | Destructor | (Inherited from LogServiceBase.) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit |
Accepts a visit from external manager. Base implementation does nothing.
Override in services that need external management calls
to update their state periodically, i.e. when they don't have a thread on their own
(Inherited from Service.) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure | (Inherited from LogServiceBase.) |
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart | (Overrides LogServiceBase DoStart .) |
![]() | DoWaitForCompleteStop | (Overrides LogServiceBase DoWaitForCompleteStop .) |
![]() | DoWrite |
Writes log message into log
(Overrides LogServiceBase DoWrite(Message, Boolean).) |
![]() | 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 ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | FailoverDestination |
When error=null => error cleared. When msg==null => exceptions surfaced from DoPulse()
(Inherited from LogServiceBase.) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | GetInstrumentationBuffer |
Returns instrumentation buffer if instrumentation enabled
(Inherited from LogServiceBase.) |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Pulse | (Inherited from LogServiceBase.) |
![]() | RegisterDestination |
Adds a destination to this service active destinations. Negative index to append
(Inherited from LogServiceBase.) |
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | UnRegisterDestination |
Removes a destiantion from this service active destinations, returns true if destination was found and removed
(Inherited from LogServiceBase.) |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
![]() | Write(Message) |
Writes log message into log
(Inherited from LogServiceBase.) |
![]() | Write(Message, Boolean) |
Writes log message into log
(Inherited from LogServiceBase.) |
![]() | Write(MessageType, String, String, String) |
Writes log message into log
(Inherited from LogServiceBase.) |
![]() | Write(MessageType, String, Boolean, String, String) |
Writes log message into log
(Inherited from LogServiceBase.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_FILEEXTENSION_ATTR | |
![]() ![]() | CONFIG_RELIABLE_ATTR | |
![]() ![]() | CONFIG_WRITEINTERVAL_ATTR | |
![]() | m_Destinations | (Inherited from LogServiceBase.) |
![]() | m_InstrumentationEnabled | (Inherited from LogServiceBase.) |
Properties
Name | Description | |
---|---|---|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | ComponentCommonName | (Inherited from LogServiceBase.) |
![]() | ComponentDirector | (Inherited from Service TDirector .) |
![]() | 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.) |
![]() | DefaultFailover |
Sets destination name used for failover on the service-level
if particular failing destination did not specify its specific failover
(Inherited from LogServiceBase.) |
![]() | Destinations |
Returns registered destinations. This call is thread safe
(Inherited from LogServiceBase.) |
![]() | DestinationsAreOptional |
Indicates whether the service can operate without any destinations registered, i.e. some test loggers may not need
any destinations to operate as they synchronously write to some buffer without any extra destinations
(Inherited from LogServiceBase.) |
![]() | 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.) |
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | FailoverError |
Returns last exception that happened during failover. This kind of exceptions is never propagated and always handled
(Inherited from LogServiceBase.) |
![]() | FailoverErrorDestination |
Returns a destination that threw last exception that happened durng failover. This kind of exceptions is never propagated and always handled
(Inherited from LogServiceBase.) |
![]() | FileExtension |
Extension for log files
|
![]() | InstrumentationBufferSize | (Inherited from LogServiceBase.) |
![]() | InstrumentationEnabled |
Implements IInstrumentable
(Inherited from LogServiceBase.) |
![]() | LastCatastrophy |
Latches last problematic msg
(Inherited from LogServiceBase.) |
![]() | LastError |
Latches last problematic msg
(Inherited from LogServiceBase.) |
![]() | LastWarning |
Latches last problematic msg
(Inherited from LogServiceBase.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | Now |
Returns localized log time
(Inherited from LogServiceBase.) |
![]() | Reliable |
Determines whether this service blocks on stop longer until all buffered messages have been tried to be dispatched into all destinations.
This property is true by default.
Certain destinations may take considerable time to fail per message (i.e. database connection timeout), consequently buffered messages
processing may delay service stop significantly if this property is true
|
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
![]() | WriteInterval |
Determines how often a log should be written to storage.
The value of this property must be between 10 and 5000 (milliseconds)
|
See Also