com.lightstreamer.as_client.logger.Logger

Package	com.lightstreamer.as_client.logger
Class	public class Logger

The Logger class is the logging engine of the flex client library. Library classes produce their log by sending messages to Logger class instances (i.e. loggers). External listeners can be attached to the various loggers in order to consume the log. Custom classes may also take advantage of loggers in order to produce their own log.
The logging is organized in hierarchies and levels.
The hierarchy is defined through the logger names. A logger is a son of another logger if its name is composed by the father's name plus a dot ( . ) plus a second part of the name (eg: "a.b.c" is son of "a.b" and "a" while it's not a son of "a.d"). Messages published on son loggers are also published on the father.
Each log message has an associated level. The available levels are DEBUG, INFO, WARN and ERROR. The levels are ordered by importance; the highest level is ERROR, followed by WARN, INFO and DEBUG.

The library uses the following loggers:

com.lightstreamer.as_client.ConnectionHandler.ID
(where ID is a progressive number assigned to each ConnectionHandler class instance) for information on the streaming or polling connection state;
com.lightstreamer.as_client.ControlConnectionHandler.ID
(where ID is a progressive number assigned to each ControlConnectionHandler class instance) for information on the connection state for control requests;
com.lightstreamer.as_client.LSClient
for information on general activities;
com.lightstreamer.as_client.LSClient.timeouts
for information on the timed tasks behaviour;
com.lightstreamer.as_client.NonVisualTable.ID
(where ID is a progressive number assigned to each NonVisualTable class instance) for information on table settings and event flow;
com.lightstreamer.as_client.VisualTable.ID
(where ID is a progressive number assigned to each VisualTable class instance) for information on table settings and event flow;
com.lightstreamer.as_client.SubTable.ID
(where ID is a progressive number assigned to each SubTable class instance) for information on table settings and event flow specific for second level tables of tables configured in "MultiMetapush logic".

In order to make this log available to the user, application code must create suitable listeners and add these listeners to the loggers of interest; for instance, by

     var traceAppender:TraceAppender = new TraceAppender(Logger.DEBUG);
     var logger:Logger = Logger.getLogger("com.lightstreamer.as_client");
     logger.addLoggerListener(traceAppender);

all log produced by the library is published through the Flash trace method.

	Property	Defined by
		DEBUG : uint = 0 [static] DEBUG logging level	Logger
		ERROR : uint = 15 [static] ERROR logging level	Logger
		INFO : uint = 5 [static] INFO logging level	Logger
		WARN : uint = 10 [static] WARN logging level	Logger

	Method	Defined by
		Logger(name:String) Constructor for Logger.	Logger
		addLoggerListener(listener:LoggerListener):void Add a listener to the Logger instance.	Logger
		debug(mex:*):void Publish a log message on the Logger object at DEBUG level.	Logger
		error(mex:*):void Publish a log message on the Logger object at ERROR level.	Logger
		getLogger(loggerName:String):Logger [static] Logger factory that gets a logger related to a specified name.	Logger
		info(mex:*):void Publish a log message on the Logger object at INFO level.	Logger
		log(level:uint, mex:*):void Publish a log message on the Logger object.	Logger
		removeLoggerListener(listener:LoggerListener):Boolean Remove a listener from the Logger instance.	Logger
		warn(mex:*):void Publish a log message on the Logger object at WARN level.	Logger

Property detail

DEBUG

property

public static var DEBUG:uint = 0

DEBUG logging level

ERROR

property

public static var ERROR:uint = 15

ERROR logging level

INFO

property

public static var INFO:uint = 5

INFO logging level

WARN

property

public static var WARN:uint = 10

WARN logging level

Constructor detail

Logger

()

constructor

public function Logger(name:String)

Constructor for Logger. This constructor should not be used, the static method getLogger should be used instead.

Parameters

name:String — The name of the desired logger.

See also

getLogger

Method detail

addLoggerListener

()

method

public function addLoggerListener(listener:LoggerListener):void

Add a listener to the Logger instance. Such listener will receive all the log lines from this logger and its sons. The listener also defines a threshold level, so that it will receive only the log lines with a level equal to or greater than the threshold.

Parameters

listener:LoggerListener — An instance of an object implementing the LoggerListener interface.

debug

()

method

public function debug(mex:*):void

Publish a log message on the Logger object at DEBUG level.

Parameters

mex:* — The message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

See also

DEBUG
log

error

()

method

public function error(mex:*):void

Publish a log message on the Logger object at ERROR level.

Parameters

mex:* — The message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

See also

ERROR
log

getLogger

()

method

public static function getLogger(loggerName:String):Logger

Logger factory that gets a logger related to a specified name. If such logger does not exist it is created. A unique instance is always maintained for each logger name.

Parameters

loggerName:String — The name of the desired logger.

Returns

Logger — The desired Logger instance.

info

()

method

public function info(mex:*):void

Publish a log message on the Logger object at INFO level.

Parameters

mex:* — The message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

See also

INFO
log

log

()

method

public function log(level:uint, mex:*):void

Publish a log message on the Logger object.

Parameters

	`level:uint` — The logging level of the given message. It should be one of DEBUG INFO WARN ERROR constants values. Specialized method are available as shortcuts to avoid to specify a logging level

	`mex:*` — The message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

See also

ERROR
error
WARN
warn
INFO
info
DEBUG
debug

removeLoggerListener

()

method

public function removeLoggerListener(listener:LoggerListener):Boolean

Remove a listener from the Logger instance.

Parameters

listener:LoggerListener — An instance of an object implementing the LoggerListener interface that was previously added to this same Logger.

Returns

Boolean — true if the given listener is correctly found and so removed, false otherwise.

See also

addLoggerListener

warn

()

method

public function warn(mex:*):void

Publish a log message on the Logger object at WARN level.

Parameters

mex:* — The message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

See also

WARN
log

Lightstreamer Flex client 1.1 API

Lightstreamer Flex client 1.1 API	All Packages \| All Classes \| Index \| Frames No Frames
Class Logger	Properties \| Methods