パッケージnet.user1.reactor
クラスpublic final class UpdateLevels
継承UpdateLevels Inheritance Object

バージョン : Reactor 1.0.0

UpdateLevelsクラスはクライアントが入室か観察しているルームについてサーバーから受け取りたい情報量を指定します。 Roomの更新レベルは大規模のマルチユーザーアプリで使用するためのものです。そのようなアプリではクライアントはサーバーから送信される通信量を最小化することで帯域を節約しなければなりません。

例えば、一つのルームに10000名の参加者が入室している国規模のライブクイズを想像してください。 帯域とCPUを節約するために、各参加者はルーム内の他の全参加者についての全ての更新を無効化しなければいけません。その代わりに、サーバー側のルームモジュールから送信されるルームメッセージという形で集約された更新のみを受け取るようにします。 ルームモジュールがそのルームに送信したメッセージのみを取得し、ルームについての他の全ての更新を無視するには、次のコードで示すように、各quizクライアントがルーム入室時に明示的に更新レベルを減らして設定します。 UpdateLevelsクラスのclearAll()メソッドの使用は、全ての更新レベルをfalseにセットする便利な方法を提供するということに留意してください。

   var updateLevels:UpdateLevels = new UpdateLevels();
   // 初めに、clearAll()を呼び出して全ての更新を無効化します
   updateLevels.clearAll()
   // 次に、ルームメッセージ更新のみを有効化します
   updateLevels.roomMessages = true;
   quizRoom.join(null, updateLevels);
   

関連項目

Room.setUpdateLevels()
Room.join()
RoomManager.joinRoom()
Room.observe()
RoomManager.observeRoom()


パブリック プロパティ
 プロパティ定義元
  allRoomAttributes : Boolean
sharedRoomAttributes変数と同様ですが、非共有属性も含んでいます。
UpdateLevels
  observerCount : Boolean
trueのとき、現クライアントは対象のルームを観察しているクライアントの数が変更されると常に更新を送信されます。デフォルトはfalseです。
UpdateLevels
  observerList : Boolean
trueのとき、現クライアントは対象のルームの観察をクライアントが開始するか停止すると常に更新を送信されます。デフォルトはfalseです。
UpdateLevels
  observerLoginLogoff : Boolean
trueのとき、現クライアントは対象のルームの観察者がログインかログオフすると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  occupantCount : Boolean
trueのとき、現クライアントは対象のルームに入室しているクライアントの数が変更されると常に更新を送信されます。デフォルトはfalseです。
UpdateLevels
  occupantList : Boolean
trueのとき、現クライアントは対象のルームにクライアントが入室するか退室すると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  occupantLoginLogoff : Boolean
trueのとき、現クライアントは対象のルームの入室者がログインかログオフすると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  roomMessages : Boolean
trueのとき、現クライアントは対象のルームにメッセージが送信されると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  sharedObserverAttributesGlobal : Boolean
trueのとき、現クライアントは対象のルームの観察者がグローバル共有属性をセットするか削除すると常に更新を送信されます。デフォルトはfalseです。
UpdateLevels
  sharedObserverAttributesRoom : Boolean
trueのとき、現クライアントは対象のルームの観察者がルームをスコープとした共有属性をセットするか削除すると常に更新を送信されます。デフォルトはfalseです。
UpdateLevels
  sharedOccupantAttributesGlobal : Boolean
trueのとき、現クライアントは対象のルームの入室者がグローバル共有属性をセットするか削除すると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  sharedOccupantAttributesRoom : Boolean
trueのとき、現クライアントは対象のルームの入室者がルームをスコープとした共有属性をセットするか削除すると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
  sharedRoomAttributes : Boolean
trueのとき、現クライアントは対象のルームの共有属性が変更されるか削除されると常に更新を送信されます。デフォルトはtrueです。
UpdateLevels
パブリック メソッド
 メソッド定義元
  
UpdateLevels
  
clearAll():void
全ての更新レベルをfalseにセットします。
UpdateLevels
  
