そして先日、社内のODF発表会でUnion Platformの概要部分だけをざっくり解説しました。ブログへの掲載許可を頂いたので、その時のスライドを紹介します。５分ぐらいで発表したのでざっくり概要を知るには良いかも知れません。

Union Platformの紹介(クリックで始まります。以降のスライドへはダブルクリックで進みます。)

もっとUnion Platformを知りたい方は以下の記事もご確認下さい。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

Union Platformに興味がある方は是非、http://bit.ly/uniongrpへ。
お気軽にご参加下さい。

サンプルを充実させたいので、まずはサンプルの準備をして行きたいと思います。

UPC versionは、1.4.0(2009年09月4日現在)となっております。
UPCとは、the Union Procecure Callの略です。ReactorとUnion Serverとの間で取り交わされる内部的なメッセージフォーマットです。基本的に、Unionを利用する開発者が意識的に操作することはありません。

構造

UPCは簡単なXML形式で表されます。XMLには、メッセージIDと複数の引数のリストが含まれます。

以下がUPCの例です。

<U>
	<M>C2S_CLIENT_HELLO(u65)</M>
	<L>
		<A>Reactor</A>
		<A>Flash Player WIN 10,0,32,18 StandAlone (debug, localTrusted); 1.0.0 (Build 252)</A>
		<A>1.4.0</A>
	</L>
</U>

メッセージID

C2S_CLIENT_HELLO(u65)

引数リスト

• Reactor
• Flash Player WIN 10,0,32,18 StandAlone (debug, localTrusted); 1.0.0 (Build 252)
• 1.4.0

メッセージID

メッセージIDは()内のショートコードが一意となっています。L要素内の各A要素が引数のリストとなります。

予約語

完全修飾Room IDには、*(アスタリスク), |(パイプ)を含めることが出来ません。

*(アスタリスク)

*(アスタリスク)はRoom IDの修飾時に、ワイルドカードとして働きます。たとえば、

com.asmple.chat.*

はcom.asmple.chat.fashion, com.asmple.chat.gameなど、com.asmple.chat.で修飾されるRoom IDすべてを指します。

|(パイプ)

|(パイプ)は項目の区切りとして使用します。

以下のようなメッセージで確認できます。

<U>
	<M>C2S_CREATE_ROOM(u24)</M>
	<L>
		<A><![CDATA[com.asmple.union.alpha4.test]] ></A>
		<A><![CDATA[_DIE_ON_EMPTY|true|_MAX_CLIENTS|-1|_PASSWORD||_CLIENT_TIMEOUT|-1]] ></A>
		<A></A>
		<A></A>
	</L>
</U>

上記のUPCメッセージは、以下のコードを実行した際にUnion Serverへ送信されたものです。

// _reactorはReactorEvent.READYイベントを送出済みのReactorインスタンス
var room:Room = _reactor.getRoomManager().createRoom("com.asmple.union.alpha4.test");

RoomManagerインスタンスのcreateRoomメソッドの引数を確認すると第二引数はRoomSettingsインスタンスを受け取ることが分かります。

この例では、第二引数以降を省略しているため、内部でデフォルトのRoomSettingsを渡していると思われます。

RoomSettingsのドキュメントを確認すると、デフォルトの値と先ほどのUPCのメッセージの引数として渡されている値が一致していることが分かります。

このようにRoomのセッティングの内容が|(パイプ)区切りで送信されていることが分かります。

この|(パイプ)の文字列は、Tokens.RS定数の値です。

ネイティブUPCメッセージ

UPCで定義されるメッセージ一覧です。とてつもなく長いです。

ReactorからUnion Serverへ送信されるメッセージ

SEND_MESSAGE_TO_ROOMS

Union Serverに対して、Message識別子で識別されるRECEIVE_MESSAGE(u7)メッセージの送信を要求します。Union Serverは指定されたRoom IDリストに含まれるRoomにjoin, observeし、指定されてたフィルター条件に合致するClientへRECEIVE_MESSAGE(u7)メッセージを送信します。

内部コード

u1

引数

• Message識別子
• Tokens.RS区切りの送信先Room IDリスト
• 送信先に自身を含むかどうかのフラグ
• フィルター
• sendMessageの引数(以降、複数指定可能

対応するReactor API

• RoomManager.sendMessage()
• Room.sendMessage()

SEND_MESSAGE_TO_CLIENTS

Union Serverに対して、Message識別子で識別されるRECEIVE_MESSAGE(u7)メッセージの送信を要求します。Union Serverは指定されたClient IDリストに含まれ、指定されてたフィルター条件に合致するClientへRECEIVE_MESSAGE(u7)メッセージを送信します。ただし、Client.sendMessage()の実装では、フィルターはなし、指定出来るClient IDは固定でClientインスタンスが表すClient ID1つです。

内部コード

u2

引数

• Message識別子
• Tokens.RS区切りの送信先Client IDリスト
• フィルター
• sendMessageの引数(以降、複数指定可能)

対応するReactor API

• Client.sendMessage()

SEND_MESSAGE_TO_SERVER

Union Serververに対して、Message識別子で識別されるRECEIVE_MESSAGE(u7)メッセージの送信を要求します。Union Serverは指定されたフィルター条件に合致するClientへRECEIVE_MESSAGE(u7)メッセージを送信します。

内部コード

u57

引数

• Message識別子
• 送信先に自身を含むかどうかのフラグ
• フィルター
• sendMessageの引数(以降、複数指定可能)

対応するReactor API

• Server.sendMessage()

SET_CLIENT_ATTR

Union Serverに対して、指定したClientのClient Attributeの設定を要求します。Union Serverは要求の結果をSET_CLIENT_ATTR_RESULT(u73)メッセージで送信します。成功した場合、Union Serverは、CLIENT_ATTR_UPDATE(u8)メッセージも送信します。

内部コード

u3

引数

• Client ID
• Client Attribute名
• Client Attribute値
• スコープ
• オプションを8bitで指定

対応するReactor API

• Client.setAttribute()

JOIN_ROOM

Union Serverに対して、指定したRoomへのjoinを要求します。Union Serverは要求の結果をJOIN_ROOM_RESULT(u72)メッセージで送信します。成功した場合、Union Serverは、JOINED_ROOM(u6)メッセージも送信します。

内部コード

u4

引数

• Room ID
• Room パスワード

対応するReactor API

• Room.join()

SET_ROOM_ATTR

Union Serverに対して、指定したRoomのRoom Attributeの設定を要求します。Union Serverは要求の結果をSET_ROOM_ATTR_RESULT(u74)メッセージで送信します。成功した場合、Union Serverは、ROOM_ATTR_UPDATE(u9)メッセージも送信します。

内部コード

u5

引数

• Room ID
• Room Attribute名
• Room Attribute値
• オプションを8bitで指定

対応するReactor API

• Room.setAttribute()

LEAVE_ROOM

Union Serverに対して、送信元のClientを指定したRoomからのleaveを要求します。Union Serverは要求の結果をLEAVE_ROOM_RESULT(u76)メッセージで送信します。成功した場合、Union Serverは、LEFT_ROOM(u44)メッセージも送信します。

内部コード

u10

引数

• Room ID

対応するReactor API

• Room.leave()

CREATE_PERSISTENT_CLIENT

Union Serverに対して、送信元のClientをデータベース内の永続化クライアントとしての登録を要求します。

内部コード

u11

引数

• Client名
• Clientパスワード

対応するReactor API

• PersistenceManager.createPersistentClient()

REMOVE_PERSISTENT_CLIENT

Union Serverに対して、送信元のClientをデータベース内の永続化クライアントとしての解除を要求します。

内部コード

u12

引数

• Client名
• Clientパスワード

対応するReactor API

• PersistenceManager.removePersistentClient()

CHANGE_PERSISTENT_CLIENT

Union Serverに対して、送信元のClientの永続化クライアントパスワード変更を要求します。

内部コード

u13

引数

• Client名
• Clientの現在のパスワード
• Clientの新しいパスワード

対応するReactor API

• PersistenceManager.changePersistentClient()

LOGIN_CLIENT

Union Serverに対して、送信元のClientに対応した永続化クライアントでのログインを要求します。Union Serverは、永続化クライアントのClient AttributeをCLIENT_ATTR_UPDATE(u8)メッセージで送信します。

内部コード

u14

引数

• Client名
• Clientパスワード

対応するReactor API

• PersistenceManager.loginClient()

GET_NUM_CLIENTS

Union Serverに対して、指定したRoom内のClient数を要求する。Union Serverは要求の結果をGET_NUM_CLIENTS_RESULT(u75)メッセージで送信します。成功した場合、Union ServerはNUM_CLIENTS_UPDATE(u34)メッセージも送信します。

内部コード

u18

引数

• Room IDまたは、Room修飾子

対応するReactor API

• RoomManager.getNumClientsInRooms()
• Room.synchronizeClientCount()
• Server.getNumClientsOnServer()

SYNC_TIME

Union Serverに対して、現在の時刻の送信を要求します。Union ServerはSERVER_TIME_UPDATE(u50)メッセージを送信します。

内部コード

u19

引数

• なし

対応するReactor API

• Server.syncTime()

GET_ROOM_LIST

Union Serverに対して、指定したRoomのリストの取得を要求します。Union ServerはROOM_LIST_UPDATE(u38)メッセージを送信します。

内部コード

u21

引数

• Room 修飾子

対応するReactor API

• RoomManager.getRoomListFromServer()

CREATE_ROOM

Union Serverに対して、指定したRoom IDのRoom作成を要求します。Union Serverは要求の結果をROOM_ADDED(u39)メッセージで送信します。

内部コード

u24

引数

• Room ID
• Tokens.RS区切りのRoom Settings項目リスト
• Tokens.RS区切りのRoom Attribute項目リスト
• Tokens.RS区切りのRooom Module ClassまたはScriptリスト

対応するReactor API

• RoomManager.createRoom()

REMOVE_ROOM

Union Serverに対して、指定したRoom IDのRoom削除を要求します。Union Serverは要求の結果を、このメッセージを送信したClientに対して、REMOVE_ROOM_RESULT(u33)メッセージを送信します。Union Serverは要求の結果をRoom内の全クライアントにROOM_REMOVED(u40)メッセージで送信します。

内部コード

u25

引数

• Room ID
• Room パスワード

対応するReactor API

• RoomManager.removeRoom()

WATCH_FOR_ROOMS

Union Serverに対して、指定したRoom 修飾子のRoomが追加、削除された際の通知を要求します。Union Serverは要求の結果をWATCH_FOR_ROOMS_RESULT(u42)メッセージで送信します。その際、1つでも一致するRoomが存在すれば、Union ServerはROOM_LIST_UPDATE(u38)メッセージを送信します。

引き続き、Union Serverは修飾子に一致するRoomが追加されれば、ROOM_ADDED(u39)メッセージを送信します。削除されえば、ROOM_REMOVED(u40)メッセージを送信します。

内部コード

u26

引数

• Room 修飾子

対応するReactor API

• RoomManager.watchForRooms()

STOP_WATCHING_FOR_ROOMS

Union Serverに対して、指定したRoom 修飾子のRoomが追加、削除された際の通知停止を要求します。Union Serverは要求の結果をSTOP_WATCHING_FOR_ROOMS_RESULT(u43)メッセージで送信します。

内部コード

u27

引数

• Room 修飾子

対応するReactor API

• RoomManager.stopWatchingForRooms()

SYNC_ROOM

Union Serverに対して、指定したRoomのスナップショットを要求します。Union Serverは要求の結果をSYNC_ROOM_RESULT(u60)メッセージで送信します。成功した場合、Union ServerはROOM_SNAPSHOT(u54)メッセージを送信します。

内部コード

u55

引数

• Room ID
• Room パスワード

対応するReactor API

• Room.synchronize()
• RoomManager.synchronizeRoom()

OBSERVE_ROOM

Union Serverに対して、指定したRoomへのobserveを要求します。Union Serverは要求の結果をOBSERVE_ROOM_RESULT(u77)メッセージで送信します。成功した場合、Union ServerはOBSERVED_ROOM(u59)メッセージを送信します。

内部コード

u58

引数

• Room ID
• Room パスワード

対応するReactor API

• Room.observe()
• RoomManager.observeRoom()

STOP_OBSERVING_ROOM

Union Serverに対して、指定したRoomへのobserve停止を要求します。Union Serverは要求の結果をSTOP_OBSERVING_ROOM_RESULT(u78)メッセージで送信します。成功した場合、Union ServerはJOIN_ROOM_RESULT(u62)メッセージを送信します。

内部コード

u61

引数

• Room ID

対応するReactor API

• Room.stopObserving()
• RoomManager.stopObservingRoom()

SET_ROOM_UPDATE_LEVELS

Union Serverに対して、指定したRoom内での更新通知レベル設定を要求します。

内部コード

u64

引数

• Room ID
• Tokens.RS区切りの入室者更新レベル, Room更新レベル, Message更新レベル

対応するReactor API

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

CLIENT_HELLO

Union Serverに対して、コネクションを要求します。Union Serverは、SERVER_HELLO(u66)メッセージを送信します。要求が成功した場合、Union Serverは、CLIENT_METADATA(u29)、CLIENT_READY(u63)メッセージを送信します。

内部コード

u65

引数

• Client タイプ
• ユーザーエージェント
• UPCバージョン

対応するReactor API

• ReactorEvent.PROTOCOL_INCOMPATIBLE.

REMOVE_ROOM_ATTR

Union Serverに対して、指定したRoomのRoom Attributeの削除を要求します。Union Serverは要求の結果を、REMOVE_ROOM_ATTR_RESULT(u80)メッセージで送信します。要求が成功した場合、Union ServerはROOM_ATTR_REMOVED(u79)メッセージを送信します。

内部コード

u67

引数

• Room ID
• Room Attribute名

対応するReactor API

• Room.deleteAttribute()

REMOVE_CLIENT_ATTR

Union Serverに対して、Client Attributeの削除を要求します。Union Serverは要求の結果を、REMOVE_CLIENT_ATTR_RESULT(u82)メッセージで送信します。要求が成功した場合、Union ServerはCLIENT_ATTR_REMOVED(u81)メッセージを送信します。

内部コード

u69

引数

• Client ID
• Client Attribute名
• Client Attributeスコープ

対応するReactor API

• Client.deleteAttribute()

SEND_ROOMMODULE_MESSAGE

Union Serverに対して、指定したRoomにモジュールメッセージ識別子で指定したモジュールメッセージを送信します。

内部コード

u70

引数

• Room ID
• モジュールメッセージ識別子
• モジュールメッセージ引数(以降、複数指定可能)

対応するReactor API

• Room.sendModuleMessage()

SEND_SERVERMODULE_MESSAGE

Union Serverに対して、指定したモジュールにモジュールメッセージ識別子で指定したモジュールメッセージを送信します。

内部コード

u71

引数

• モジュール ID
• モジュールメッセージ識別子
• モジュールメッセージ引数(以降、複数指定可能)

対応するReactor API

• Server.sendModuleMessage()

Union ServerからReactorへ送信されるメッセージ

JOINED_ROOM

Clientがjoinしたroomの情報を通知します。

内部コード

u6

引数

• Room ID

RECEIVE_MESSAGE

Messageを送信します。

内部コード

u7

引数

• Message識別子
• ブロードキャストタイプ
• 送信元Client ID(Union Serverが送信元の場合は空)
• 送信先Room ID
• sendMessageの引数(以降、複数指定可能)

対応Reactor API

• MessageManager.addMessageListener() (直接ではない)
• Room.addMessageListener() (直接ではない)

ブロードキャストタイプ

CLIENT_ATTR_UPDATE

Client Attributeの更新を通知します。

内部コード

u8

引数

• Room ID
• Client ID
• Client Attribute名
• Client Attribute値

対応Reactor API

• RoomEvent.UPDATE_CLIENT_ATTRIBUTE

ステータスコード

ROOM_ATTR_UPDATE

内部コード

u9

引数

• Room ID
• Client ID(Union Serverが更新元の場合は空)
• Room Attribute名
• Room Attribute値

対応Reactor API

• RoomEvent.UPDATE_ROOM_ATTRIBUTE

ステータスコード

CLIENT_METADATA

接続元Clientへ初期情報を通知します。

内部コード

u29

引数

• Client ID

対応Reactor API

• なし(UPCが内部的に処理します)

CREATE_ROOM_RESULT

ClientのRoom作成試行の結果を通知します。

内部コード

u32

引数

• Room ID
• ステータス

対応Reactor API

• RoomManagerEvent.CREATE_ROOM_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_EXISTS

REMOVE_ROOM_RESULT

ClientのRoom削除試行の結果を通知します。

内部コード

u33

引数

• Room ID
• ステータス

対応Reactor API

• RoomManagerEvent.REMOVE_ROOM_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_NOT_FOUND
• AUTHORIZATION_REQUIRED
• AUTHORIZATION_FAILED

NUM_CLIENTS_UPDATE

特定のスコープ内RoomのClient数を通知します。

内部コード

u34

引数

• Roomのスコープ
• 総Client数
• ユニークClient数

対応Reactor API

• RoomEvent.CLIENT_COUNT
• RoomManagerEvent.CLIENT_COUNT
• ServerEvent.CLIENT_COUNT

ステータスコード

CLIENT_ADDED

ClientがRoomにjoinしたことを通知します。

内部コード

u36

引数

• Room ID
• Client ID
• Tokens.RS区切りのグローバルClient Attribute
• Tokens.RS区切りのRoomスコープ Client Attribute

対応Reactor API

• RoomEvent.ADD_CLIENT

CLIENT_REMOVED

ClientがRoomからleaveしたことを通知します。

内部コード

u37

引数

• Room ID
• Client ID

対応Reactor API

• RoomEvent.REMOVE_CLIENT

ROOM_LIST_UPDATE

特定のRoomスコープのRoom一覧の更新を通知します。

内部コード

u38

引数

• Roomスコープ
• Room ID(以降、複数指定可能)

対応Reactor API

• RoomManagerEvent.ROOM_ADDED
• RoomManagerEvent.ROOM_REMOVED

ROOM_ADDED

特定のRoomが追加されたことを通知します。

内部コード

u39

引数

• Room ID

対応Reactor API

• RoomManagerEvent.ROOM_ADDED

ROOM_REMOVED

特定のRoomが削除されたことを通知します。

内部コード

u40

引数

• Room ID

対応Reactor API

• RoomManagerEvent.ROOM_REMOVED

WATCH_FOR_ROOMS_RESULT

ClientのWATCH_FOR_ROOMS試行の結果を通知します。

内部コード

u42

引数

• Room ID修飾子
• ステータス

対応Reactor API

• RoomManagerEvent.WATCH_FOR_ROOMS_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• INVALID_QUALIFIER
• ALREADY_WATCHING

STOP_WATCHING_FOR_ROOMS_RESULT

ClientのSTOP_WATCHING_FOR_ROOMS試行の結果を通知します。

内部コード

u43

引数

• Room ID修飾子
• ステータス

対応Reactor API

• RoomManagerEvent.STOP_WATCHING_FOR_ROOMS_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• INVALID_QUALIFIER
• NOT_WATCHING_QUALIFIER

LEFT_ROOM

ClientがRoomからleaveしたことを通知します。

内部コード

u44

引数

• Room ID

対応Reactor API

• RoomEvent.LEAVE

CHANGE_PERSISTENT_CLIENT_RESULT

Clientの永続化Clientパスワード変更試行の結果を通知します。

内部コード

u46

引数

• ステータス

対応Reactor API

• PersistenceEvent.CHANGED

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• NAME_NOT_FOUND
• AUTHORIZATION_FAILED

CREATE_PERSISTENT_CLIENT_RESULT

Clientの永続化Client登録試行の結果を通知します。

内部コード

u47

引数

• ステータス

対応Reactor API

• PersistenceEvent.CREATED

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• NAME_EXISTS

REMOVE_PERSISTENT_CLIENT_RESULT

Clientの永続化Client削除試行の結果を通知します。

内部コード

u48

引数

• ステータス

対応Reactor API

• PersistenceEvent.REMOVED

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• NAME_NOT_FOUND
• AUTHORIZATION_FAILED

LOGIN_CLIENT_RESULT

Clientの永続化Clientログイン試行の結果を通知します。

内部コード

u49

引数

• ステータス
• Tokens.RS区切りのClient Attribute(以降、複数指定可能)

対応Reactor API

• PersistenceEvent.LOGIN

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ALREADY_LOGGED_IN
• AUTHORIZATION_FAILED

SERVER_TIME_UPDATE

Union Serverの現在の時刻を通知します。

内部コード

u50

引数

• Union Serverの時刻

対応Reactor API

• ServerEvent.TIME_SYNC

ROOM_SNAPSHOT

RoomのRoom AttributeやClientなどの状態を通知します。

内部コード

u54

引数

• Room ID
• Tokens.RS区切りのRoom Attribute
• Client ID
• Client グローバルCleint Attribute
• Client RoomスコープCleint Attribute
• 以降、Client ID, Client グローバルCleint Attribute, Client RoomスコープCleint Attributeの組で複数指定可能)

