Clientインスタンスを初期化します。 ClientインスタンスはClientManagerによって自動的に生成される点に注意してください。 Clientインスタンスを手動で生成してはいけません。

指定したクライアント属性をサーバーから削除します。 他のクライアントはRoomEvent.DELETE_CLIENT_ATTRIBUTEとAtributeEvent.DELETEイベントを通して更新を通知されます。

パラメータ

関連項目

このクライアントのUserAccountオブジェクトへの参照を返します。これはこのクライアントがユーザーアカウントにログインしている場合にのみ利用可能です。

関連項目

指定したクライアント属性の値を返します。 クライアント属性はClientクラスのsetAttribute()メソッドを通して、あるいはサーバーから直接指定されます。 クライアント属性についての完全な詳細はsetAttribute()を参照してください。

パラメータ

関連項目

このクライアントが共有している属性の名称と値を変数として持つオブジェクトを返します。 各変数名は完全修飾の属性名です。 例えばあるクライアントにおいて、ルームをスコープとする属性"examples.chatroom1.username"を"dan"に、グローバル属性"gender"を"male"に設定したとすると、getAttributes()メソッドは次のような構造のオブジェクトを返します。

     var o:Object();
     o["examples.chatroom1.username"] = "dan";
     o["gender"] = "male";
     

     var o:Object();
     o["examples.chatroom1"] = new Object();
     o["examples.chatroom1"].username = "dan";
     o[Tokens.GLOBAL_ATTR] = new Object();
     o[Tokens.GLOBAL_ATTR]["gender"] = "male";
     

関連項目

var clientAttrs:Object = client.getAttributes();
     for (var attrName in clientAttrs) {
       trace("Attribute: " + attrName + " has the value: " + clientAttrs[attrVal]);
     }

与えられたスコープ、あるいは全てのスコープにおいてこのClientインスタンスに定義されている全ての属性名と値を含むオブジェクトを返します。

スコープが指定されているとき、戻り値のオブジェクトは次の構造を持ちます:

     {name1:value1, name2:value2,...namen:valuen}
     

     {scope1: {name1:value1, name2:value2,...namen:valuen},
      scope2: {name1:value1, name2:value2,...namen:valuen},
      scopen: {name1:value1, name2:value2,...namen:valuen}}
     

• グローバル属性"username"、値は"derek"
• ルーム"games.pong"をスコープとする属性"score"、値は8

var o:Object = new Object();
     o[Tokens.GLOBAL_ATTR]["username"] = "derek";
     o["games.pong"]["score"] = 8;

var o:Object = new Object();
     o["username"] = "derek";
     o["games.pong.score"] = 8;

パラメータ

関連項目

// クライアントのIDです。この例では、3を使用します。
     var clientID = 3;
     
     // 全スコープにおける属性を表すオブジェクトを取得します。
     var attributesObj = reactor.getClientManager().getClient(
                                                clientID).getAttributesByScope();
     
     // グローバルスコープ内の全属性を列挙します。
     for (var attrname:String in attributesObj[Tokens.GLOBAL_ATTR]) {
       trace("Global attribute name: " + attrname
            + " has the value: " + attributesObj[Tokens.GLOBAL_ATTR][attrname]);
     }

     for (var scope:String in attributesObj) {
       for (var attrname in attributesObj[scope]) {
         trace("Attribute in scope: " + scope
              + " with the name: " + attrname
              + " has the value: " + attributesObj[scope][attrname]);
       }
     }

このクライアントの、サーバーによって自動的に設定されたユニークIDを返します。 クライアントIDはクライアントが接続している限り維持され、接続中に変更することはできません。 クライアントIDはクライアントが切断されたときに失効します。

クライアントIDについて保証されるのは次の二点だけであることに注意してください。1)ストリング型である。2)サーバー上でユニークである。 クライアントIDの指定形式については任意に決められるので保障されず、信頼するべきでもありません。 例えば、IDが数値だったとしても（"35"など）、その数値に基づいた数値計算を行うべきではありません。 IDの形式自体が、通知無しに変更されることもあります。 クライアントサイドで内部的なクライアントID自体を信用したコードを書くことは、単にIDがユニークで与えられるという事実のみを用いるより危険です。 クライアントの真の並び順については、ClientクラスのgetConnectTime()を使用してください。このメソッドは与えられたクライアントが接続したときのサーバー時間を返します。

