コンストラクタ

パラメータ

指定したアドレス（通常はIPアドレス）の全てのクライアントを切断し、今後一切そのアドレスからのクライアント接続を防止します。 デフォルトでは、ban() は管理者権限を必要とします。 他の種類の（例えばモデレーター）クライアントにアドレスのBANを許可するには、リモートクライアントのセキュリティロールをUnionサーバーのセキュリティドキュメントで記述されているように定義してください。

BANの試行結果は ClientManagerEvent.BAN_RESULT イベントを通して返されます。

パラメータ

関連項目

     reactor.getClientManager().ban("1.2.3.4", 600, "For cheating");
     

指定のclientIDのクライアントが現クライアントによって把握されているかどうかを示すBoolean値を返します。 クライアントは次の状況で把握されます:

• ClientManagerは複数のクライアントと、Unionサーバーに接続されている特定のIDを持つクライアントを監視します。 ClientManagerクラスのwatchForClients()メソッドを参照してください。
• 現クライアントが入室または観戦しているルーム内には指定のclientIDのクライアントがおり、そのルームについての現クライアントの更新レベルが入室者リスト更新を含んでいます(UpdateLevelsクラスを参照してください)。
• 現クライアントが入室または観戦しているルームを指定のclientIDのクライアントが観戦しており、そのルームについての現クライアントの更新レベルが観戦者リスト更新を含んでいます(UpdateLevelsクラスを参照してください)。
• 現クライアントが指定のclientIDのクライアントを観察しています。 ClientManagerのobserveClient()メソッドを参照してください。
• 指定のclientIDのクライアントがログインし、現クライアントがユーザーアカウントを監視しています。 AccountManagerのwatchForAccount()メソッドを参照してください。
• 指定のclientIDのクライアントがアカウントにログインし、現クライアントがそのアカウントを観察しています。 AccountManagerのobserveAccount()メソッドを参照してください。
• 指定のclientIDを持つクライアントが現クライアントです。

パラメータ

このオブジェクトを永久に無効化します。 このオブジェクトは再利用できません。 dispose()メソッドの目的はこのオブジェクトをガーベッジコレクトの対象とすることです（例えば、.swfファイルをアンロードする前に）。 ClientManagerクラスのdispose()メソッドはReactorクラスのdispose()が発動したときに自動的に発動します。

clientIDsで渡された全クライアントの指定の属性の値を保持するオブジェクトの配列を返します。 配列中の各オブジェクトはclientIDプロパティ（そのクライアントのID）とvalueプロパティ（その属性値）を持ちます。 value プロパティは、clientIDs の中に存在しないか指定した属性を持たないクライアントについては null になります。

クライアント属性についての詳細はClientクラスのsetAttribute()メソッドを参照してください。

パラメータ

関連項目

     var theRoom:Room = reactor.getRoomManager().getRoom("examples.chatroom");
     var clientList:Array = theRoom.getClientIDs();
     // ここで、"age" 属性はグローバルなので、attrScopeは省略してあります。
     var attrList:Array = reactor.getClientManager().getAttributeForClients(
                                                                    clientList,
                                                                    "age");
     
     for each (var item:Object in attrList) {
       trace("The value of 'age' for client "
             + item.clientID + " is: " + item.value);
     }

指定のクライアントを表すオブジェクトを返します。 デフォルトでは、そのオブジェクトはnet.user1.reactor.Clientクラスのインスタンスです。 しかし、指定したスコープのクライアントとして自作クラスが指定されていた場合、オブジェクトはその自作クラスのインスタンスとなります。 ClientのカスタムクラスはIClientのsetClientClass()メソッド、RoomクラスのsetDefaultClientClass()メソッドとClientManagerのsetDefaultClientClass()メソッドを通して指定できます。

クライアントオブジェクトのクラスは次のように決定されます:

• もしクライアントがそのスコープについてカスタムクラスを指定すれば、そのクライアントオブジェクトのクラスはそのカスタムクラスになります
• そうでない場合、もしルームがそのスコープについてカスタムクラスを指定すれば、そのクライアントオブジェクトのクラスはそのカスタムクラスになります
• そうでない場合、もしClientManagerがそのスコープについてカスタムクラスを指定すれば、そのクライアントオブジェクトのクラスはそのカスタムクラスになります
• そうでない場合、そのクライアントオブジェクトのクラスはnet.user1.reactor.Clientです

