パッケージnet.user1.logger
クラスpublic class Logger
継承Logger Inheritance flash.events.EventDispatcher

バージョン : Reactor 1.0.0

Reactorのクライアント側のログを管理するクラスです。ログにはデバッグ用に一般的に役立つクライアント/サーバー間の通信とイベントを記録します。 ReactorのLoggerインスタンスにアクセスするには、ReactorクラスのgetLog()メソッドを使用してください。 例えば、
   var reactor:Reactor = new Reactor();
   var log:Logger = reactor.getLog();
   // ログにデバッグメッセージを追加します:
   log.debug("Testing...1...2...3...");
   
ログエントリーの履歴を読むには、getHistory()メソッドを使用してください。 ログに新たなメッセージが追加されるたびに通知を受けたいときは、addEventListener()を使ってLogEvent.UPDATEイベントを登録してください。 例えば、
   var log:Logger = reactor.getLog();
   log.addEventListener(LogEvent.UPDATE, updateListener);
   

ログに新しいメッセージを追加するには、debug(), info(), warn(), error(), または fatal()メソッドを使用してください。 アプリケーションの最も重要なログメッセージはfatal()を通して追加されるべきです。 最も重要でないメッセージはdebug()を通して追加されるべきです。 デフォルトでは、ReactorはActionScript開発環境のデバッグコンソールにログエントリーを出力するために、ActionScriptのビルトインのtrace()関数を使用します(LogTracerクラスを参照してください)。 アプリケーション内のログメッセージのtrace出力を停止するには、ReactorクラスのtraceLogMessagesコンストラクタのパラメータをfalseにセットしてください。

次のコードではカスタムテキストフィールドへログメッセージを出力する方法を示します。
   package {
     import flash.display.Sprite; 
     import flash.text.TextField;
   
     import net.user1.logger.LogEvent;
     import net.user1.logger.Logger;
     import net.user1.reactor.Reactor;
   
     public class UTest extends Sprite {
       protected var reactor:Reactor;
       protected var log出力:TextField;
   
       public function UTest () {
         // ログを出力するテキストフィールドを生成
         logOutput = new TextField();
         logOutput.border = true;
         logOutput.background = true;
         logOutput.width = 500;
         logOutput.height = 300;
         addChild(logOutput);
         
         // ログの更新について登録
         reactor = new Reactor();
         reactor.getLog().setLevel(Logger.DEBUG);
         reactor.getLog().addEventListener(LogEvent.UPDATE, logUpdateListener);
         reactor.getLog().debug("Hello world!");
       }
   
       public function logUpdateListener (e:LogEvent):void {
         logOutput.appendText(e.getTimeStamp() + " "
                              + e.getLevel() + ": " 
                              + e.getMessage() + "\n");
         logOutput.scrollV = logOutput.maxScrollV;
       }
     }
   }
   

関連項目

LogEvent
net.user1.reactor.Reactor.getLog()


パブリック メソッド
 メソッド定義元
  
Logger(historyLength:uint = 100)
コンストラクタ
Logger
  
addSuppressionTerm(term:String):void
指定した表現を含むログのエントリーを強制的に無視します。
Logger
  
debug(msg:String):void
ログに重要度"DEBUG"のメッセージを送信します。
Logger
  
メッセージに付与されるタイムスタンプを隠します。
Logger
  
メッセージに付与されるタイムスタンプを表示します。
Logger
  
error(msg:String):void
ログに重要度"ERROR"のメッセージを送信します。
Logger
  
fatal(msg:String):void
ログに重要度"FATAL"のメッセージを送信します。
Logger
  
getHistory():Array
ログの履歴上の全メッセージを返します。
Logger
  
ログの履歴に保存するメッセージの最大数を返します。
Logger
  
getLevel():String
メッセージのフィルターレベルを人間が読める形式で返します。
Logger
  
info(msg:String):void
ログに重要度"INFO"のメッセージを送信します。
Logger
  
removeSuppressionTerm(term:String):Boolean
指定した表現を含むログのエントリーの無視状態を解除します。
Logger
  
setHistoryLength(newHistoryLength:uint):void
ログの履歴に保存されるメッセージ数を指定します。
Logger
  
setLevel(level:String):void
メッセージのフィルターレベルを設定します。
Logger
  
warn(msg:String):void
ログに重要度"WARN"のメッセージを送信します。
Logger
Events
 Event Summary 定義元
   ログレベルがLoggerのsetLevel()メソッドを通して変更される時に発送されます。Logger
   新しいメッセージがログに追加される時に発送されます。Logger
パブリック 定数
 定数定義元
  DEBUG : String = DEBUG
[静的]
Logger
  ERROR : String = ERROR
[静的]
Logger
  FATAL : String = FATAL
[静的]
Logger
  INFO : String = INFO
[静的]
Logger
  WARN : String = WARN
[静的]
Logger
コンストラクタの詳細
Logger()コンストラクタ
public function Logger(historyLength:uint = 100)

バージョン : Reactor 1.0.0

コンストラクタ

パラメータ
historyLength:uint (default = 100) — ログの履歴に格納されるログメッセージ数です。 デフォルトは100です。
メソッドの詳細
addSuppressionTerm()メソッド
public function addSuppressionTerm(term:String):void