現クライアント(つまり、reactor.self())のクライアントIDはReactorEvent.READYイベントが発生した後にのみ利用可能です。

クライアントIDを持つことに加え、クライアントはuserIDをもつユーザーアカウントにもログインすることがある点に留意してください。 クライアントIDは一時的で一度の接続につき自動的に生成されるIDなのに対して、ユーザーIDは永続的なサーバー側のユーザーアカウントの名前であり、クライアントがログインした後にのみ有効です。 UserAccountクラスとClientクラスのgetAccount()メソッドを参照してください。

関連項目

このClientオブジェクトを管理するClientManagerのインスタンスへの参照を返します。

関連項目

クライアントの現在のサーバーとの接続状態を表します。 この値はConnectionStateクラスの定数のうちの一つになります。

関連項目

このクライアントが接続したときにサーバーによって設定された時間を返します。 この時間は1970年を基点としたミリ秒で表され、サーバーのクロックに基づいてUTCで与えられます。 getConnectTime()の戻り値をActionScriptのDateオブジェクトに変換するには、次のように値をDateコンストラクタに渡します。

// theClientが接続開始した時間を表すDateオブジェクトを作成します。
     var d:Date = new Date(theClient.getConnectTime());
     

theClient.getAttribute("_CT");

関連項目

もし利用可能であれば、このクライアントのIPアドレスを返します。 IPアドレスは"_IP"というグローバルなクライアント属性に格納されている点を覚えておいてください。そのためこのメソッドはtheClient.getAttribute("_IP");と同義となります。 デフォルトでは、クライアントは自身のIPアドレスしか把握せず、サーバー上の他のクライアントのIPアドレスへのアクセス権はありません。

このクライアントが観戦していると把握されているルームのIDを返します。 ここで返されるルームリストはサーバー全体のうち現クライアントが把握しているルームの分だけであり、実際のサーバーの状態を完全には反映しません。 このメソッドはそのクライアントが観戦していたルームのIDを返します。これにはそのクライアントが入室していたルームのIDは含まれません。

ルームIDのリストは一時的なスナップショットであり、現クライアントがルームの観戦を開始または停止するときに更新されません。

関連項目

このクライアントが入室していると把握されているルームのIDを返します。 ここで返されるルームリストはサーバー全体のうち現クライアントが把握しているルームの分だけであり、実際のサーバーの状態を完全には反映しません。 このメソッドはそのクライアントが参加しているルームのIDを返しますが、それにはクライアントが単に観察しているルームのIDは含まれません。

戻り値のルームIDのリストはこのClientが入室しているルームリストの一時的なコピーであり、現クライアントがルームに入退室するときにも更新されません。

関連項目

クライアントのping時間をミリ秒で返します。 "pingタイム"はメッセージがクライアントからサーバーに送信され、クライアントに戻ってくるまで(つまり、メッセージが完全に往復するまで)にかかる合計時間です。 クライアントのpingが不明な場合、getPing()は-1を返します。

デフォルトでは、各クライアントはサーバーに10秒ごとにpingを打ちます。getPing()は最後のping値（平均値ではありません）を返します。 デフォルトではまた、クライアントは他のクライアントとping値を共有しません。 ping値を共有するにはConnectionMonitorクラスを通して明示的に有効化しなければいけません。 getPing()メソッドはping値を共有していない、あるいは自動的にping値の計算が無効化されているクライアントについては-1を返します。 ping設定についての詳細はConnectionMonitorクラスを参照してください。

関連項目

     public function showPings (room:Room):void {
       var clients:Array = room.getOccupants();
       for each (var client:int in clients) {
         trace("PING for client" + client.getClientID() 
               + " is: " + client.getPing());
       }
     }
     

指定クライアントのサーバへの接続時間をミリ秒で返します。 このミリ秒値はサーバー上の近似された現在時間(ServerのgetServerTime()メソッドを通して取得されます)からクライアントの接続時間(ClientのgetConnectTime()メソッドを通して取得されます)を引く事で推定されます。