対応Reactor API

• Room.synchronize()
• RoomEvent.SYNCHRONIZE
• Room.join()
• Room.observe()

OBSERVED_ROOM

ClientがRoomをobserveしたことを通知します。

内部コード

u59

引数

• Room ID

対応Reactor API

• RoomEvent.OBSERVE

SYNC_ROOM_RESULT

ClientのSYNC_ROOM試行の結果を通知します。

内部コード

u60

引数

• Room ID
• ステータス

対応Reactor API

• RoomEvent.SYNCHRONIZE
• RoomManagerEvent.SYNC_NONEXISTENT_ROOM

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_NOT_FOUND
• AUTHORIZATION_REQUIRED
• AUTHORIZATION_FAILED
• ALREADY_SYNCHRONIZED

STOPPED_OBSERVING_ROOM

ClientがRoomのobserveを停止したことを通知します。

内部コード

u62

引数

• Room ID

対応Reactor API

• RoomEvent.STOP_OBSERVING

CLIENT_READY

Clientの初期化処理が完了し準備が出来たことを通知します。

内部コード

u63

引数

• なし

対応Reactor API

• UConnectionEvent.READY

SERVER_HELLO

ClientにUnion ServerやUPCプロトコルの情報を通知します。

内部コード

u66

引数

• Union Serverバージョン
• セッションID
• UPCバージョン
• Clientとのプロトコル互換

対応Reactor API

• Union Serverバージョン
• セッションID
• UPCバージョン
• protocolCompatible

JOIN_ROOM_RESULT

Clientのjoin試行の結果を通知する。

内部コード

u72

引数

• Room ID
• ステータス

対応Reactor API

• RoomEvent.JOIN_RESULT
• RoomManagerEvent.JOIN_NONEXISTENT_ROOM

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ALREADY_IN_ROOM
• ROOM_NOT_FOUND
• ROOM_FULL
• AUTHORIZATION_REQUIRED
• AUTHORIZATION_FAILED

SET_CLIENT_ATTR_RESULT

Client Attribute更新試行の結果

内部コード

u73

引数

• Room ID
• Client ID
• Client Attribute名
• ステータス

対応Reactor API

• RoomEvent.SET_CLIENT_ATTRIBUTE_RESULT
• ClientEvent.SET_ATTRIBUTE_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• DUPLICATE_VALUE
• CLIENT_NOT_FOUND
• IMMUTABLE
• SERVER_ONLY
• EVALUATION_FAILED

SET_ROOM_ATTR_RESULT

Room Attribute更新試行の結果

内部コード

u74

引数

• Room ID
• Room Attribute名
• ステータス

対応Reactor API

• RoomEvent.SET_ROOM_ATTRIBUTE_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• IMMUTABLE
• SERVER_ONLY
• EVALUATION_FAILED

GET_NUM_CLIENTS_RESULT

Clientの数を通知します。

内部コード

u75

引数

• Room スコープ
• ステータス

対応Reactor API

• RoomEvent.GET_NUM_CLIENTS_RESULT
• RoomManagerEvent.GET_NUM_CLIENTS_RESULT
• ServerEvent.GET_NUM_CLIENTS_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_NOT_FOUND

LEAVE_ROOM_RESULT

特定のRoomへのClientのleave試行の結果を通知します。

内部コード

u76

引数

• Room ID
• ステータス

対応Reactor API

• RoomEvent.LEAVE_RESULT
• RoomManagerEvent.LEAVE_NONEXISTENT_ROOM

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• NOT_IN_ROOM
• ROOM_NOT_FOUND

OBSERVE_ROOM_RESULT

特定のRoomへのClientのobserve試行の結果を通知します。

内部コード

u77

引数

• Room ID
• ステータス

対応Reactor API

• RoomEvent.OBSERVE_RESULT
• RoomManagerEvent.OBSERVE_NONEXISTENT_ROOM

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_NOT_FOUND
• AUTHORIZATION_REQUIRED
• AUTHORIZATION_FAILED
• ALREADY_OBSERVING

STOP_OBSERVING_ROOM_RESULT

特定のRoomへのClientのobserve停止試行の結果を通知します。

内部コード

u78

引数

• Room ID
• ステータス

対応Reactor API

• RoomEvent.STOP_OBSERVING
• RoomManagerEvent.STOP_OBSERVING_NONEXISTENT_ROOM

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• ROOM_NOT_FOUND
• NOT_OBSERVING

ROOM_ATTR_REMOVED

Room Attributeの削除を通知します。

内部コード

u79/dd>

引数

• Room ID
• Client ID
• Room Attribute名

対応Reactor API

• RoomEvent.DELETE_ROOM_ATTRIBUTE

REMOVE_ROOM_ATTR_RESULT

Room Attributeの削除試行の結果を通知します。

内部コード

u80

引数

• Room ID
• Room Attribute名
• ステータス

対応Reactor API

• RoomEvent.DELETE_ROOM_ATTRIBUTE_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• IMMUTABLE
• SERVER_ONLY
• ROOM_NOT_FOUND
• ATTR_NOT_FOUND

