[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class DefaultServerLogModule : IServerLogModule
Public Class DefaultServerLogModule _ Implements IServerLogModule
public ref class DefaultServerLogModule : IServerLogModule
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DefaultServerLogModuleDefaultServerLogModuleNew()() | |
 | Echo |
Determines if SIF_LogEntry objects should be echoed to the local
client-side zone log
|
| ID | Gets the ID of this logger |
| Log(IZone, String) | Post a string message to the server log.
The implementation of this method constructs a SIF_LogEntry object
with the LogLevel attribute set to "Info" and the
SIF_Desc element set to the text message passed to
the message parameter. The SIF_LogEntry object is then
reported to the zone as a SIF_Event by delegating to the log
method that accepts a SIF_LogEntry parameter.
|
| Log(IZone, SIF_LogEntry) | Post a SIF_LogEntry to the server.
|
| ReportEvents |
Determines if SIF_LogEntry objects are reported to the zone. This method can
be called to disable SIF_LogEntry reporting to zones while continuing to allow
log messages to be echoed to the local zone log.
|
RemarksDefaultServerLogModule writes to the server log by constructing and reporting a SIF_LogEntry object as an Add SIF_Event when the log method is called. Because SIF_LogEntry was introduced in SIF 1.5, an event is only reported when the agent's default SIF Version is 1.5 or later. No action is taken for earlier versions.
By default, DefaultServerLogModule echos all messages to the zone's local logging framework Category. Call the setEcho method to disable this functionality. Follow these steps to obtain the DefaultServerLogModule that is installed by the Adk when it is initialized:
- Access Adk.ServerLog to obtain the ServerLog instance at the root of the logging chain
- Use the ServerLog.Loggers property to obtain an array of all ServerLogModules
- Read the ID property on each element in the array until you encounter one that returns "DefaultServerLogModule". Alternatively, you can use test each element to determine if it is an instance of this class.
- Set the Echo Property to enable/disable echoing of SIF_LogEntry information to the local zone log. (SIF_LogEntry is always echoed when the ADK is initialized to use a version of SIF prior to 1.5)
- Set the ReportEvents property to enable/disable the reporting of SIF_LogEntry events to the zone. This method can be used to disable SIF_LogEntry reporting to zones while continuing to allow log messages to be echoed to the local zone log.
Inheritance Hierarchy| Object | |
 | DefaultServerLogModule |