Packageorg.spicefactory.lib.logging.impl
Classpublic class SOSAppender
InheritanceSOSAppender Inheritance AbstractAppender

Appender implementation that routes all log output to Powerflasher SOS through an XMLSocket. SOS is a Java application that displays log output in a window with filtering and coloring options.

The default connection is localhost:4444. You may change this by setting the host and port properties.

For more information see http://sos.powerflasher.com.


Public Properties
 PropertyDefined by
  host : String
The host to connect to.
SOSAppender
  port : uint
The port to connect to.
SOSAppender
 Inheritedthreshold : LogLevel
The threshold level for this Appender.
AbstractAppender
  useShortNames : Boolean
Indicates whether to use short names or fully qualified class names / logger names.
SOSAppender
Public Methods
 MethodDefined by
  
SOSAppender()
Creates a new instance.
SOSAppender
  
init():void
Initializes the XMLSocket and connects to Powerflasher SOS.
SOSAppender
 Inherited
registerLogger(logger:Logger):void
Registers the specified Logger with this Appender.
AbstractAppender
  
sendCommand(command:String):void
Sends a custom command to Powerflasher SOS.
SOSAppender
Protected Methods
 MethodDefined by
 Inherited
handleLogEvent(event:LogEvent):void
Invoked whenever a Logger instance registered with this Appender fires a LogEvent.
AbstractAppender
 Inherited
isBelowThreshold(level:LogLevel):Boolean
Checks whether the specified LogLevel is below the threshold of this Appender.
AbstractAppender
Property detail
hostproperty
host:String  [read-write]

The host to connect to. The default is localhost.

Implementation
    public function get host():String
    public function set host(value:String):void
portproperty 
port:uint  [read-write]

The port to connect to. The default is 4444.

Implementation
    public function get port():uint
    public function set port(value:uint):void
useShortNamesproperty 
useShortNames:Boolean  [read-write]

Indicates whether to use short names or fully qualified class names / logger names. If this property is set to true it will only use the part of the logger name after the last occurence of '.'.

Implementation
    public function get useShortNames():Boolean
    public function set useShortNames(value:Boolean):void
Constructor detail
SOSAppender()constructor
public function SOSAppender()

Creates a new instance. The new instance does not automatically connect to Powerflasher SOS. Use the init method to initiate the connection.

Method detail
init()method
public function init():void

Initializes the XMLSocket and connects to Powerflasher SOS.

sendCommand()method 
public function sendCommand(command:String):void

Sends a custom command to Powerflasher SOS. For documentation on available commands see http://sos.powerflasher.com.

Parameters
command:String — the command to send to SOS