パラメータ

関連項目

指定した属性名と値と一致する属性名と値を持っているようなクライアントで、ClientManagerが把握している最初のものを返します。 一致する属性を持つクライアントがなかった場合、nullを返します。

パラメータ

関連項目

userIDによって指定されるアカウントにログインしたクライアントを返します。 もし指定したuserIDを使ってログインしているクライアントを把握していない場合、nullを返します。

パラメータ

関連項目

現クライアントが把握している全てのクライアントオブジェクトのリストを返します。 リスト内の各クライアントオブジェクトはnet.user1.reactor.Clientかカスタムクライアントクラスのどちらかのインスタンスであり、次のように決定されます:

• もしクライアントがグローバルスコープについてカスタムクラスを指定すれば、そのクライアントオブジェクトのクラスはそのカスタムクラスになります
• そうでない場合、もしClientManagerがカスタムクラスを指定すれば、そのクライアントオブジェクトのクラスはそのカスタムクラスになります
• そうでない場合、そのクライアントオブジェクトのクラスはnet.user1.reactor.Clientです

関連項目

このアプリケーション内のクライアントが使用するグローバルのデフォルトクラスを返します。

関連項目

指定したクライアントIDの内部のClientオブジェクトを返します。 このメソッドは次の状況でのみ必要とされます。 CustomClientを拡張していない自作クライアントクラスを指定したとき、IClientを直接実装してClientインスタンスを構成する必要があります。 そのような構成されたインスタンスを得るために、自作クラスはgetInternalClient()を使用する必要があります。 そうでない場合は、クライアントアプリケーションはgetInternalClient()ではなく、getClient()を通してClientオブジェクトを取得するべきです。

パラメータ

関連項目

現クライアントが把握しているClientオブジェクトのハッシュを返します。ハッシュキーはクライアントID、ハッシュ値はClientオブジェクトです。 getClients()のクライアントオブジェクトはカスタムクライアントクラスを指定しているクライアントについてはカスタムクライアントクラスのインスタンスになる点がこのメソッドとは対照的です。 getInternalClients()はカスタムクライアントクラスの探索を行わないため、getClients()より高速です。

関連項目

自分自身を除いて、現クライアントがこれまでに把握したクライアントの合計数を返します。

関連項目

現クライアントを除いてReactorが把握しているクライアント数を返します。 ClientManagerがクライアントを監視しているとき(watchForClients()を参照してください)、getNumClients()は現在Unionサーバーに接続している実際のクライアント数を返します。 ClientManagerがクライアントを監視していないときは、getNumClients()は現クライアントが知っているクライアント数だけを返します。 例えば、もし現クライアントが他の3クライアントと一つのルームに入室しており、サーバー上の他のクライアントに関して把握していない場合、getNumClients()はたとえサーバー上に4以上のクライアントが接続しているとしても3を返します。

関連項目

もしClientManagerがクライアントを監視している場合、getNumClientsOnServer()はサーバー上のクライアント数を返します。それ以外の場合は、getNumClientsOnServer()は0を返します。 ClientManager がクライアントを監視しているとき、getNumClientsOnServer() メソッドはgetNumClients()より高速な代替手段を提供します。

関連項目

もし指定したuserIDのクライアントが現在監視アカウントリスト内にある場合、trueを返します。それ以外の場合はfalseを返します。

パラメータ

もし指定したuserIDのクライアントが現在観察されている場合、trueを返します。それ以外の場合はfalseを返します。

パラメータ

関連項目

現クライアントが現在クライアントを監視しているかどうかを示します。

関連項目

指定されたクライアントをサーバーから切断します。 管理者特権を要求します。

キックの試行結果は ClientManagerEvent.KICK_RESULT イベントを通して返されます。

パラメータ

現クライアントをclientIDで指定したクライアントのオブザーバーとして登録するようにサーバーに要求します。 この要求の結果はClientManagerによってトリガーされるClientEvent.OBSERVE_RESULTイベントを通して返されます。 もしその要求が成功すると、Reactorは(もしまだ無い場合は)そのクライアントについてのClientオブジェクトを生成し、ClientEvent.OBSERVEイベントがClientManagerによってトリガーされます。 Clientオブジェクトはサーバー側のそのクライアントの状態と同期されるようになります。 その後もし指定したクライアントの状態が変化すると、現クライアントは次の方法で通知を受けます:

• 観察されているクライアントの属性が変更される: そのClientオブジェクトが AttributeEvent.UPDATE イベントをトリガーします
• 観察されているクライアントの属性が削除される: そのClientオブジェクトが AttributeEvent.DELETE イベントをトリガーします
• 観察されているクライアントがルームに入室する: そのClientオブジェクトが ClientEvent.JOIN_ROOM イベントをトリガーします
• 観察されているクライアントがルームから退室する: そのClientオブジェクトが ClientEvent.LEAVE_ROOM イベントをトリガーします
• 観察されているクライアントがルームを観戦する: そのClientオブジェクトが ClientEvent.OBSERVE_ROOM イベントをトリガーします
• 観察されているクライアントがルームの観戦を停止する: そのClientオブジェクトが ClientEvent.STOP_OBSERVING_ROOM イベントをトリガーします
• 観察されているクライアントがユーザーアカウントにログインする: 現クライアントのAccountManagerが AccountEvent.LOGIN イベントをトリガーします
• 観察されているクライアントがユーザーアカウントからログオフする: 現クライアントのAccountManagerが AccountEvent.LOGOFF イベントをトリガーします
• 観察されているクライアントが切断する: 現クライアントのClientManagerが ClientManagerEvent.CLIENT_DISCONNECTED イベントをトリガーします

クライアントの観察を停止するには、ClientのstopObserving()メソッドを使用してください。

クライアントの観察は、クライアントのマッチメイキングか管理者インターフェースを用いるアプリケーションでよくあるように、クライアントが任意のクライアントリストの状態を常に通知してもらいたいときに使用します。

パラメータ

関連項目

パラメータ

Sends a message to a set of specified clientIDs. メッセージを一つのクライアントのみに送信するには、ClientのsendMessage()メソッドを使用してください。

メッセージを受信するには、受信するクライアントはMessageManagerのaddMessageListener()メソッドを通してメッセージリスナーを登録する必要があります。 例えば、

    // "SMILE"と名づけられたメッセージをclientIDが 2, 34, 84 のクライアントに送信します
    reactor.getClientManager().sendMessage("SMILE", ["2", "34", "84"]);
    
    // メッセージを登録する受信側のクライアントのコードです
    connection.getMessageManager().addMessageListener("SMILE",
                                                      smileListener);
    
    // SMILEメッセージを受信したときに呼び出されるメソッドです
    protected function privateMessageListener (fromClient:IClient,
                                               messageText:String):void {
      trace("Smile from client: " + fromClient.getClientID());
    }
    

ルーム内の全てのクライアントにメッセージを送信するには、RoomのsendMessage()メソッドを使用します。

サーバー上の全てのクライアントにメッセージを送信するには、ServerのsendMessage()メソッドを使用します。

パラメータ

関連項目

クラスをReactorアプリケーション内の全クライアントのデフォルトクラスとして使用するように割り当てます。

デフォルトでは、全てのクライアントはIClientを実装したClientクラスのインスタンスによって表されます。 しかし、自作クラスによってクライアントを表すこともできます。 自作クライアントクラスはClientクラスのsetClientClass()メソッドを通して、基本的にクライアントごとに指定できます。 または、RoomクラスのsetDefaultClientClass()メソッドを通して自作クライアントクラスをルームごとに指定することができます。 または、ClientManagerクラスのsetDefaultClientClass()メソッドを用いると、自作クライアントクラスをグローバルに割り当てられます。 setDefaultClientClass()を通してクラスがグローバルに指定されているときは、それがClientManagerのscopeが未指定のgetClient()メソッドを通して取得される全てのクライアントのクライアントクラスとして使用されます。

RoomのsetDefaultClientClass()メソッドを通して指定された全ての自作クラスはグローバルのデフォルトクライアントクラスを上書きします。 似たように、ClientのsetClientClass()メソッドを通して指定された自作のクラスはいずれもルームとグローバルのデフォルトクライアントクラスをオーバーライドします。

パラメータ

関連項目

パラメータ

BANされたアドレスの監視を止めるようサーバーに要求します。 応答として、サーバーはそのアドレスがBANされるとき、またはBANを解除されるときにもう通知を送信しません。