CLIENT_ATTR_REMOVED

Client Attributeの削除を通知します。

内部コード

u81

引数

• Room ID
• Client ID
• Client Attribute名

対応Reactor API

• RoomEvent.DELETE_CLIENT_ATTRIBUTE

REMOVE_CLIENT_ATTR_RESULT

Client Attributeの削除試行の結果を通知します。

内部コード

u82

引数

• Room ID
• Client ID
• Client Attribute名
• ステータス

対応Reactor API

• RoomEvent.DELETE_ROOM_ATTRIBUTE_RESULT

ステータスコード

• SUCCESS
• ERROR (サーバ内部処理で例外発生)
• CLIENT_NOT_FOUND
• IMMUTABLE
• SERVER_ONLY
• ATTR_NOT_FOUND

まとめ

UPCはUnionを使った開発で直接扱いませんが、ReactorのデバッグログやUnion Serverのログに出力されます。興味がある方はUPCのログを眺めて見てください。

リリースノートは以下から確認出来ます。
Union 1.0 Alpha4 Release Notes

なお、以前のalpha3向けのエントリーは更新する予定です。完了しましたら別途お知らせいたします。

では、変更された点を確認してみます。

UPC仕様の更新

ReactorとUnion Serverとのやりとりで利用されているUPCの仕様が変更されたようです。

詳しくは、UPC変更点を参照して下さい。

ReactorのAPI

ClientクラスのgetAttributeメソッドの引数指定の変更と、細かなバグフィックスが行われたようです。

Reactorドキュメント

主に、以下のクラスのドキュメントが更新されています。

• net.user1.reactor.Client
• net.user1.reactor.ClientEvent
• net.user1.reactor.ClientManager
• net.user1.reactor.Reactor
• net.user1.reactor.ReactorEvent
• net.user1.reactor.RoomEvent
• net.user1.reactor.Tokens
• net.user1.reactor.UPC
• net.user1.reactor.Validator

ここに挙げたクラスのドキュメント以外にも、文言の微調整がいくつかされているようです。

APIの変更

net.user1.reactor.ClientクラスのgetAttributeメソッド

引数の順番が変更になりました。

alpha3

// グローバルスコープ
client.getAttribute(null, "attributeKey");
 
// 特定のRoomスコープ
client.getAttribute("roomID", "attributeKey");

alpha4

// グローバルスコープ
client.getAttribute("attributeKey");
 
// 特定のRoomスコープ
client.getAttribute("attributeKey", "roomID");

net.user1.reactor.ClientManagerのgetAttributeForClientsメソッド

ClientクラスのgetAttributeメソッドと同様に、引数の順番が変更となりました。

net.user1.reactor.RoomEventの定数

UPCの仕様変更に伴い、RoomEventの定数が増えています。

Union Server

policy.htmlを更新した際に、ポリシーが自動で更新されるようになりました。その他バグフィックスが行われたようです。

クラスの追加

docs/javadocの下を見る限り以下のクラスが追加されたようです。

• net.user1.union.core.connection.Connection
• net.user1.union.core.def.ConnectionFilterDef
• net.user1.union.api.Reauest

Union Server起動時の挙動

windows環境で、startserver.batを実行すると、今まではコマンドプロンプトが開いてログも表示されていたのですが、表示されなくなりました。管理用ツール(UnionAdmin.swf)で見れるようになったので表示されなくなったようです。

その他の更新は、Union Server変更点を参照して下さい。

管理ツール(UnionAdmin.swf)

前述の通り、Union Serverのログを確認できるようになりました。FMS管理コンソールと似てきましたね。正直alpha3まではあまり使っていなかったのですが、Roomの情報も細かく見れるようになったりバグが修正されたようなので、これからは使ってみようと思います。

その他の更新は、管理ツール(UnionAdmin.swf)変更点を参照して下さい。

その他の更新

@keno42さんからの情報です。ClientクラスのsetAttribute()メソッド実行時に、自身のClient Attributeの更新通知は即時反映されるようになりました。

以下のサンプルで試した見たのですが、tryunion.comに接続した状態で、自身のClient Attribute更新時は15msec程度でした。別ClientのClient Attribute更新時は、状況によりりますが100msec以上かかるようです。

自身のClient Attributeの更新も他のクライアントと同様のレスポンスを期待する場合には、ClientクラスのsetAttribute()メソッド実行時のevaluateオプションをtrueにすると、サーバでの処理が走るので強制的にUnion Server経由で更新が通信されるようになるそうです。

wonderflの投稿

wonderflのUnionライブラリもalpha4に更新されたようですので、Unionライブラリを使っている投稿は最コンパイルする必要があります。

また、私の以下の2つの投稿では、ClientメソッドのgetAttributeメソッドを使用しておりましたので引数の修正を行いました。

• Union Platform avatar chat forked from: colin challenge for professionals
• Unionチャットサンプル

まとめ

私がUnionライブラリを本格的に使い始めたのはalpha3からでしたので、初めてのアップデートでした。プロダクトのアップデートは大変ワクワクしますね。Derek Claytonさん、Colin Moockさんありがとうございます。

作成するRoom Moduleの概要

ReactorからtwitというModule Messageを送信すると、Union Serverがtwitterにtwitするという機能を作ってみます。

• Reactorから今回作成するRoom Moduleが動作するRoomへ接続する
• RoomインスタンスのsendModuleMessage()メソッドからtwitというModule Messageを送信
• Room Moduleは受け取ったModule Messageをtwitterに投稿する

Room Moduleの大枠の作成

com.asmple.server.union.module.roomパッケージ内にTwitModuleSampleというクラスを作成します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

package com.asmple.server.union.module.room;
 
import net.user1.union.core.context.ModuleContext;
 
public class TwitModuleSample implements Module {
 
	@Override
	public boolean init(ModuleContext ctx) {
		return true;
	}
 
	@Override
	public void shutdown() {
		// TODO Auto-generated method stub
 
	}
 
}

Module Messageのイベントをハンドリングする

Module Messageのイベントハンドリング機能を追加するしたものが下記です。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

package com.asmple.server.union.module.room;
 
import java.util.Map;
 
import net.user1.union.api.Message;
import net.user1.union.api.Module;
import net.user1.union.core.context.ModuleContext;
import net.user1.union.core.event.RoomEvent;
 
public class TwitModuleSample implements Module {
 
	@Override
	public boolean init(ModuleContext ctx) {
		// Room Module Messageを受信した際のイベントを監視
		ctx.getRoom().addEventListener(RoomEvent.MODULE_MESSAGE, this, "onModuleMessage");
		return true;
	}
 
	/**
	 * Module Message受信時に実行されるメソッド
	 * @param evt
	 */
	public void onModuleMessage(RoomEvent evt) {
		Message message = evt.getMessage();
		Map<String, String> params = message.getArgs();
 
		// Module Message名を確認
		if (message.getMessageName().equals("twit")) {
			// 引数オブジェクトからtextプロパティを取得する
			String text = (String)params.get("text");
		}
	}
 
	@Override
	public void shutdown() {
		// TODO Auto-generated method stub
 
	}
 
}

Module Messageイベントを監視

リスナー登録はこのように行います。AS3と似た構文で記述可能です。

15

		ctx.getRoom().addEventListener(RoomEvent.MODULE_MESSAGE, this, "onModuleMessage");

onModuleMessageハンドラ

ハンドラ内でメッセージの名前を確認し、引数のオブジェクトを取得します。これらの値を使ってtwitterと連携すれば良さそうですね。

23
24
25
26
27
28
29
30
31
32

	public void onModuleMessage(RoomEvent evt) {
		Message message = evt.getMessage();
		Map<String, String> params = message.getArgs();
 
		// Module Message名を確認
		if (message.getMessageName().equals("twit")) {
			// 引数オブジェクトからtextプロパティを取得する
			String text = (String)params.get("text");
		}
	}

Twitterに投稿する機能を追加する準備

twitterのアカウントをお持ちでない方は、twitterアカウントのidとpasswordを用意してください。

twitter4jの導入

Twitter4Jからtwitter4j-2.0.9.zipをダウンロードしてきます。

アーカイブを解凍したら、twitter4j-2.0.9.jarをUnion Serverをインストールしたディレクトリのlib配下へコピーします。

eclipseのライブラリパスを設定

1. Package Explorerでunion_platform(プロジェクト名)からコンテキストメニューを表示します。
2. Propertiesを選択します。
3. JAVA Build PathからLibrariesタブを選択します。
4. Add JARsボタンをクリックします。
5. 先ほど追加したlib/twitter4j-2.0.9.jarを選択します。

startup.bat(.sh)の編集

前回のstartup.bat(.sh)に追記していきます。前回の記事をお読みでない方は、Union Platform(7) Union Server Module作成準備を参照して下さい。

Windows環境の場合はstartup.batを編集します。

java -cp lib\union.jar;lib\stax-api-1.0.1.jar;lib\wstx-asl-3.2.6.jar;lib\com-asmple-server-union-module.jar net.user1.union.core.UnionMain start

;lib\com-asmple-server-union-module.jarの後ろに以下を追記します。

;lib\twitter4j-2.0.9.jar

変更後は以下のようになります。

java -cp lib\union.jar;lib\stax-api-1.0.1.jar;lib\wstx-asl-3.2.6.jar;lib\com-asmple-server-union-module.jar;lib\twitter4j-2.0.9.jar net.user1.union.core.UnionMain start

Mac OS X, Linux環境の場合はstartup.shを編集します。

#!/bin/sh
java -cp lib/union.jar:lib/stax-api-1.0.1.jar:lib/wstx-asl-3.2.6.jar:lib/com-asmple-server-union-module.jar net.user1.union.core.UnionMain start &

lib/com-asmple-server-union-module.jarの後ろに以下を追記します。

:lib/twitter4j-2.0.9.jar

変更後は以下のようになります。

#!/bin/sh
java -cp lib/union.jar:lib/stax-api-1.0.1.jar:lib/wstx-asl-3.2.6.jar:lib/com-asmple-server-union-module.jar:lib/twitter4j-2.0.9.jar net.user1.union.core.UnionMain start &

Twitter4Jを組み込む

実際にTwitter4Jを組み込んだものが以下のコードです。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

package com.asmple.server.union.module.room;
 
import java.net.URLDecoder;
import java.util.Map;
 
import twitter4j.Status;
import twitter4j.Twitter;
 
import net.user1.union.api.Message;
import net.user1.union.api.Module;
import net.user1.union.core.context.ModuleContext;
import net.user1.union.core.event.RoomEvent;
 
public class TwitModuleSample implements Module {
	private Twitter twitter;
 
	// twitterのidを設定
	private static final String TWITTER_ID = "your twitter id";
 
	// twitterのpassowrdを設定
	private static final String TWITTER_PW = "your twitter password";
 
	@Override
	public boolean init(ModuleContext ctx) {
		// Room Module Messageを受信した際のイベントを監視
		ctx.getRoom().addEventListener(RoomEvent.MODULE_MESSAGE, this, "onModuleMessage");
 
		// twitter用インスタンスの生成
		twitter = new Twitter(TWITTER_ID, TWITTER_PW);
		return true;
	}
 
	/**
	 * Module Message受信時に実行されるメソッド
	 * @param evt
	 */
	public void onModuleMessage(RoomEvent evt) {
		Message message = evt.getMessage();
		Map<String, String> params = message.getArgs();
 
		// Module Message名を確認
		if (message.getMessageName().equals("twit")) {
			// 引数オブジェクトからtextプロパティを取得する
			String text = (String)params.get("text");
			text = URLDecoder.decode(text);
 
			// twitterへ書き込みをする
			try {
				Status status = twitter.update(text + " #union");
				evt.getRoom().sendMessage(
					"response", "ok", 
					"http://twitter.com/" 
					+ TWITTER_ID + "/status/" + status.getId());
			} catch (Exception e) {
				evt.getRoom().sendMessage(
					"response", "ng", "can't twit " + TWITTER_ID);
			}
		}
	}
 
	@Override
	public void shutdown() {
		// TODO Auto-generated method stub
 
	}
 
}

Room Moduleをdeployする

前回と同じようにAntツールを使ってdeployします。deploy後は、stopserver.bat(.sh)、startserver.bat(.sh)を実行してUnion Serverを再起動しておきましょう。

簡単なClientを作ってみる

下記サンプルが動作するためには、localhostに先ほどのRoom Moduleを定義したUnion Serverが起動している必要があります。

twitボタンをクリックすると、先ほど設定したtwitterアカウントで入力したメッセージを呟きます。

Room Moduleの指定

２つの方法があります。

Reactorで指定する方法

Reactorで指定することで、任意のRoomに任意のRoom Moduleを割り当てることが可能となります。
具体的には以下のように、RoomModulesインスタンスを生成して、割り当てたいRoom Moduleのクラスを指定します。

135
136
137
138
139
140
141
142
143
144

			// Room モジュールを指定します。
            var modules:RoomModules = new RoomModules();
            modules.addModule(
                "com.asmple.server.union.module.room.TwitModuleSample",
                RoomModuleType.CLASS);
 
			// Room モジュールを指定しながらRoomを生成します。
			_room = _reactor.getRoomManager().createRoom(
                "twitRoom", null, null, modules
             );