関連項目

このクライアントが指定のルームに入室していることが把握されているかどうかを示す論理値を返します。 このメソッドが反映するのは現クライアントが認識しているルームであり、実際のサーバー状況ではないことに気をつけてください。 もし指定のルームが未同期でクライアントも未同期の場合、たとえそのクライアントが実際に指定のルームに入室している場合でも、isInRoom()は常にfalseを返します。 指定のroomIDにおいてisInRoom()の結果が正確であることを保証するためには、ルームに入室または観戦し、十分なルーム更新レベルをセットするか、Clientのobserve()メソッドかClientManagerのobserveClient()メソッドのどちらかを通してそのクライアントと同期してください。

パラメータ

関連項目

このクライアントが指定のルームを観戦していることが把握されているかどうかを示す論理値を返します。 このメソッドが反映するのは現クライアントが認識しているルームであり、実際のサーバー状況ではないことに気をつけてください。 もし指定のルームが未同期でクライアントも未同期の場合、たとえそのクライアントが実際に指定のルームを観戦している場合でも、isObservingRoom()は常にfalseを返します。 指定のroomIDにおいてisObservingRoom()の結果が正確であることを保証するためには、ルームに入室または観戦し、十分なルーム更新レベルをセットするか、Clientのobserve()メソッドかClientManagerのobserveClient()メソッドのどちらかを通してそのクライアントと同期してください。

パラメータ

関連項目

このクライアントが現クライアントであればtrueを返します。 Reactorのself()メソッドを参照してください。

関連項目

このクライアントをサーバーから切断します。 管理者特権を要求します。

このクライアントの状態が常に同期を維持するようにサーバーに要求します。 結果的に、現クライアントは次のいずれかの時にいつでも通知されます:

• the client sets or deletes an attribute
• the client joins or leaves a room
• the client observes or stops observing a room
• the client disconnects

サーバーからの通知は次のイベントをトリガーします:

• AttributeEvent.UPDATE (属性変更時)
• AttributeEvent.DELETE (属性除去時)
• ClientEvent.JOIN_ROOM and ClientEvent.LEAVE_ROOM
• ClientEvent.OBSERVE_ROOM and ClientEvent.STOP_OBSERVING_ROOM
• ClientManagerEvent.CLIENT_DISCONNECTED

observe()呼び出しの結果はClientEvent.OBSERVE_RESULTイベントを通して返されます。 もしその呼び出しが成功すると、ClientEvent.OBSERVEイベントがトリガーされます。 クライアントが最初に同期した後は、ClientEvent.SYNCHRONIZEイベントがトリガーされます。

関連項目

引数を備えたメッセージを他のクライアントに送信します。 メッセージを受信するためには、メッセージが到着したときに処理するための（１つあるいは複数の）メソッドを受信側のクライアントで定義します。 実行したい各メソッドはMessageManagerのaddMessageListener()メソッドを使用して別々にそのメッセージに登録します。

メッセージを単体のクライアントのかわりに特定のクライアントリスト向けに送信するには、ClientManager.sendMessage()を使用します。

パラメータ

関連項目

messageManager.addMessageListener("PRIVATE_CHAT", displayPrivateMessage);

theClient.sendMessage("PRIVATE_CHAT", message);

    
     protected function displayPrivateChat (client:IClient, 
                                            msg:String):void {
       privateChatField.text = "Private message from: " + client.getClientID() 
                             + ": " + msg);
     }
     

このクライアントにクライアント属性を設定します。 属性とその値はサーバーに格納・管理されます。 クライアント属性はクライアントについての情報を変数に似た形で含みます。 しかしながら、基本変数と異なり、クライアント属性とその値は他の接続中のクライアントとの間で共有できます。 ログインしたクライアントは後の参照用にデータベースか他のデータソースに情報を保存するためにユーザーアカウント属性を使用する事もできます(詳細はUserAccountクラスのsetAttribute()メソッドを参照してください)。

クライアント属性は、そのクライアントの名前、年齢、髪の色、得点などの特徴を追跡するために使用されます。 例えば、クライアントは次のように、"age"と名付けた属性に"39"という値を格納したりするでしょう。

    theClient.setAttribute("age", "39");
    

