| Package | system.logging.targets |
| Class | public class SocketTarget |
| Inheritance | SocketTarget  LineFormattedTarget LoggerTarget Object |
| Subclasses | SOSTarget |
| Property | Defined By | ||
|---|---|---|---|
| connected : Boolean [read-only]
Indicates if the target is connected with Socket server. | SocketTarget | ||
 | factory : LoggerFactory
Determinates the LoggerFactory reference of the target, by default the target use the system.logging.Log singleton. | LoggerTarget | |
| filters : Array
Indicates the filters array representation of this target. | LoggerTarget | |
| host : String
The host of the socket connection. | SocketTarget | ||
| includeChannel : Boolean
Indicates if the channel for this target should added to the trace. | LineFormattedTarget | |
| includeDate : Boolean
Indicates if the date should be added to the trace. | LineFormattedTarget | |
| includeLevel : Boolean
Indicates if the level for the event should added to the trace. | LineFormattedTarget | |
| includeLines : Boolean
Indicates if the line for the event should added to the trace. | LineFormattedTarget | |
| includeMilliseconds : Boolean
Indicates if the milliseconds should be added to the trace. | LineFormattedTarget | |
| includeTime : Boolean
Indicates if the time should be added to the trace. | LineFormattedTarget | |
| level : LoggerLevel
Indicates the level of this target. | LoggerTarget | |
| port : int
The port of the socket connection. | SocketTarget | ||
| separator : String =
The separator string. | LineFormattedTarget | |
| Method | Defined By | ||
|---|---|---|---|
SocketTarget(host:String = localhost, port:int = 0, auto:Boolean = false)
Creates a new SocketTarget instance. | SocketTarget | ||
| addFilter(channel:String):Boolean
Insert a channel in the fllters if this channel don't exist. | LoggerTarget | |
|
Sets up this target with the specified logger. | LoggerTarget | |
close():void
Closes the target socket connection. | SocketTarget | ||
connect():void
Connects the target with the socket server. | SocketTarget | ||
flush():void
Flush the target with all caching messages. | SocketTarget | ||
internalLog(message:*, level:LoggerLevel):void [override]
Descendants of this class should override this method to direct the specified message to the desired output. | SocketTarget | ||
| logEntry(entry:LoggerEntry):void [override]
This method receive a LoggerEntry from an associated logger. | LineFormattedTarget | |
| receive(... values):void
This method is called when the receiver is connected with a Signal object. | LoggerTarget | |
| removeFilter(channel:String):Boolean
Remove a channel in the fllters if this channel exist. | LoggerTarget | |
| removeLogger(logger:Logger):void
Stops this target from receiving events from the specified logger. | LoggerTarget | |
| resetLineNumber():void
Resets the internal line number value (set to 1). | LineFormattedTarget | |
send(message:*):void
Send message or bufferize message if the socket is not connected yet. | SocketTarget | ||
| connected | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesconnected:Boolean [read-only] Indicates if the target is connected with Socket server.
public function get connected():Boolean| host | property |
host:StringThe host of the socket connection.
public function get host():String public function set host(value:String):void| port | property |
port:intThe port of the socket connection.
public function get port():int public function set port(value:int):void| SocketTarget | () | Constructor |
public function SocketTarget(host:String = localhost, port:int = 0, auto:Boolean = false)Creates a new SocketTarget instance.
Parametershost:String (default = localhost) | |
port:int (default = 0) | |
auto:Boolean (default = false) |
| close | () | method |
public function close():voidCloses the target socket connection.
| connect | () | method |
public function connect():voidConnects the target with the socket server.
| flush | () | method |
public function flush():voidFlush the target with all caching messages.
| internalLog | () | method |
override public function internalLog(message:*, level:LoggerLevel):voidDescendants of this class should override this method to direct the specified message to the desired output.
Parameters
message:* — String containing preprocessed log message which may include time, date, category, etc. based on property settings, such as includeDate, includeCategory, etc.
| |
level:LoggerLevel — the LogEventLevel of the message.
|
| send | () | method |
public function send(message:*):voidSend message or bufferize message if the socket is not connected yet.
Parameters
message:* |