Union Serverのunion.xmlで指定する方法

Room Moduleを割り当てたいRoomが固定の場合、Union Serverのunion.xmlで指定すると良いです。今回のRoom ModuleをtwitRoomに割り当てる場合にはunion.xmlに以下のようなセクションを追加します。この例では、twitRoomというRoom IDのRoomにcom.asmple.server.union.module.room.TwitModuleSampleというRoom Moduleが割り当てられます。

    <rooms>
    	<room>
    		<id>twitRoom</id>
    		<modules>
    			<module>
    				<source type="class">
    					com.asmple.server.union.module.room.TwitModuleSample
    				</source>
    			</module>
    		</modules>
    	</room>
    </rooms>

まとめ

今回は、Module Messageに注目してRoom Moduleを作成してみました。Server側のイベント発生のタイミングで他にも色々なModuleを作成する事が出来ます。Union ServerのModuleを作成すると、よりリッチなマルチユーザアプリケーションを作成する事が出来ます。

今後も、バージョンが更新されるたびに、Union Platformの調査を続けて行きたいと思います。これからもUnionのバージョンアップが楽しみです。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

Union ServerはJAVA言語で記述されているため、Server Module、Room ModuleともにJAVA言語で作成します。JAVA言語での開発にはeclipseを使うと便利です。

eclipeを使ったModule作成の準備

eclipseを使ってModuleを作成する際の準備方法を簡単に紹介します。

eclipseのインストール

eclipseを未だインストールしていない場合は、elipseの公式サイトからアーカイブをダウンロードしインストールします。ダウンロードして来たeclipse-SDK-3.5-win32.zipを解凍しお好きな場所へ配置します。

今回はWindowsにインストールする例ですが、Mac OS Xでもほとんど同じです。
以下のように配置しました。これらのパスはご自身の環境に合わせて読み替えて頂ければと思います。

• e:\eclipse
• e:\workspace
• e:\union

プロジェクトの作成

1. [File] -> [new] -> [Java Project]を選択します。
2. Project nameはお好きな名前で良いですが、今回はunion_platform等と入力します。
3. ContentsはCreate project from existing sourceを選択します。
4. Directory: に e:¥union と入力します。これはunion serverのディレクトリを指定して下さい。
5. [Next]をクリックします。
6. [Finish]をクリックします。

これでUnion ServerのModuleを作成するProjectが作成出来ました。

Source Folderの作成

.javaファイルを格納するSource Folderを作成します。

1. Package Explorerでunion_platform(プロジェクト名)からコンテキストメニューを表示します。
2. [New] -> [Source Folder]を選択します。
3. Folder name: に src と入力します。
4. [Finish]をクリックします。

e:¥union¥srcが作成されていれば成功です。ソース格納場所が出来上がりました。次はここにクラスを作成して行きます。

Classの作成

1. Package Explorerでunion_platform(プロジェクト名)からコンテキストメニューを表示します。
2. [New] -> [Class]を選択します。
3. Package:に作成したいパッケージ名を入力します。今回は、com.asmple.server.union.module.serverとしました。
4. Name:にPackageに所属させるクラス名を入力します。今回は、ServerModuleSampleとしました。
5. Interfaces:の横の[Add]をクリックします。
6. Choose interfaces: に Moduleと入力します。
7. Matching intems: に Module – net.user1.union.api と表示されるので、選択して[OK]をクリックします。
8. [Finish]をクリックします。

e:¥union¥src¥com¥asmple¥server¥union¥module¥server¥ServerModuleSample.javaが作成されていれば成功です。

ServerModuleSampleの編集

さて、以下のようなjavaファイルが自動で生成されますが、L:11のreturnをtrueに変更します。ここでtrueをreturnしておかないとModuleの初期化に失敗してしまいますので注意しましょう。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

package com.asmple.server.union.module.server;
 
import net.user1.union.api.Module;
import net.user1.union.core.context.ModuleContext;
 
public class ServerModuleSample implements Module {
 
	@Override
	public boolean init(ModuleContext arg0) {
		// TODO Auto-generated method stub
		return false;
	}
 
	@Override
	public void shutdown() {
		// TODO Auto-generated method stub
 
	}
 
}

L:11を以下のように変更。

11

		return true;

build.xmlの作成

antツールを使って、jarファイルを作成する準備をします。モジュールをいくつも作成した際に、jarにまとめてしまおうという考えです。以下のようなe:¥union¥build.xmを作成します。

1
2
3
4
5
6

<?xml version="1.0" encoding="Shift_JIS"?>
<project name="com_asmple_union_server_module" default="jar" basedir="." >
	<target name="jar">
		<jar basedir="./bin" jarfile="lib/com-asmple-server-union-module.jar" />
	</target>
</project>

antに登録

1. [Window] -> [Show View] -> Antを選択します。
2. Ant Viewの左のボタン(Add Buildfiles)をクリックします。
3. union_platform(プロジェクト名)配下のbuild.xml(先ほど作成したもの)を選択します。
4. Ant Viewに新しいBuildファイルが追加されます。
5. com_asmple_union_server_moduleを選択して、右から３番目の矢印アイコン(Run)をクリックします。

e:¥union¥lib¥com-asmple-server-union-module.jar が出来上がっていれば成功。これでClassファイルを更新した際には、AntのRunを実行することで、jarファイルを更新できます。

startup.bat(.sh)の編集

Windows環境の場合はstartup.batを編集します。

java -cp lib\union.jar;lib\stax-api-1.0.1.jar;lib\wstx-asl-3.2.6.jar net.user1.union.core.UnionMain start

lib\wstx-asl-3.2.6.jarの後ろに以下を追記します。

;lib\com-asmple-server-union-module.jar

Mac OS X, Linux環境の場合はstartup.shを編集します。

#!/bin/sh
java -cp lib/union.jar:lib/stax-api-1.0.1.jar:lib/wstx-asl-3.2.6.jar net.user1.union.core.UnionMain start &

lib/wstx-asl-3.2.6.jarの後ろに以下を追記します。

:lib/com-asmple-server-union-module.jar

union.xmlの編集

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<union>
    <server>
        <admin>
            <port>9110</port>
    	    <password>password</password>
        </admin>
        <client_timeout>30</client_timeout>
    </server>
    <gateways>
	    <gateway id="IOGateway" type="flash:io">
	    	<port>9100</port>
            <policy_file>policy.xml</policy_file>
	    </gateway>  
        <gateway id="NIOGateway" type="flash:nio">
            <port>9101</port>
            <policy_file>policy.xml</policy_file>
        </gateway>         	    
    </gateways>
    <modules>
        <module>
            <id>serverStatsServerModule</id>
            <source type="class">net.user1.union.servermodule.ServerStatsServerModule</source>
            <attributes>
                <attribute name="interval">300</attribute>
            </attributes>
        </module>   
    </modules>
</union>

L:26の下に以下を追加

        <module>
            <id>serverModuleSample</id>
            <source type="class">com.asmple.server.union.module.server.ServerModuleSample</source>
        </module>

Union Server起動

startup.bat(.sh)を実行して下記のようなログが出力されれば、新しいServer Moduleのロードは成功です。

2009-09-05 16:22:52,046 INFO  - Loaded module type [class] with code [com.asmple.server.union.module.server.ServerModuleSample]
2009-09-05 16:22:52,046 WARN  - Server module [serverModuleSample] loaded.

まとめ

今回はeclipseを使って、Union ServerのModuleを作成する準備をしてきました。私自身普段はeclipseもJAVAも触らないのですが、大分効率化出来そうですね。もっと良い方法などありましたら、是非ともご教授下さい。

では、次回は実際にModuleを作成してみようと思います。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

Union Serverはtryunion.comを利用して試すことが出来ますが、ローカルにもUnion Serverをインストールすることで快適な開発環境を整備しましょう。

システム要件

System Requirementsに記載されています。JAVAの実行環境があれば、大抵は動くと思います。

Union Serverのインストール

Union ServerはJAVAの実行環境があれば、実行出来ます。Windows、Mac OS X、各種Linuxへインストールが可能です。

Union Serverを実際にインストールして、管理ツールから接続を確認してみましょう。

• Union Serverをダウンロードする
• Admin接続用swfクライアントUnionAdmin.swfをダウンロードする
• ダウンロードしたUnion Serverのアーカイブを解凍する
• 解凍したフォルダにある、startserver.bat(startserver.sh)を実行する
• UnionAdmin.swfを実行する
• 接続先は、localhostとし、パスワードはpasswordで管理ツールが起動する
• UnionAdmin.swfからUnion Serverを停止することも出来る

Windows上での上記操作をキャプチャしてみました。あっという間にUnion Serverを操作出来きるようになることが分かると思います。

localhostのUnion Serverを試す

では、もう一度startserver.bat(startserver.sh)を実行して、Union Serverが起動しましょう。この状態で、Reactorから接続が可能な状態となります。

localhostへ繋ぐサンプル

起動時のログ

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

2009-09-05 12:47:31,175 WARN  - *** Starting Union Alpha 1.0.0 (build 283) ***
2009-09-05 12:47:31,175 WARN  - **********************************************
2009-09-05 12:47:31,175 WARN  - UPC Version: 1.3.0
2009-09-05 12:47:31,470 WARN  - Using CharSet [UTF-8]
2009-09-05 12:47:31,474 INFO  - ContextManager initialized.
2009-09-05 12:47:31,545 WARN  - UNION_HOME set to [/path/to/union/.]
2009-09-05 12:47:31,649 WARN  - Gateway [IOGateway] bound to port [9100] on all local IP addresses.
2009-09-05 12:47:31,650 INFO  - Gateway [IOGateway] added to the Server.
2009-09-05 12:47:31,869 WARN  - Gateway [NIOGateway] bound to port [9101] on all local IP addresses.
2009-09-05 12:47:31,869 INFO  - Gateway [NIOGateway] added to the Server.
2009-09-05 12:47:31,871 INFO  - Loaded module type [class] with code [net.user1.union.servermodule.ServerStatsServerModule]
2009-09-05 12:47:31,872 WARN  - Server module [serverStatsServerModule] loaded.
2009-09-05 12:47:31,882 WARN  - POLICY_FILE attribute missing for Gateway [_ADMIN_GATEWAY_].  Using default [policy.xml].
2009-09-05 12:47:31,882 WARN  - Gateway [_ADMIN_GATEWAY_] bound to port [9110] on all local IP addresses.
2009-09-05 12:47:31,883 INFO  - Gateway [_ADMIN_GATEWAY_] added to the Server.
2009-09-05 12:47:31,924 WARN  - Banned list file [banned.txt] not found.  Banned list not initiated.
2009-09-05 12:47:31,924 WARN  - Admin Gateway Started.
2009-09-05 12:47:31,924 INFO  - ContextManager started.
2009-09-05 12:47:31,924 WARN  - Union Alpha 1.0.0 (build 283) Started....OK
2009-09-05 12:47:31,983 WARN  - 
-----------------
SERVER STATS
-------------------------------------------------------------------------
Memory Usage [init = 0(0K) used = 11201888(10939K) committed = 83230720(81280K) max = 85393408(83392K)]
Thread Usage [9]
-------------------------------------------------------------------------

connect時のログ

1
2
3
4
5
6
7
8
9
10
11
12
13
14

2009-09-05 12:53:54,928 INFO  - Gateway [IOGateway] accepted a connection.
2009-09-05 12:53:54,981 INFO  - Gateway [IOGateway] accepted a connection.
2009-09-05 12:53:55,030 INFO  - Client [1] connected to the server. UID [0:0:0:0:0:0:0:1%0]
2009-09-05 12:53:55,030 DEBUG - Server received from client [1] message [<U><M>u65</M><L><A>Reactor</A><A>Flash Player WIN 10,0,32,18 PlugIn (debug, remote); 1.0.0 (Build 247)</A><A>1.3.0</A></L></U>]
2009-09-05 12:53:55,049 DEBUG - Server sending to client [1] message [<U><M>u66</M><L><A>Union Alpha 1.0.0 (build 283)</A><A></A><A>1.3.0</A><A>true</A></L></U>]
2009-09-05 12:53:55,049 DEBUG - Server sending to client [1] message [<U><M>u29</M><L><A>1</A></L></U>]
2009-09-05 12:53:55,096 DEBUG - Server sending to client [1] message [<U><M>u8</M><L><A><![CDATA[]]></A><A>1</A><A><![CDATA[_CT]]></A><A><![CDATA[1252122835050]]></A><A>SUCCESS</A></L></U>]
2009-09-05 12:53:55,096 DEBUG - Server sending to client [1] message [<U><M>u8</M><L><A><![CDATA[]]></A><A>1</A><A><![CDATA[_IP]]></A><A><![CDATA[0:0:0:0:0:0:0:1%0]]></A><A>SUCCESS</A></L></U>]
2009-09-05 12:53:55,097 DEBUG - Server sending to client [1] message [<U><M>u63</M><L></L></U>]
2009-09-05 12:53:55,120 DEBUG - Server received from client [1] message [<U><M>u24</M><L><A><![CDATA[test]]></A><A><![CDATA[_DIE_ON_EMPTY|true|_MAX_CLIENTS|-1|_PASSWORD||_CLIENT_TIMEOUT|-1]]></A><A></A><A></A></L></U>]
2009-09-05 12:53:55,141 DEBUG - Room [test] initialized.
2009-09-05 12:53:55,142 DEBUG - Room [test] started.
2009-09-05 12:53:55,142 INFO  - Room [test] initialized and started.
2009-09-05 12:53:55,142 DEBUG - Server sending to client [1] message [<U><M>u32</M><L><A><![CDATA[test]]></A><A>SUCCESS</A></L></U>]