すると他の接続済みクライアントは次のように、Client.getAttribute()を通してそのクライアントの"age"属性を取得することで、その値"39"にアクセスできます:

    var client:Client = reactor.getClientManager().getClient(someClientID);
    var age:String = client.getAttribute("age");
    

加えて、そのクライアントが自身のageを"39"から"40"に変更しようとしていた場合、他の関心があるクライアントはその変更の通知を受けられます。 変更通知に対応することで他のクライアントは、例えば、チャットルームのユーザーリストを現在のユーザーの年齢について最新の状態に保つといったことができます。 次のコードはクライアント属性"age"の変更に応答するRoomEvent.UPDATE_CLIENT_ATTRIBUTEリスナーの使用方法を示します。

    protected function updateClientAttributeListener (e:RoomEvent):void {
      // 変更された属性が"age"なら、 
      // そのクライアントの新しい年齢を表示します。
      if (e.getChangedAttr().name == "age") {
        // "年齢変更"メッセージを表示します。
        trace(e.getClient() + " age changed to: " + e.getChangedAttr().value);
      }
    }
    

特定のクライアントの属性の変化の通知を受けるために、そのクライアントのAttributeEvent.UPDATEイベントを登録できます。

全てのクライアント属性は指定したルームか全ルームのどちらかをスコープとしていなければいけません。 全ルームをスコープとするクライアント属性は"グローバルクライアント属性"と呼ばれます。 属性のスコープはその属性が変更されたときにどのクライアントが更新されるのかを判定します。 例えば、あるクライアントが games.pongルームとchat.lobbyルームにいるとします。 そのクライアントが"games.pong"スコープ内で属性名"score"の値を"10"に設定します。

    theClient.setAttribute("score", "10", "games.pong");
    

これに対応して、games.pongルームにいる他のクライアントはそのクライアントの"score"属性が"10"に変更されたことを通知されます。 しかし、chat.lobbyルームにいるクライアントには通知されません。

次に、そのクライアントがnullをスコープとして"hairColour"という名前の属性を"brown"にセットすると仮定します (null はその属性がグローバルなスコープを持つことを示します)。

    theClient.setAttribute("hairColour", "brown", null);
    

応答として、games.pongとchat.lobbyのどちらかに入室している他のクライアントはそのクライアントの"hairColour"属性が"brown"にセットされたという通知を受けます。 属性のスコープによってクライアントは他のルームとは別に、一つのルームにのみ関連づけた情報を持つことができます。

クライアント属性を完全に削除するには、ClientのdeleteAttribute()メソッドを使用してください。 例えば、次のコードはグローバルクライアント属性"hairColour"を削除します:

    theClient.deleteAttribute("hairColour");
    

クライアント属性が削除されるとき、そのクライアントが入室しているルームはRoomEvent.DELETE_CLIENT_ATTRIBUTEイベントをトリガーし、そのクライアントのClientオブジェクトはAttributeEvent.DELETEイベントをトリガーします。

クライアント属性はクライアントが切断するまでサーバーから削除されません。 アプリケーションはdeleteAttribute()を通して不要な属性を明示的に削除することが期待されます。 長い接続時間中に多数のクライアント属性を作成するようなアプリケーションは、各属性が不要となった時点で削除することでサーバー側のメモリーの累積を防がなくてはなりません。

デフォルトではサーバーとの通信において属性を区切るために内部的にパイプ文字（"|"）が使用されていることに気をつけてください。 そのため、属性名と値には"|"を含めることはできません。 詳細はTokens.RSを参照してください。

パラメータ

関連項目

特定のスコープのルームにいる現クライアントのクラスを指定します。 グローバルなカスタムクライアントクラスを設定するためには、スコープをnullに設定してください。 指定したクラス（または指定したfallbackClassesのうちの一つ）は現クライアントを把握している他の全クライアントにおいて使用可能である必要があります。

通常は、カスタムクラスはCustomClientを拡張します。CustomClientはカスタムクライアントクラスのための基本テンプレートを提供します。 カスタムクラスがCustomClientの拡張ではない場合、手動で生のClientオブジェクトを組まなければなりません。これはClientManagerクラスのgetInternalClient()メソッドを通して取り出せます。

