[This is preliminary documentation and is subject to change.]
Provides access to the Zone Integration Server log.
ServerLog functionality can be customized and extended by adding one or
more ServerLogModule implementations to the chain of loggers. The
logging chain is hierarchical, comprised of ServerLog instances at the Adk,
Agent, and Zone levels. Whenever a server-side logging operation is
performed on a zone, it is delegated to the ServerLogModule instances
at each level in the hierarchy, beginning with the Zone.
To customize server-side logging on a global basis, call the
Adk.getServerLog static function and use the methods below to
manipulate ServerLogModule instances at the root level of the
hierarchy:
- addLogger
- removeLogger
- clearLoggers
- getLoggers
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class ServerLog
Public Class ServerLog
public ref class ServerLog
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | AddLogger(IServerLogModule) | |
| ClearLoggers()() | Clear all ServerLogModule modules from the chain of loggers.
|
 | GetInstance(String, IZone) | Get a ServerLog instance with the specified ID.
This method is intended to be called internally by the Adk. You
should call the Adk.getServerLog, Agent.getServerLog,
or Zone.getServerLog methods to obtain a ServerLog instance
rather than directly calling this method.
|
| GetLoggers()() | Get a list of all registered ServerLogModule modules that comprise the
chain of loggers.
|
 | Id |
Returns the ID of this logger instance
|
| Log(String) | Post a SIF_LogEntry to the server.
Use this form of the log method to post a simple
informative message to the server.
|
| Log(LogLevel, String, String, String) | Post a SIF_LogEntry to the server.
Use this form of the log method to post an
error, warning, or informative message to the server with an
description, extended description, and optional application-defined
error code.
|
| Log(LogLevel, String, String, String, Int32, Int32) | Post a SIF_LogEntry to the server.
Use this form of the log method to post an
error, warning, or informative message to the server with an category
and code enumerated by the SIF Specification.
|
| Log(LogLevel, String, SifMessageInfo, array<SifDataObject>[]()) | Post a SIF_LogEntry to the server.
Use this form of the log method to post a simple
error, warning, or informative message to the server that references a
SIF Message and optionally a set of SIF Data Objects previously received
by the agent.
|
| Log(LogLevel, String, String, String, SifMessageInfo, array<SifDataObject>[]()) | Post a SIF_LogEntry to the server.
Use this form of the log method to post an
error, warning, or informative message to the server that references a
SIF Message and optionally a set of SIF Data Objects previously received
by the agent. The log entry can also have an extended error description
and application-defined error code.
|
| Log(LogLevel, String, String, String, Int32, Int32, SifMessageInfo, array<SifDataObject>[]()) | Post a SIF_LogEntry to the server.
Use this form of the log method to post an error, warning,
or informative message to the server that references a
SIF Message and optionally a set of SIF Data Objects previously received
by the agent. The log entry is assigned a category and code defined by
the SIF Specification, and may have an extended error description and
optional application-defined error code.
|
| RemoveLogger(IServerLogModule) | Remove a ServerLogModule from the chain of loggers.
|
Inheritance Hierarchy| Object | |
 | ServerLog |