wonderflの投稿で試す

wonderflのunionタグのついた投稿を探して、forkしてみましょう。そして、Union Serverのホストをtryunion.comからlocalhostに変更します。すると、ローカルのUnion Serverへ接続するログが出力される事が確認出来ます。

もちろん、Union ServerのURLをlocalhostとした作品は自身のPCからしか正常に動作しないので注意して下さい。

設定の確認

Union Serverの設定はXMLファイルで行います。

policy.xml

Union ServerはFlash PlayerのSocket接続機能を利用します。Flash PlayerからSocket接続を行うためには、ソケット接続のポリシーファイルを用意する必要がありますので、Union Serverはソケット接続のポリシーファイルを自動で配布するようになっています。

policy.xmlではUnion Serverで利用するソケット接続のポリシーを設定します。

以下の例では、すべてのドメインに配置してあるswfからの接続を許可します。外部に公開するサーバでは必ず適切な設定に変更しましょう。特に管理用ポートからのアクセスは塞ぐと良いです。

1
2
3

<cross-domain-policy>
<allow-access-from domain="*" to-ports="9100,9101,9110" />
</cross-domain-policy>

union.xml

Union Serverの動作を設定するファイルです。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<union>
    <server>
        <admin>
            <port>9110</port>
    	    <password>password</password>
        </admin>
        <client_timeout>30</client_timeout>
    </server>
    <gateways>
	    <gateway id="IOGateway" type="flash:io">
	    	<port>9100</port>
            <policy_file>policy.xml</policy_file>
	    </gateway>  
        <gateway id="NIOGateway" type="flash:nio">
            <port>9101</port>
            <policy_file>policy.xml</policy_file>
        </gateway>         	    
    </gateways>
    <modules>
        <module>
            <id>serverStatsServerModule</id>
            <source type="class">net.user1.union.servermodule.ServerStatsServerModule</source>
            <attributes>
                <attribute name="interval">300</attribute>
            </attributes>
        </module>   
    </modules>
</union>

最低限、管理用のパスワードは変更しておきましょう。その他モジュールの設定などを行うことができます。

管理用パスワード変更時の注意点

stopserver.bat(.sh)には、管理用のパスワードを記述する必要があります。

Windows環境の場合

stopserver.batを編集します。SET PASSWORDの値を変更します。管理用サーバのportを変更した際にはSET PORTの値を変更します。

SET HOST=localhost
SET PORT=9110
SET PASSWORD=yourpassword
java -cp lib\union.jar;lib\mariner.jar net.user1.union.core.UnionMain %HOST% %PORT% %PASSWORD% a5

Mac OS X, Linux環境の場合

stopserver.shを編集します。PASSWORDの値を変更します。管理用サーバのportを変更した際にはPORTの値を変更します。

#!/bin/sh
HOST=localhost
PORT=9110
PASSWORD=password
java -cp lib/union.jar:lib/mariner.jar net.user1.union.core.UnionMain $HOST $PORT $PASSWORD a5

その他の設定

Configurationに詳しく記載されています。

ポートの確認

前述のとおり、Union Serverではソケット接続を行うので、ソケット接続のポリシーファイルを配布します。Flash Playerはソケット接続のポリシーファイルの取得時、ソケット接続先のサーバの843ポートに接続します。(このポートは変更することも可能)

また、union.xmlに指定したようにUnion Serverはデフォルトで9100ポートを使用します。

よって、Union Serverを外部に公開するような際には、ソケット接続のポリシーファイル配布用のポート(デフォルトで843)と、Union ServerのGatewayのポート(デフォルトで9100)のポートを開けておくのを忘れないようにしましょう。すでに843ポートで別のポリシーファイルを配布しているサーバでは、Union Serverのpolicy.xmlを設定してもその設定が反映されずに、動作しないということがあるので気をつけましょう。

Module

Moduleを使う事でUnion Serverの機能を拡張する事が出来ます。具体的には、サーバ側の各種イベント送出時のハンドラを登録することで、独自の挙動を追加出来ます。

また、Union Serverからの送信するMessage機能を使ってチャットボットのような機能を作成することも可能となります。

Server Module

Server Moduleはサーバ全体に影響を及ぼすモジュールです。

Room Module

Room Moduleは特定のRoomに影響を及ぼすモジュールです。

まとめ

さて、Union Serverをローカルにインストールする事でUnion Platformを使ったアプリケーション開発をローカルで行う事が出来るようになりました。

次回は、eclipseをインストールして、公式サイトのサンプルにあるようなモジュールを動かすまでの手順を紹介します。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

• observeとjoinの違いを確認
• Client Attributeの使い方を確認
• Messageの使い方を確認
• 各種基本的なイベント処理を確認

実際に動作するサンプルはwonderflに投稿してあります。

機能

このswfファイルを閲覧する人をユーザと呼びます。ユーザは以下のようなことが出来ます。

• ユーザは、observeボタンをクリックすることでRoom ID: com.asmple.union.chatへobserveすることが出来ます。
• ユーザは、joinボタンをクリックすることでRoom ID: com.asmple.union.chatへjoinすることが出来ます。
• ユーザは、色コードを入力し、Update Attributeボタンをクリックすることで、Client Attributeを通じてアバター・発言の色を変更することが出来ます。
• ユーザは、ニックネームを入力し、Update Attributeボタンをクリックスすることで、Client Attributeを通じて発言時のニックネームを変更することが出来ます。
• ユーザは、Roomにjoinした状態であれば以下の操作が可能です。
  • ユーザは、メッセージ入力欄にメッセージを入力し、エンターキーを押すことで、Messageを通じて発言することが出来ます。
  • ユーザは、アバターフィールド内をクリックすることで自身のアバターの位置をClient Attributeを通じて変更することが出来ます。

observeとjoin

observeとjoinの概念的な説明は、UnionPlatform (2) 概念にて解説しております。

observeとjoinの違いを体験

今回は実際にobserveとjoinの違いを体験できます。

以下のswfは上のものとまったく同じものです。先ほどのswfと下記swf両方を再生し、先ほどのswfでjoinボタンをクリックしてから画面内のアバターを移動してみましょう。

このとき、下記のswfでは何も見えないはずです。まだRoomにobserveもjoinもしていないからです。

次に、下記swfでobserveボタンをクリックすると、画面内にアバターが表示されます。(同時に本エントリーを閲覧している人がいたら数人のアバターが表示されるかもしれません。)ただ、画面内には自分のアバターも表示されませんが、発言は出来ることが分かる思います。

Messageの送信について

なお、Union alpha3ではobserve, joinせずにまたは、observe時もMessageを送信出来ます。RoomにjoinしていないClientからのMessage送信を抑止する為には、自身でチェックコードを書く必要があります。

リリース時には権限管理の強化で挙動は変更される可能性があるそうです。(@keno42さんがcolinさんに確認してくれました。この場を借りて感謝致します。)

というわけで、observeとjoinの違いを感じていただけましたでしょうか。observeとjoinの切り替えにはUnion alpha3の時点では不都合と思われる挙動があるため、本エントリーではその点も確認していきます。

Client AttributeとMessage

Client AttributeとMessageは情報の共有化に使います。情報の共有化については、Union Platform(3) 情報の共有化にて解説しております。

Client Attributeは、今回の例ではニックネームや色となります。後から入室したユーザは最新の情報を共有することがわかります。

Messageでの共有は、今回の例では発言メッセージとなります。後から入室したユーザにはそれ以降の情報しか共有されないことが分かります。

Client Attribute

各クライアントが持つ属性を定義を紹介します。

アバターの情報は下記の情報を「,(カンマ)」区切りで格納します。先の例ではx座標:100, y座標:200, 向き:up, 距離:100を表します。

• 目標点のX座標
• 目標点のY座標
• アバターが向く方向(0:up, 1:right, 2:down, 3:left)
• アバターと目標座標との距離

今回はすべてのClient Attributeのスコープをグローバルにしましたが、もしRoomを増やすことになればRoomごとにアバターの情報は異なるでしょうから、アバター情報のスコープをRoomごとに持つように変更しましょう。

ユーザーインターフェース

ユーザーインターフェースのUnionChatUIクラス定義は、L:675以降にあります。
UnionChatUIクラスは以下の図内に示した各パーツに対応したpublicプロパティを持っています。

チャットサンプルのUI

メソッドは以下のものを用意しました。

アバター

アバターは、以下のswfを使用しています。

以下のプロパティとメソッドを備えます。

サンプルコードの解説

Union Serverへの接続

コンストラクタから呼ぶconnectメソッドをみてみましょう。

154
155
156
157
158
159
160
161
162
163

		/**
		 * UnionServerへ接続します。
		 */
		private function connect():void
		{
			_reactor = new Reactor(null, false);
			_reactor.addEventListener(ReactorEvent.READY, _reactor_readyHandler);
			_reactor.addEventListener(ReactorEvent.CLOSE, _reactor_closeHandler);
			_reactor.connect(UNION_SERVER_HOST, UNION_SERVER_PORT);
		}

Reactorをnewする際の引数は、1つ目が設定ファイルのxmlの場所。2つ目がデバッグ用のログの出力設定フラグとなります。2つ目の引数をtrueとしておくと、Flash Debug Playerで再生した際に、ログを確認することが出来ます。

設定ファイルの例

今回は使用しませんが以下のようなxmlを用意してあげることで自動的にconnectすることが可能です。

1
2
3
4
5
6

<?xml version="1.0"?>
<config>
  <server>tryunion.com</server>
  <ports>9100</ports>
  <logLevel>DEBUG</logLevel>
</config>

Union Serverへの接続完了

Union Serverへ接続が完了したことを知るには、ReactorEvent.READYイベントの送出を待ちます。先ほど指定したハンドラの中身をみてみましょう。

485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520

		private function _reactor_readyHandler(event:ReactorEvent):void
		{
			_ui.currentStatusLabel.text = "connect";
			_ui.appendMessage("ReadyEvent.READY");
 
			// 自身のClient参照を取得
			_self = _reactor.getClientManager().self();
			_self.setAttribute("nickname", _clientData.nickname);
			_self.setAttribute("color", _clientData.color);
			_self.setAttribute("avatar", _clientData.avatar);
 
			// 自身のnicknameを設定
			_ui.nicknameField.text = _clientData.nickname;
 
			// 自身のcolorを設定
			_ui.colorChooser.value = _clientData.color;
 
			// RoomManager参照を取得
			_roomManager = _reactor.getRoomManager();
 
			_roomManager.addEventListener(
				RoomManagerEvent.CREATE_ROOM_RESULTS,
				_roomManager_createRoomReslutsHandler);
 
			// Roomへの接続が0となっても残す設定
			var roomSetting:RoomSettings = new RoomSettings();
			roomSetting.dieOnEmpty = false;
 
			// 指定したRoom IDを作成する。
			_room = _roomManager.createRoom(ROOM_CHAT, roomSetting);
			addRoomEventListeners();
 
			// logger参照を取得
			_logger = _reactor.getLog();
			_logger.addEventListener(LogEvent.UPDATE, _logger_updateHandler);
		}

Client Attributeの初期化

ReactorEvent.READYイベントが送出された後に、L:491にて自身のClientオブジェクトを取得しています。グロバールスコープのClient Attributeはこのタイミングで代入しておくと良いでしょう。

Room作成チェック

L:503にて、RoomManagerインスタンスを取得し、Room作成時のイベントの送出を待ちます。L:514でRoomインスタンスを生成していますが、このRoomインスタンス生成時にUnion Server側でもRoom生成が正常に行われたかをチェックする為に使います。

RoomSettingでRoomの自動削除を防ぐ

デフォルトではRoomに接続しているClientがいなくなった時点でRoomは破棄されてしまいます。これを防ぐために、L:510でRoomSettingインスタンスを生成し、dieOnEmptyプロパティにfalseを代入します。このRoomSettingインスタンスをRoomManagerインスタンスのcreateRoomメソッドの第二引数に指定するこたおでRoom内にClientが居ない状態でもRoomを残しておくことが可能です。

RoomEventのリスナー登録

L:520でaddRoomEventListeners()メソッドを実行することで、RoomEventの各イベントを監視します。このイベント監視によって、ReactorとUnion Serverとの情報共有を行います。詳しくは、後ほどみます。

Room作成完了

Roomの作成完了を知るには、RoomManagerEvent.CREATE_ROOM_RESULTSイベントの送出を待ちます。先ほど指定したハンドラをみていきましょう。