パラメータ

関連項目

     // 全ての部屋において現クライアントにChatClientをデフォルトとして割り当てます。
     // ここで設定されたデフォルト値は任意のRoomオブジェクトのsetDefaultClientClass()メソッド 
     // および現クライアントのsetClientClass()メソッドを用いることで
     // 指定のルームについて上書きできます。
     reactor.self().setClientClass(null, ChatClient);
     
     // "examples.chess"ルームのみにおいて現クライアントに
     // カスタムクラスChessClientを割り当てます（先行のデフォルト設定を上書きします）
     reactor.self().setClientClass("examples.chess", ChessClient);
     
     // chessRoomにおける全てのクライアントのデフォルトクラスにChessClientを設定します。
     // 結果として、chessRoom.getClient()を通して取り出したときに
     // カスタムクラスを指定しない全てのクライアントはChessClientのインスタンスとなります。
     chessRoom.setDefaultClientClass(ChessClient);
     
     // アプリケーション中の全てのクライアントのデフォルトクラスをChatClientに設定します。
     // 結果として明示的にカスタムクラスを設定するか、
     // デフォルトクライアントクラスが設定されたルームのgetClient()を通して取り出されない限りは、
     // アプリケーションにおける全てのクライアントはChatClientのインスタンスとなります。
     reactor.getClientManager().setDefaultClientClass(ChatClient);
     
     

このクライアントの観察を停止するようにサーバーに要求します。 結果的に、サーバーはクライアントの状態が変化する時にもう通知を送信しません。

stopObserving()呼び出しの結果はClientEvent.STOP_OBSERVING_RESULTイベントを通して返されます。 もしその呼び出しが成功すると、ClientEvent.STOP_OBSERVINGイベントもトリガーされます。

関連項目

このオブジェクトのString表現を提供します。

関連項目

属性の削除試行の結果を受信したときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

• Status.SUCCESS
• Status.ERROR
• Status.CLIENT_NOT_FOUND (クライアント属性のみ)
• Status.ROOM_NOT_FOUND (ルーム属性のみ)
• Status.IMMUTABLE
• Status.SERVER_ONLY

関連項目

関連項目

関連項目

現クライアントによって把握されているクライアントのいずれかがログインするときに送出されます。 クライアントが現クライアントによって把握される状況のリストについては、ClientManagerのclientIsKnown()メソッドを参照してください。 しかしながら、RoomクラスのsetUpdateLevels()メソッドを通して"入室者ログインログオフ更新"と"観戦者ログインログオフ更新"を無効化することで、現クライアントがルーム入室者とルーム観戦者のログイン通知を受けないようにもできる点に留意してください。

AccountEvent.LOGINイベントはログインしたクライアントのClientオブジェクトを通して送出され、次にログインしたアカウントのUserAccountオブジェクト、次にAccountManagerからも送出されます。

関連項目

現クライアントによって把握されているユーザーアカウントのいずれかがログオフするときに送出されます。 クライアントが現クライアントによって把握される状況のリストについては、ClientManagerのclientIsKnown()メソッドを参照してください。 しかしながら、RoomクラスのsetUpdateLevels()メソッドを通して"入室者ログインログオフ更新"と"観戦者ログインログオフ更新"を無効化することで、現クライアントがルーム入室者とルーム観戦者のログオフ通知を受けないようにもできる点に留意してください。

AccountEvent.LOGOFFイベントはログオフしたクライアントのClientオブジェクトを通して送出され、次にログオフしたアカウントのUserAccountオブジェクト、次にAccountManagerからも送出されます。

関連項目

関連項目

関連項目

関連項目

属性のセット試行の結果を受信したときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

• Status.SUCCESS
• Status.ERROR
• Status.DUPLICATE_VALUE (クライアント属性のみ)
• Status.CLIENT_NOT_FOUND (クライアント属性のみ)
• Status.ROOM_NOT_FOUND (ルーム属性のみ)
• Status.IMMUTABLE
• Status.SERVER_ONLY
• Status.EVALUATION_FAILED

関連項目

関連項目

関連項目

関連項目

関連項目

関連項目