バージョン : Reactor 1.0.0

指定した表現を含むログのエントリーを強制的に無視します。

パラメータ

term:String — 該当する表現です。

debug()メソッド 
public function debug(msg:String):void

バージョン : Reactor 1.0.0

ログに重要度"DEBUG"のメッセージを送信します。

パラメータ

msg:String

disableTimeStamp()メソッド 
public function disableTimeStamp():void

バージョン : Reactor 1.0.0

メッセージに付与されるタイムスタンプを隠します。

enableTimeStamp()メソッド 
public function enableTimeStamp():void

バージョン : Reactor 1.0.0

メッセージに付与されるタイムスタンプを表示します。

error()メソッド 
public function error(msg:String):void

バージョン : Reactor 1.0.0

ログに重要度"ERROR"のメッセージを送信します。

パラメータ

msg:String

fatal()メソッド 
public function fatal(msg:String):void

バージョン : Reactor 1.0.0

ログに重要度"FATAL"のメッセージを送信します。

パラメータ

msg:String

getHistory()メソッド 
public function getHistory():Array

バージョン : Reactor 1.0.0

ログの履歴上の全メッセージを返します。

戻り値
Array
getHistoryLength()メソッド 
public function getHistoryLength():uint

バージョン : Reactor 1.0.0

ログの履歴に保存するメッセージの最大数を返します。 デフォルトは100です。

戻り値
uint
getLevel()メソッド 
public function getLevel():String

バージョン : Reactor 1.0.0

メッセージのフィルターレベルを人間が読める形式で返します。

戻り値
String

関連項目

setLevel()
info()メソッド 
public function info(msg:String):void

バージョン : Reactor 1.0.0

ログに重要度"INFO"のメッセージを送信します。

パラメータ

msg:String

removeSuppressionTerm()メソッド 
public function removeSuppressionTerm(term:String):Boolean

バージョン : Reactor 1.0.0

指定した表現を含むログのエントリーの無視状態を解除します。

パラメータ

term:String — 該当する表現です。

戻り値
Boolean — 表現が解除された場合にはtrueを返します。 表現が見つからなかった場合にはfalseを返します。
setHistoryLength()メソッド 
public function setHistoryLength(newHistoryLength:uint):void

バージョン : Reactor 1.0.0

ログの履歴に保存されるメッセージ数を指定します。

パラメータ

newHistoryLength:uint

setLevel()メソッド 
public function setLevel(level:String):void

バージョン : Reactor 1.0.0

メッセージのフィルターレベルを設定します。 指定されるレベルは次のLogger定数のどれかである必要があります: Logger.FATAL, Logger.ERROR, Logger.WARN, Logger.INFO, または Logger.DEBUGです。 ログレベルは順番にランク付けされており、FATALが最も重要であり、DEBUGがその逆です。 setLevel()を通して設定されたフィルターレベルより低い重要度のメッセージはログから除外されます。 例えば、フィルターレベルがLogger.DEBUGに設定されている場合、全てのメッセージはログに含まれます。 もしフィルターレベルがLogger.WARNに設定されている場合、Loggerのdebug()とinfo()メソッドを通して送信されたメッセージはログから除外されますが、Loggerのerror(), warn()およびfatal()メソッドを通して送信されたメッセージはログに含まれます。 デフォルトのログレベルはLogger.INFOです(DEBUGメッセージのみを除外します)。

Reactorのログレベルは外部設定ファイルから設定することもできます。 詳細は、ReactorクラスのコンストラクタのconfigURLパラメータを参照してください。

パラメータ

level:String — どのメッセージを除去するかを決定するためのレベルを指定します。 Loggerクラスでstaticな定数として定義されているフィルターレベルから選択してください。 指定したレベルより低い重要度のメッセージはログから除外されます。

関連項目

warn()メソッド 
public function warn(msg:String):void

バージョン : Reactor 1.0.0

ログに重要度"WARN"のメッセージを送信します。

パラメータ

msg:String

Event Detail
LEVEL_CHANGE イベント
Event Object Type: LogEvent
LogEvent.type variable = net.user1.logger.LogEvent.LEVEL_CHANGE

ログレベルがLoggerのsetLevel()メソッドを通して変更される時に発送されます。 新たなレベルにアクセスするには、getLevel()を使用してください。これは次の値のうちのどれかを返します。 Logger.FATAL, Logger.ERROR, Logger.WARN, Logger.INFO, または Logger.DEBUGです。

関連項目

UPDATE イベント  
Event Object Type: LogEvent
LogEvent.type variable = net.user1.logger.LogEvent.UPDATE

新しいメッセージがログに追加される時に発送されます。 ログに新しいメッセージを追加するには、次のLoggerクラスメソッドのうちのどれかを使用してください。 debug(), info(), warn(), error(), または fatal()です。

関連項目

定数の詳細
DEBUG定数
public static const DEBUG:String = DEBUG

ERROR定数 
public static const ERROR:String = ERROR

FATAL定数 
public static const FATAL:String = FATAL

INFO定数 
public static const INFO:String = INFO

WARN定数 
public static const WARN:String = WARN