541
542
543
544
545
546
547
548
549
550
551
552
553

		private function _roomManager_createRoomReslutsHandler(
				event:RoomManagerEvent):void
		{
			var status:String = event.getStatus();
			_ui.appendMessage("RoomManagerEvent.CREATE_ROOM_RESULTS:" + status);
			if (event.getStatus() == Status.SUCCESS
				|| event.getStatus() == Status.ROOM_EXISTS) 
			{
				if (_attempt == "observe") _room.observe();
				else if (_attempt == "join") _room.join();
				else activate();
			}
		}

作成の結果はevent.getStaus()の値を確認します。下記のいずれかの値をとります。

• Status.SUCCESS
• Status.ROOM_EXIST
• Status.ERROR

作成に成功した場合は、Status.SUCCESSとなります。今回の場合は、Roomの自動削除を無効としているので、Status.ROOM_EXISTとなる状況が多いと思います。いずれもroomへの接続が可能な状態を示します。

初回は、_attemptの値は空文字なので

119
120
121
122

		/**
		 * join or observe
		 */
		private var _attempt:String = "";

次に実行されるのは、activate()メソッドです。_attemptの値がobseverの場合は、_room.observe()メソッドの実行、_attemptの値がjoinの場合は、_room.join()メソッドの実行となることを心に留めておきましょう。

なぜこのような作りとしているかは後ほど説明します。

activate()メソッドでユーザーインターフェースの活性化

activate()メソッドを実行する段階では、Union Serverとの接続が確立されてユーザのイベントを待つ状態となります。

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

		private function activate():void
		{
			_ui.stopLoading();
 
			// observeボタンの動作を登録します。
			_ui.observeButton.addEventListener(MouseEvent.CLICK,
				 _ui_observeButton_clickHandler);
 
			// joinボタンの動作を登録します。
			_ui.joinButton.addEventListener(MouseEvent.CLICK,
				 _ui_joinButton_clickHandler);
 
			// updateボタンの動作を登録します。
			_ui.updateButton.addEventListener(MouseEvent.CLICK,
				 _ui_updateButton_clickHandler);
 
			// メッセージ入力時の動作を登録します。
			_ui.messageField.addEventListener(TextEvent.TEXT_INPUT,
				_ui_messageField_textInputHandler);
			_ui.messageField.addEventListener(KeyboardEvent.KEY_UP,
				_ui_messageField_keyUpHandler);
 
			// アバターフィールドクリック時の動作を登録します。
			_ui.avatarField.addEventListener(MouseEvent.CLICK,
				_ui_avatarField_clickHandler);
		}

先ほど確認したユーザーインターフェースの各プロパティにマウスイベントやテキスト入力時のイベントを設定しています。

observeボタンの動作

L:384で、ReadyEvent.READYイベントのハンドラで登録した、RoomEventのリスナーを解除します。L:381で_attemptにobserveを代入してから、connectメソッドを実行します。

376
377
378
379
380
381
382
383
384

		private function _ui_observeButton_clickHandler(event:MouseEvent):void
		{
			_ui.playLoading();
			removeRoomEventListeners();
			deactivate();
			_attempt = "observe";
			_reactor.disconnect();
			connect();
		}

これは、先ほど見たとおり、_roomManager_createRoomReslutsHandler内で、下記のように_room.observe()を実行することになります。

549
550
551

				if (_attempt == "observe") _room.observe();
				else if (_attempt == "join") _room.join();
				else activate();

joinボタンの動作

observeとの違いは、_attemptにjoinを代入する点です。このような処理は、本来ならば１つの関数にまとめたほうが良いかも知れません。

390
391
392
393
394
395
396
397
398

		private function _ui_joinButton_clickHandler(event:MouseEvent):void
		{
			_ui.playLoading();
			removeRoomEventListeners();
			deactivate();
			_attempt = "join";
			_reactor.disconnect();
			connect();
		}

何度も見てきたように、_roomManager_createRoomReslutsHandler内で、下記のように_room.join()を実行することになります。

549
550
551

				if (_attempt == "observe") _room.observe();
				else if (_attempt == "join") _room.join();
				else activate();

つまり、observe、joinするたびにReactorとUnion Serverの接続を繋ぎなおしています。

Union Serverの接続を繋ぎなおす理由

Union alpha3では、一度observeしたRoomに対してjoinしたり、いったんstopObservingしてからjoin。もしくはその逆を行うと、RoomEventが正常にdispatchされないなど動作が不安定となるようです。

そのため、observeとjoinの切り替え時にコネクションを張りなおす処理を行っています。

updateボタンの動作

ClientのAttributeを更新する処理です。L:413, L:414で自身のClientインスタンスのsetAttribute()メソッドを呼び出します。

404
405
406
407
408
409
410
411
412
413
414
415

		private function _ui_updateButton_clickHandler(event:MouseEvent):void
		{
			var nickname:String = _ui.nicknameField.text;
			var color:uint = _ui.colorChooser.value;
			if (nickname.length == 0)
			{
				_ui.appendMessage("ニックネームは空に出来ません", 0xFF0000);
				return;
			}
			_self.setAttribute("nickname", encodeURI(nickname));
			_self.setAttribute("color", String(color));
		}

メッセージ入力時の動作

TextFieldで入力した文字をエンターキーで抽出します。KeyboardEvent.KEY_UPのハンドラ内で、Keyboard.ENTER判定をするだけだと、日本語入力の変換時のエンターキー入力を拾ってしまい、入力途中で文章が抽出されてしまいます。
そこで、文字入力中かどうかを判定するためにTextEvent.TEXT_INPUTのハンドラを活用します。

421
422
423
424

		private function _ui_messageField_textInputHandler(event:TextEvent):void
		{
			_isInputText = true;
		}

L:441でRoomインスタンスのsetMessage()メソッドを使ってchatMessageというMessageを送信しています。

430
431
432
433
434
435
436
437
438
439
440

		private function _ui_messageField_keyUpHandler(event:KeyboardEvent):void
		{
			if (_ui.messageField.text.length == 0) return;
			if (!_isInputText && event.keyCode == Keyboard.ENTER)
			{
				var message:String = encodeURI(_ui.messageField.text);
				_room.sendMessage("chatMessage", true, null, message);
				_ui.messageField.text = "";
			}
			_isInputText = false;
		}

アバターフィールドクリック時の動作

クリックされた場所とアバターの位置関係と距離計算して、アバターが向くべき方向を決定します。L:475で自身のClientインスタンスのsetAttribute()メソッドを呼び出します。これらの値は同時にAttributeの更新イベントを通知して欲しいので１つのAttributeにカンマ区切りで代入しています。

446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

		private function _ui_avatarField_clickHandler(event:MouseEvent):void
		{
			// 入室していなければ何もしない。
			if (!_self.isInRoom(ROOM_CHAT)) return;
 
			var avatar:* = _avatars[_self.getClientID()];
			var direction:uint;
			var distanceX:Number = event.localX - avatar.x;
			var distanceY:Number = event.localY - avatar.y;
			var distance:Number = Math.sqrt(
				distanceX * distanceX + distanceY * distanceY
			);
			// 小数点を切り捨てる
			distance = int(distance);
 
			// アバターが向く方向を決定
			if (Math.abs(distanceX) <= Math.abs(distanceY))
			{
				if (distanceY < 0) direction = DIRECTION_UP;
				else direction = DIRECTION_DOWN;
			}
			else
			{
				if (distanceX < 0) direction = DIRECTION_LEFT;
				else direction = DIRECTION_RIGHT;
			}
 
			// Client Attributeを更新する。
			var values:Array = [event.localX-16, event.localY-16, direction, distance];
			_self.setAttribute("avatar", values.join(","));
		}

addRoomEventListeners

joinボタン、observeボタンをクリックした後、ReactorEvent.READYイベントが送出された段階で呼び出される_reactor_readyHandler内で実行しているメソッドです。

RoomEventの各イベントをリスナー登録します。ReactorとUnion Serverとをつなぐ要とも言える処理です。

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

		private function addRoomEventListeners():void
		{
			_room.addEventListener(RoomEvent.OBSERVE, _room_observeHandler);
			_room.addEventListener(RoomEvent.JOIN, _room_joinHandler);
			_room.addEventListener(RoomEvent.CLIENT_COUNT
				, _room_clientCountHandler);
			_room.addEventListener(RoomEvent.SYNCHRONIZE
				, _room_synchronizeHandler);
			_room.addEventListener(RoomEvent.ADD_CLIENT
				, _room_addClientHandler);
			_room.addEventListener(RoomEvent.REMOVE_CLIENT
				, _room_removeClientHandler);
			_room.addEventListener(RoomEvent.UPDATE_CLIENT_ATTRIBUTE
				, _room_updateClientAttributeHandler);
			_room.addMessageListener("chatMessage", chatMessageHandler);
		}

各イベントと登録されたハンドラ内の処理をみていきます。

RoomEvent.OBSERVEとそのハンドラ

RoomEvent.OBSERVEはRoomインスタンスのobserveが完了すると、Roomインスタンスから送出されるイベントです。

activate()メソッドでユーザーインターフェースの活性化を行います。詳細は前述の通りです。

569
570
571
572
573
574
575

		private function _room_observeHandler(event:RoomEvent):void
		{
			_ui.currentStatusLabel.text = "observe";
			_ui.appendMessage("RoomEvent.OBSERVER");
			_ui.stopLoading();
			activate();
		}

RoomEvent.JOINとそのハンドラ

RoomEvent.JOINはRoomインスタンスのjoinが完了すると、Roomインスタンスから送出されるイベントです。

activate()メソッドでユーザーインターフェースの活性化を行います。詳細は前述の通りです。

580
581
582
583
584
585
586

		private function _room_joinHandler(event:RoomEvent):void
		{
			_ui.currentStatusLabel.text = "join";
			_ui.appendMessage("RoomEvent.JOIN");
			_ui.stopLoading();
			activate();
		}

RoomEvent.CLIENT_COUNTとそのハンドラ

RoomEvent.CLIENT_COUNTはRoomにjoinしているClient数が変化すると、Roomインスタンスから送出されるイベントです。

RoomEventインスタンスのgetNumClients()メソッドで人数を取得します。

592
593
594
595
596

		private function _room_clientCountHandler(event:RoomEvent):void
		{
			_ui.appendMessage("RoomEvent.CLIENT_COUNT");
			_ui.currentClientsLabel.text = "occupants:" + event.getNumClients() + "人";
		}

RoomEvent.SYNCHRONIZEとそのハンドラ

RoomEvent.SYNCHRONIZEはRoomインスタンスがUnion Serverとの同期を完了すると、Roomインスタンスから送出されるイベントです。

新しくjoin, observeしたClientが現状のRoom内のClientの情報などを取得する処理を記述します。今回は、すでにRoomにjoinしているClientのアバターを描画します。

RoomインスタンスのgetClients()メソッドを通して、Room内のClientのオブジェクトを取得する点がポイントとなります。

addAvatar()メソッドは後述します。

602
603
604
605
606
607
608
609
610

		private function _room_synchronizeHandler(event:RoomEvent):void
		{
			_ui.appendMessage("RoomEvent.SYNCHRONIZE");
 
			for each (var client:IClient in _room.getClients())
			{
				addAvatar(client);
			}
		}

RoomEvent.ADD_CLIENTとそのハンドラ

RoomEvent.ADD_CLIENTはRoomインスタンスの新しいClientが追加されると、Roomインスタンスから送出されるイベントです。

現ClientがRoomにjoinまたはobserveした後にRoomにjoinしてきたClientの情報を取得します。

616
617
618
619
620

		private function _room_addClientHandler(event:RoomEvent):void
		{
			_ui.appendMessage("RoomEvent.ADD_CLIENT");
			addAvatar(event.getClient());
		}

addAvatar()メソッド

Loaderインスタンスを使って、外部のswfをロードします。ロード後の処理も一括で記述したかったので、無名関数をリスナー登録しています。

アバターのcolorメソッドにClient Attributeのcolorを代入したり、Client AttributeのavatarをAvatarに設定しています。updateAvatar()メソッドは後述します。

267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

		private function addAvatar(client:IClient):void
		{
			var loader:Loader = new Loader();
			loader.contentLoaderInfo.addEventListener(Event.INIT,
				function(event:Event):void {
					var avatar:* = loader.content;
					avatar.color = client.getAttribute(null, "color");
					var values:Array = client.getAttribute(null, "avatar").split(",");
					updateAvatar.apply(null, [avatar, false].concat(values));
 
					_avatars[client.getClientID()] = avatar;
					_ui.avatarField.addChild(avatar);
				}
			);
 
			loader.load(new URLRequest(AVATAR_URL));
		}

RoomEvent.REMOVE_CLIENTとそのハンドラ

RoomEvent.REMOVE_CLIENTはRoomインスタンスからClientが削除されると、Roomインスタンスから送出されるイベントです。

現ClientがRoomにjoinまたはobserveした後にRoomからleaveしたClientの情報を取得します。

626
627
628
629
630

		private function _room_removeClientHandler(event:RoomEvent):void
		{
			_ui.appendMessage("RoomEvent.REMOVE_CLIENT");
			removeAvatar(event.getClient());
		}