stopWatchingForBannedAddresses() 要求の結果は ClientManagerEvent.STOP_WATCHING_FOR_BANNED_ADDRESSES_RESULT イベントを通して返されます。

関連項目

クライアントの監視を停止するようにサーバーに要求します。 応答として、サーバーはクライアントが接続または切断するときにもう通知を送信しません。

stopWatchingForClients()要求の結果はClientManagerEvent.STOP_WATCHING_FOR_CLIENTS_RESULTを通して返されます。

関連項目

指定したアドレス（通常はIPアドレス）で現在有効な全てのBANを解除します。 デフォルトでは、unban() は管理者権限を要求します。 他の種類の（例えばモデレーター）クライアントにアドレスのBAN解除を許可するには、リモートクライアントのセキュリティロールをUnionサーバーのセキュリティドキュメントで記述されているように定義してください。

BAN解除の試行結果は ClientManagerEvent.UNBAN_RESULT イベントを通して返されます。

パラメータ

関連項目

     reactor.getClientManager().ban("1.2.3.4", 600, "For cheating");
     

サーバーにBANされたクライアントアドレスの一覧の送信を要求し、それからそのアドレスがBANかBANを解除されるとき常に通知を送信します。 BANリストの準備ができたとき、ClientManagerは ClientManagerEvent.SYNCHRONIZE_BANLIST イベントを送出します。 その後、クライアントアドレスがBANされるとき、ClientManagerは ClientManagerEvent.ADDRESS_BANNEDイベントを送出し、クライアントアドレスのBANが解除されるとき、ClientManagerは ClientManagerEvent.ADDRESS_UNBANNEDイベントを送出します。

watchForBannedAddresses()要求の結果は ClientManagerEvent.WATCH_FOR_BANNED_ADDRESSES_RESULT イベントを通して返されます。

デフォルトでは、watchForBannedAddresses() は管理者権限を要求します。 他の種類の（例えばモデレーター）クライアントにBANされたアドレスの一覧へのアクセスを許可するには、リモートクライアントのセキュリティロールをUnionサーバーのセキュリティドキュメントで記述されているように定義してください。

関連項目

現在サーバーに接続中のクライアントのリストを送信し、その後クライアントが接続か切断したときにはいつでも通知を送信するようにサーバーに要求します。 クライアントリストが準備できると、ClientManagerはClientManagerEvent.SYNCHRONIZEイベントを送出します。 その後のクライアントの接続はClientManagerEvent.CLIENT_CONNECTEDイベントをトリガーします。 その後の切断はClientManagerEvent.CLIENT_DISCONNECTEDイベントをトリガーします。

watchForClients()要求の結果は ClientManagerEvent.WATCH_FOR_CLIENTS_RESULT イベントを通して返されます。

関連項目

この ClientManager がUnionサーバーから、あるクライアントアドレスがBANされたと通知を受けたときに送出されます。 このイベントはこの ClientManager がBANされたアドレスを監視している（watchForBannedAddresses()を参照）ときにのみ有効です。

関連項目

この ClientManager がUnionサーバーから、あるクライアントアドレスのBANが解除されたと通知を受けたときに送出されます。 このイベントはこの ClientManager がBANされたアドレスを監視している（watchForBannedAddresses()を参照）ときにのみ有効です。

関連項目

関連項目

ClientManagerがUnionサーバーからクライアントの接続を通知されたときに送出されます。 このイベントはClientManagerがクライアントを監視しているときにのみ利用可能です(watchForClients()を参照してください)。

関連項目

ClientManagerがUnionサーバーからクライアントの切断を通知されたときに送出されます。 このイベントはClientManagerがクライアントを監視している(watchForClients()を参照)か、切断したクライアントを観察しているとき(observeClient()を参照)にのみ利用可能です。

関連項目

関連項目

関連項目

関連項目

関連項目

関連項目

関連項目

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

• Status.SUCCESS
• Status.ERROR
• Status.NOT_WATCHING

関連項目

関連項目

関連項目

関連項目

関連項目

ClientManagerが先に行われたwatchForClients()要求の結果を受信するときに送出されます。 要求の結果を確認するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:

• Status.SUCCESS
• Status.ERROR
• Status.ALREADY_WATCHING

関連項目