fromInt(levels:int):void
与えられたint値をベースにしてこのUpdateLevelsのレベルを割り当てます。これは新たに希望する更新レベルをビット単位で表します。
UpdateLevels
  
全ての更新レベルを、ドキュメント内で指定されている各更新レベル定数のデフォルト値にセットします。
UpdateLevels
  
toInt():int
このUpdateLevelsオブジェクトを、更新レベルを指定するbit列を表すint値に変換します。
UpdateLevels
プロパティの詳細
allRoomAttributesプロパティ
public var allRoomAttributes:Boolean

バージョン : Reactor 1.0.0

sharedRoomAttributes変数と同様ですが、非共有属性も含んでいます。 管理者権限を要求します。デフォルトはfalseです。

observerCountプロパティ 
public var observerCount:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームを観察しているクライアントの数が変更されると常に更新を送信されます。デフォルトはfalseです。 更新は次のイベントをトリガーします:

observerListプロパティ 
public var observerList:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの観察をクライアントが開始するか停止すると常に更新を送信されます。デフォルトはfalseです。 更新は次のイベントをトリガーします:

observerLoginLogoffプロパティ 
public var observerLoginLogoff:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの観察者がログインかログオフすると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

関連項目

occupantCountプロパティ 
public var occupantCount:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームに入室しているクライアントの数が変更されると常に更新を送信されます。デフォルトはfalseです。 更新は次のイベントをトリガーします:

occupantListプロパティ 
public var occupantList:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームにクライアントが入室するか退室すると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

occupantLoginLogoffプロパティ 
public var occupantLoginLogoff:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの入室者がログインかログオフすると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

関連項目

roomMessagesプロパティ 
public var roomMessages:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームにメッセージが送信されると常に更新を送信されます。デフォルトはtrueです。 更新はRoomクラスのaddMessageListener()メソッドを通して登録されたメッセージリスナーをトリガーします。

関連項目

sharedObserverAttributesGlobalプロパティ 
public var sharedObserverAttributesGlobal:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの観察者がグローバル共有属性をセットするか削除すると常に更新を送信されます。デフォルトはfalseです。 更新は次のイベントをトリガーします:

sharedObserverAttributesRoomプロパティ 
public var sharedObserverAttributesRoom:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの観察者がルームをスコープとした共有属性をセットするか削除すると常に更新を送信されます。デフォルトはfalseです。 更新は次のイベントをトリガーします:

sharedOccupantAttributesGlobalプロパティ 
public var sharedOccupantAttributesGlobal:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの入室者がグローバル共有属性をセットするか削除すると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

sharedOccupantAttributesRoomプロパティ 
public var sharedOccupantAttributesRoom:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの入室者がルームをスコープとした共有属性をセットするか削除すると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

sharedRoomAttributesプロパティ 
public var sharedRoomAttributes:Boolean

バージョン : Reactor 1.0.0

trueのとき、現クライアントは対象のルームの共有属性が変更されるか削除されると常に更新を送信されます。デフォルトはtrueです。 更新は次のイベントをトリガーします:

コンストラクタの詳細
UpdateLevels()コンストラクタ
public function UpdateLevels()



メソッドの詳細
clearAll()メソッド
public function clearAll():void

バージョン : Reactor 1.0.0

全ての更新レベルをfalseにセットします。

fromInt()メソッド 
public function fromInt(levels:int):void

バージョン : Reactor 1.0.0

与えられたint値をベースにしてこのUpdateLevelsのレベルを割り当てます。これは新たに希望する更新レベルをビット単位で表します。 fromInt()メソッドはUnionサーバーからルームの更新レベルを受信するときにReactorによって内部的に使用されます。

パラメータ

levels:int

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

バージョン : Reactor 1.0.0

全ての更新レベルを、ドキュメント内で指定されている各更新レベル定数のデフォルト値にセットします。

toInt()メソッド 
public function toInt():int

バージョン : Reactor 1.0.0

このUpdateLevelsオブジェクトを、更新レベルを指定するbit列を表すint値に変換します。 toInt()メソッドははUnionサーバーにルームの更新レベルを送信するときにReactorによって内部的に使用されます。

戻り値
int