removeAvatar()メソッド

アバターフィールドから、アバターを削除します。

289
290
291
292
293
294
295

		private function removeAvatar(client:IClient):void
		{
			var avatar:* = _avatars[client.getClientID()];
			if (!_ui.avatarField.contains(avatar)) return;
			_ui.avatarField.removeChild(avatar);
			delete _avatars[client.getClientID()];
		}

RoomEvent.UPDATE_CLIENT_ATTRIBUTEとそのハンドラ

RoomEvent.UPDATE_CLIENT_ATTRIBUTEはRoom内のClientが自身のClient Attributeを更新すると、Roomインスタンスから送出されるイベントです。

Client Attributeは内部で設定される属性も存在するため、更新されたClient Attributeが意図したClient Attributeであるかを確認します。今回は、colorとavatarの更新を検知するようにしています。

実際にアプリケーションを実行すると、一定感覚でメッセージリストにRoomEvent.UPDATE_CLIENT_ATTRIBUTEが表示されますが、これは内部で更新されるClient Attributeです。_PINGという名前なので、おそらくClientの疎通確認用のClient Attributeだと思います。

636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662

		private function _room_updateClientAttributeHandler(event:RoomEvent):void
		{
			_ui.appendMessage("RoomEvent.UPDATE_CLIENT_ATTRIBUTE");
			var attribute:Attribute = event.getChangedAttr();
			_ui.appendMessage(" id:" + event.getClientID() 
				+ ", name:" + attribute.name 
				+ ", oldValue:" + attribute.oldValue
				+ ", value:" + attribute.value
			);
 
			var avatar:* = _avatars[event.getClientID()];
			if (!avatar) return;
			switch (attribute.name)
			{
				case "color":
				{
					avatar.color = uint(attribute.value);
					break;
				}
				case "avatar":
				{
					var values:Array = attribute.value.split(",");
					updateAvatar.apply(null, [avatar, true].concat(values));
					break;
				}
			}
		}

updateAvatar()メソッド

Client Attribute avatarの更新を実際のアバターに適用します。アバターの向きを指定して、目的地へアバターを移動します。移動する際のモーションは、BetweenAS3を使っています。BetweenAS3は大変直感的に使える素敵ライブラリです。

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

		private function updateAvatar(
				avatar:*,
				isTween:Boolean,
				positionX:Number, positionY:Number,
				direction:uint, distance:Number):void
		{
			avatar.play();
			switch (direction)
			{
				case DIRECTION_UP:
					avatar.back();
					break;
				case DIRECTION_RIGHT:
					avatar.right();
					break;
				case DIRECTION_DOWN:
					avatar.front();
					break;
				case DIRECTION_LEFT:
					avatar.left();
					break;
			}
 
			if (isTween)
			{
				var tween:IObjectTween = BetweenAS3.tween(
					avatar,
					{x: positionX, y: positionY },
					{x: avatar.x, y: avatar.y },
					distance * 0.005, Sine.easeOut
				);
				tween.play();
			}
			else
			{
				avatar.x = positionX;
				avatar.y = positionY;
			}
		}

chatMessageのMessageイベント

chatMessageというIDのMessageを受信した際のハンドラを指定します。受け取ったMessageをメッセージリストに追加しています。

351
352
353
354
355
356
357
358
359
360
361
362
363
364

		private function chatMessageHandler(
				fromClient:IClient, message:String):void
		{
			var nickname:String = decodeURI(
				fromClient.getAttribute(null, "nickname")
			);
			var color:uint = uint(fromClient.getAttribute(null, "color"));
			message = decodeURI(message);
			_ui.appendMessage(
				"[chatMessage]" + nickname + "(" + fromClient.getClientID() + ")"
				+ "さん「" + message + "」" + fromClient,
				color
			);
		}

まとめ

さて、大変長々と説明してまいりました。お付き合い頂きありがとうございます。今回は具体的なサンプルコードでUnionを使ったアプリケーションの構築方法を紹介してきました。いかがでしたでしょうか。

Unionを使ったアプリケーションの作り方は、もちろん他にもあると思います。１つの例として参考にしていただければと思います。ご意見やご感想は、お気軽にコメントやtwitterでのつぶやきを頂ければと思います。

次回は、Union Serverをローカルにインストールしてみようと思います。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

ReactorのAPIドキュメントのすべてのクラスをみると、Eventの付く名前のクラスは7つあることが分かります。
順番はそれっぽい順にしてあります。

• ReactorEvent
• ConnectionEvent
• ServerEvent
• RoomManagerEvent
• RoomEvent
• ClientEvent
• LogEvent

順番にみていきます。

ReactorEvent

Reactorインスタンスから送出されるイベントです。

ReactorEventの使いどころ

• Union Serverとの接続が確立したことを知りたいとき
• Union Serverとの接続が切断されたことを知りたいとき

var reactor:Reactor = new Reactor();
reactor.addEventListener(ReactorEvent.READY, reactor_readyHandler);
reactor.addEventListener(ReactorEvent.CLOSE, reactor_closeHandler);
 
// addEventListenerしてからconnectします。
reactor.connect("tryunion.com", 9100);
 
function reactor_readyHandler()
{
    // 接続が確立されたのでRoom作るなどします。
 
}
 
function reactor_closeHandler()
{
    // 接続が切断されたので、ポップアップでお知らせを出す等します。
}

ConnectionEvent

明記されていませんが、Conenctionインスタンスから送出されるイベントと思われます。
Connectionクラス自体が直接扱うクラスではないので、内部的に使われるイベントだと思います。

ServerEvent

Serverインスタンスから送出されるイベントです。

ServerEventの使いどころ

• Serverに接続しているClient数を知りたいとき
• Serverの時間を取得したいとき

var server:Server = reactor.getServer();
server.addEventListener(ServerEvent.CLIENT_COUNT, server_clientCountHandler
server.addEventListener(ServerEvent.TIME_SYNC, server_timeSyncHandler);
 
// 既にreactorからReactorEvent.READYが送出されているとします。
 
// Union Serverの応答があればServerEvent.CLIENT_COUNTを送出します
server.getNumClientsOnServer(); 
 
// Union Serverの応答があればServerEvent.TIME_SYNCを送出します
server.syncTime();
 
function server_clientCountHandler(event:ServerEvent):void
{
    trace("Server clients:" + event.getNumClients());
}
 
function server_timeSyncHandler()
{
    // 1970年1月1日を基点としたミリ秒フォーマット
    // ServerEventインスタンスのプロパティから取れないあたりは
    // バージョンアップで変わりそうな予感がしますね。
    trace("Time is: " + Server(event.target).getServerTime());
}

チャットの発言の横に出す時間とかクライアント時間なんて当てに出来ないのでこれは便利ですね。

RoomManagerEvent

RoomManagerインスタンスから送出されるイベントです。

RoomManagerEventの使いどころ

• 指定したRoomのClient数を知りたいとき
• 自身のClientが作成しようとした部屋が作成できたか知りたいとき
• 特定のIDのRoomが生成されたことを知りたいとき
• 自身のClientが存在しないRoomへjoin, observe, leaveしたことを知りたいとき

var roomManager:RoomManager = reactor.getRoomManager();
roomManager.addEventListener(RoomManagerEvent.CLIENT_COUNT, roomManager_clientCountHandler);
roomManager.addEventListener(RoomManagerEvent.CREATE_ROOM_RESULTS, roomManager_createRoomResultHandler);
 
// 既にreactorからReactorEvent.READYが送出されているとします。
// la.fla.chat, la.fla.gameというRoomが存在しているとします。
 
// la.fla.*というIDのRoomをwatchします
roomManager.watchForRooms("la.fla.*");
 
// la.fla.*内のclient数を取得します。
// UnionServerからの応答があれば、RoomManagerEvent.CLIENT_COUNTを送出します。
roomManager.getNumClientsInRooms("la.fla.*");
 
// la.fla.lobbyを作成します。
// UnionServerからの応答があれば、RoomManagerEvent.CREATE_ROOM_RESULTS
roomManager.createRoom("la.fla.lobby");
 
function roomManager_clientCountHandler(event:RoomManagerEvent):void
{
	// la.fla.*内のクライアント数を取得します。
	trace("RoomManager clients:" + event.getNumClientsTotal());
}
 
function roomManager_createRoomResultHandler(event:RoomManagerEvent):void
{
	// 自身が作成しようとした部屋の作成結果を取得します。
	trace("RoomManager create room result:" + event.getStatus());
}

la.fla.*のような指定をすることで、特定のグループのRoomの人数を知ることが出来ます。
チャットの部屋とロビーの関係をla.fla.chat, la.fla.chat.room01, la.fla.chat.room02などとすると管理しやすそうですね。

RoomEvent

Roomインスタンスから送出されるイベントです。

RoomEventの使いどころ

以下のRoomとはRoomEventを送出したRoomインスタンスを示します。

• 自分自身のClientがRoomに無事join, leave, observe完了したことを知りたいとき
• 別のClientがRoomにがjoin, leave, observeしたことを知りたいとき
• Roomに入室、観察しているClient数の変化を知りたいとき
• Room内のClientがClient Attributeを更新、削除したことを知りたいとき
• 誰かがRoom Attributeが更新、削除したことを知りたいとき
• Room入室時に現在の状況を知りたいとき

var room:Room = roomManager.createRoom("la.fla.lobby");
 
room.addEevntListener(RoomEvent.JOIN, room_joinHandler);
room.addEventListener(RoomEvent.ADD_CLIENT, room_addClientHandler);
room.addEventListener(RoomEvent.REMOVE_CLIENT, room_removeClientHandler);
room.addEventListener(RoomEvent.UPDATE_CLIENT_ATTRIBUTE, room_updateClientAttributeHandler);
room.addEventListener(RoomEvent.UPDATE_ROOM_ATTRIBUTE, room_updateRoomAttributeHandler);
room.addEventListener(RoomEvent.SYNCHRONIZE, room_synchronizeHandler);
 
 
// 既にroomManagerからRoomManagerEvent.CREATE_ROOM_RESULTSが送出されているとします。
 
// UnionServerからの応答があれば、RoomEvent.JOINを送出します。
room.join();
 
function room_joinHandler(event:RoomEvent):void
{
	trace("ルームに無事入室できました。");
}
 
function room_addClientHandler(event:RoomEvent):void
{
	trace("ルームに別のClientが入室しました。");
}
 
function room_removeClientHandler(event:RoomEvent):void
{
	trace("ルームから別のClientが退室しました。");
}
 
function room_updateClientAttributeHandler(event:RoomEvent):void
{
	var attribute:Attribute = event.getChangedAttr();
	if (attribute.name == "_PING") return;
 
	// Client Attributeを更新したClientを表します。
	var client:IClient = event.getClient();
	var clientID:String = event.getClientID();
 
	trace(
		  clientID 
		+ "'s (" + attribute.scope + ")"
		+ attribute.name + " was changed " + attribute.oldValue
		+ " to " + attribute.value
	);
}
 
function room_updateRoomAttributeHandler(event:RoomEvent):void
{
	var attribute:Attribute = event.getChangedAttr();
	trace(
		  attribute.name + " was changed " + attribute.oldValue
		+ " to " + attribute.value
	);
}
 
function room_synchronizeHandler(event:RoomEvent):void
{
	var client:IClient;
	for each (client in _room.getClients())
	{
		// 既に入室しているClientのClient Attributeなどを取得する
	}
}

Union Platformでアプリケーションを作る際の核となるのは、このRoomEventとMessagesのイベントだと思います。
これらのイベント発生するイベントがユーザの視覚的な体験となるんですね。

ClientEvent

Clientインスタンスから送出されるイベントです。

ClientEventの使いどころ

• 特定ClientのRoomへのjoin、leaveを知りたいとき
• 特定ClientのClient Attributeの更新を知りたいとき

LogEvent

Loggerインスタンスから送出されるイベントです。

Messageのイベント

Messageのイベントはイベント用のインスタンスは生成されず、リスナー登録の引数やハンドラの引数が独自のものとなっています。
情報の共有化でもみたようにMessageは以下のAPIから送信されます。

• Server APIによるMessage
• RoomManager APIによるMessage
• Room APIによるMessage
• ClientManager APIによるMessage
• Client APIによるMessage
• Union ServerからのMessage

Messageイベントの使いどころ

情報の共有化でみてきた様なMessageの受信時に使います。

Server APIによるMessage

Serverに接続している全ClientへMessageを送信したい場合に使用します。

// 既にroomからRoomEvent.JOINが送出されているとします。
 
reactor.getMessageManager().addMessageListener("MESSAGE_ID", messageHandler);
 
 
// MESSAGE_IDというMessageを送信します。
// Union Serverから応答があれば、先にひもづけたmessageHandlerが呼ばれます。
server.sendMessage("MESSAGE_ID", true, null, "param1", "param2");
 
 
function messageHandler(fromClient:IClient, param1, param2):void
{
	trace(fromClient.getClientID() + "から" 
		+ param1 +"と" +param2 + "を受け取りました。");
}

RoomManager APIによるMessage

指定したRoomに入室しているClientへMessageを送信したい場合に使用します。

// 既にroomからRoomEvent.JOINが送出されているとします。
 
reactor.getMessageManager().addMessageListener("MESSAGE_ID", messageHandler);
 
 
// Room ID chat, game へ MESSAGE_IDというMessageを送信します。
// Union Serverから応答があれば、先にひもづけたmessageHandlerが呼ばれます。
roomManager.sendMessage("MESSAGE_ID", ["chat", "game"], true, null, "param1", "param2");
 
 
function messageHandler(fromClient:IClient, toRoom:Room, param1, param2):void
{
	trace(fromClient.getClientID() + "から" 
		+ param1 +"と" +param2 + "を受け取りました。");
}

Room APIによるMessage

現在Roomに入室しているClientへMessageを送信したい場合に使用します。

// 既にroomからRoomEvent.JOINが送出されているとします。
 
room.addMessageListener("MESSAGE_ID", messageHandler);
 
 
// MESSAGE_IDというMessageを送信します。
// Union Serverから応答があれば、先にひもづけたmessageHandlerが呼ばれます。
room.sendMessage("MESSAGE_ID", true, null, "param1", "param2");
 
 
function messageHandler(fromClient:IClient, param1, param2):void
{
	trace(fromClient.getClientID() + "から" 
		+ param1 +"と" +param2 + "を受け取りました。");
}

ClientManager APIによるMessage

指定したClientへMessageを送信したい場合に使用します。

// 既にroomからRoomEvent.JOINが送出されているとします。
 
reactor.getMessageManager().addMessageListener("MESSAGE_ID", messageHandler);
 
 
// Client ID 123, 124へMESSAGE_IDというMessageを送信します。
// Union Serverから応答があれば、先にひもづけたmessageHandlerが呼ばれます。
clientManager.sendMessage("MESSAGE_ID", ["123", "124"], null, "param1", "param2");
 
 
function messageHandler(fromClient:IClient, param1, param2):void
{
	trace(fromClient.getClientID() + "から" 
		+ param1 +"と" +param2 + "を受け取りました。");
}

Client APIによるMessage

特定のClientへMessageを送信したい場合に使用します。

// 既にroomからRoomEvent.JOINが送出されているとします。
 
var self:IClient = reactor.getClientManager().self();
self.addMessageListener("MESSAGE_ID", messageHandler);
 
var client:IClient = _room.getClients("123");
 
// MESSAGE_IDというMessageを送信します。
// Union Serverから応答があれば、先にひもづけたmessageHandlerが呼ばれます。
client.sendMessage("MESSAGE_ID", "param1", "param2");
 
// 自身のClient IDが123であれば実行されます
function messageHandler(fromClient:IClient, param1, param2):void
{
	trace(fromClient.getClientID() + "から" 
		+ param1 +"と" +param2 + "を受け取りました。");
}

まとめ

基本的なイベントの使いどころをみてきたので、もうアプリを作ることが出来そうです。
簡単なアプリの流れを見てみましょう。

基本的なアプリの流れ

1. Reactorのインスタンス作成
2. ReactorEventのlisten
   • ReactorEvent.READY
   • ReactorEvent.CLOSE
   • ReactorインスタンスからUnion Serverへ接続
   • ReactorインスタンスがReactorEvent.READYを送出
   • 自身のClientを取得
   • 自身のClient Attributeを初期化
   • RoomManagerEventのlisten
     • RoomManagerEvent.CLIENT_COUNT
     • RoomManagerEvent.CREATE_ROOM_RESULTS
   • Roomインスタンスの作成
   • RoomインスタンスがRoomManagerEvent.CREATE_ROOM_RESULTSを送出
   • RoomEventのlisten
     • RoomEvent.JOIN
     • RoomEvent.OBSERVE
     • RoomEvent.LEAVE
     • RoomEvent.STOP_OBSERVING
     • RoomEvent.CLIENT_COUNT
     • RoomEvent.UPDATE_CLIENT_ATTRIBUTE
     • RoomEvent.DELETE_CLIENT_ATTRIBUTE
     • RoomEvent.UPDATE_ROOM_ATTRIBUTE
     • RoomEvent.DELETE_CLIENT_ATTRIBUTE
     • RoomEvent.SYNCHRONIZE
   • Roomインスタンスの接続(join or observe)
   • RoomインスタンスがRoomEvent.JOIN or RoomEvent.OBSERVEを送出
   • RoomインスタンスがRoomEvent.SYNCHRONIZEを送出

もちろん、他にも今回見てきたイベントのリッスンを挟み込むことで色々なアプリケーションが作れます。
次回は、マルチアプリケーションの定番であるチャットアプリケーションを作ってみます。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル

どんな手段があるのか

情報の共有化は大きく分けて、Attributeによる共有とMessageによる共有に分けることが出来ます。

Attributeによる共有は、RoomのAttributeとClientのAtrributeがあります。

Messageによる共有は、Room(RoomManager) APIによるMessageとClient(ClientManager) APIによるMessageがあります。また、Union ServerからMessageを送信することも可能です。

まとめると以下のようになります。

• Attributeによる共有
  • Room Attribute
  • Client Attribute
• Messageによる共有
  • Server APIによるMessage
  • RoomManager APIによるMessage
  • Room APIによるMessage
  • ClientManager APIによるMessage
  • Client APIによるMessage
  • Union ServerからのMessage

各手段の特徴と使いどころ

次に先ほどの、情報の共有化手段の特徴と使いどころを考えて見ます。

Attributeによる共有

Room Attribute

Roomに対する属性の変更は、Roomに接続(join, observe)しているClientすべてに通知されます。よって、Roomに接続(join, observe)しているすべてのClientで共有したい情報はRoom Attributeを使います。ただし、ClientはRoom Attributeの通知を拒否する事も出来ます。

例えば、チャットを開催するRoomを考えます。チャット部屋の背景の色は参加者全員で共有すべき情報なので、Room Attributeを使うと良いでしょう。また、チャット内の話題や、発言回数、ビジュアル的な背景などの設定もRoom Attributeに適しています。

このRoom Attributeは、途中からRoomに接続したClientに対しては最新の情報が共有されます。たとえば、以下のようなシチュエーションが考えられます。

• Room Attribute backgroundはred
• Client Aがbackgroundをorangeに変更し、Client AとClient BにRoom Attributeのbackgroundがorangeへ更新されたことが通知される。
• Client Bがbackgroundをblueに変更し、Client AとClient BにRoom Attributeのbackgroundがblueへ更新されたことが通知される。
• Client CがRoomにjoinし、Room Attributeのbackgroundがblueであることを確認する。

図解すると以下のようになります。

Room Attribute backgroundはred

Client Aがbackgroundをorangeに変更し、Client AとClient BにRoom Attributeのbackgroundがorangeへ更新されたことが通知される。

Client Bがbackgroundをblueに変更し、Client AとClient BにRoom Attributeのbackgroundがblueへ更新されたことが通知される。

Client CがRoomにjoinし、Room Attributeのbackgroundがblueであることを確認する。

このとき、Client CはRoom Attributeが以前はred, orangeであった事を知りえません。

このように、画面内の最新情報を共有する際にRoom Attributeが適している事が多いです。他にも色々考えられます。

• ボードゲームのどのボードに何が置かれているかという情報
• お絵描きチャットのキャンバスの情報
• 陣取りゲームでどの陣が誰の陣であるかという情報

Room Attributeの永続化

また、Roomに設定されたRoom Attributeは、永続化することで次回の接続にも前回設定したRoom AttributeをUnion Serverへ保存しておく事が可能です。

ただ、現地点では、サーバ再起動時に永続化データは消えてしまうようです。

Client Attribute

Clientの持つ属性を他のClientと共有したいとき、Client Attributeを使います。Room Attributeとの違いとして、Client Attributeにはスコープという概念があります。

スコープは以下のようになります。

• グローバル
• 特定のRoom(Room IDで指定)

グローバルスコープに指定したClient Attributeの更新は、該当するClientが接続(join, observe)している全Room、Clientへ通知されます。特定のRoomをスコープとするClient Attributeの更新は、特定のRoomとそのRoomに接続(join, observe)しているClientへ通知されます。

チャットRoomとゲームRoomが存在するアプリケーションの場合、どちらのRoomにおいてもユーザーのニックネームやキャラクターカラーという情報は必要となります。ゲームRoomでは現在のゲーム上のカーソルの位置はゲームRoomだけで必要なClient Attributeとなるでしょう。

Client Attributeのスコープ

上記の図で、両方のRoomに共通するニックネームとキャラの色をグローバルスコープ。ゲームRoomでのユーザのカーソル位置はゲームRoomスコープに設定します。
Room Attributeと同様に、途中からRoomに接続したClientに対しては最新の情報が共有されます。

Client Attributeの永続化

また、Clientに設定されたClient Attributeは、永続化することで次回の接続にも前回設定したClient AttributeをUnion Serverへ保存しておく事が可能です。

ただ、こちらはUnion alpha3では永続化したClientデータをひもづける手段が提供されていなようなので未対応のようです。もし、情報をお持ちの方がいらっしゃいましたらご教授いただけるとうれしいです。

Messageによる共有

Attributeは最新の情報が共有されるため、Clientはその場に居合わせなくても最新の情報は取得できます。それに対して、Messageは、その場に居合わせた人だけが受け取れる共有情報です。

現実の例として、AさんとBさんが会話をしているとき、途中でやってきたCさんは今までAさんとBさんが話していた内容を知ることは出来ません。

RoomでAさんとBさんが会話中

RoomにCさんが接続

ただ、CさんはAさんかBさんに、今まで何を話していたのかを聞くことによって、今までの会話の内容を知ることが出来ます。AさんとBさんが会話をしながら、すべての記録をノートに書いていれば、後から来たCさんはそれを見ることで今までの会話の内容を知ることが出来ます。

同じような事をReactorで実現しようとすると、以下のような手順になります。

• ClientがMessageを送信する
• Messageを受け取ったClientはその内容を配列に保存する
• 途中から新しいClientがRoomに接続する
• 新しいClientは、一番最初から要るClientに今までのMessageの結果の送信を要求するMessageを送信する
• 一番最初から要るClientは、新しいClientへ今までのMessageの結果を送信する

Server APIによるMessage

Serverに接続する全Client、または特定のClient Attributeを持つClientへ共有したい情報を送信する際に利用します。

RoomManager APIによるMessage

指定した複数のRoomに接続する全Client、または特定のClient Attributeを持つClientへ共有したい情報を送信する際に利用します。

Room APIによるMessage

Roomに接続する全Client、または特定のClient Attributeを持つClientへ共有したい情報を送信する際に利用します。

ClientManager APIよるMessage

特定のClientに対して共有したい情報を送信する際に利用します。チャットRoom内で秘密のメッセージ交換などの利用します。

Client APIよるMessage

指定した複数のClientに対して共有したい情報を送信する際に利用します。チャットRoom内で秘密のメッセージ交換などの利用します。

Union ServerからのMessage

Union Serverでは、Server Module、Room ModuleといったModuleを定義することによって、各種イベント発生をトリガーとした、処理や、定期的な処理を作成する事が出来ます。

それらのModuleからMessageを送信することによって、Union ServerはRoomやClientに対してMessageを送信する事が出来ます。ReactorではRoomやClientのAPIを利用したMessageと同様に、Union ServerからのMessageを受け取る事が可能です。
Union ServerのModuleを作成方法を紹介する際に具体的な実装方法を見て行きます。

情報の共有化のまとめ

ここまでの情報の共有化についてまとめてみます。

以降、今回の情報共有化とは直接関係するわけではありませんが、Module Messageについて紹介します。Union Serverにログを保存したり、外部APIにログを保存する際などに使えるので、情報の共有化と関係があると考え、今回紹介します。

Module Message

Module Messageでは、Union Serverに対してMessageを送信します。送信したMessageの内容をUnion Server側で以下のような処理が可能です。

• チャットのログをDBに保存してからUnion ServerからのMessageでRoom, Clientへ通知する
• 受け取った情報を整形(チャット内の禁止用語を伏せ字にするなど)して、Union ServerからのMessageでRoom, Clientへ通知する
• Web APIを使ってtwitterへ投稿してからUnion ServerからのMessageでRoom, Clientへ通知する

このような処理を実装するためにはUnion Server側にServer ModuleもしくはRoom Moduleを設置する必要があります。Server ModuleとRoom ModuleはJAVA言語で作成することが出来ます。

もちろん、Module Message側でUnion ServerのMessageを使わない事も出来ます。Message Moduleに関しては、Union ServerのServer Module, Room Moduleの作成方法を紹介する回で詳しくみて行こうと思います。

次回は、ReactorのRoomEventやClientEventをみながら、情報の共有化を実装する方法を紹介しようと思います。

関連記事

1. UnionPlatform (1) 概要
2. UnionPlatform (2) 概念
3. Union Platform(3) 情報の共有化
4. Union Platform(4) Reactorのイベント
5. Union Platform(5) チャットを作る
6. Union Platform(6) Union Server入門
7. Union Platform(7) Union Server Module作成準備
8. Union Platform(8) Moduleサンプル