Loaderは、InteractiveObjectを継承しているので、MouseEventは受け取れるはずです。それに、Loaderにスタティックな画像(jpegやpngなど)を読み込んだ際には、LoaderにMouseEvent.CLICKのイベントリスナーを設定すれば、イベント拾えるんですよね。

これは以前、fla.la » クロススクリプティングで紹介した

ロード元swfファイルのDisplayObjectツリーと、ロードしたswfファイルのDisplayObjectツリー間のイベント伝達フロー

が関係してきます。

そこでAdobe ActionScript 3.0 * クロススクリプトを読んでみますと、以下の記述があります。

1. 親オブジェクトを所有する SWF ファイルは、ソースオブジェクトを所有する SWF ファイルのドメインを信頼するために、Security.allowDomain() メソッドを呼び出す必要があります。
2. ソースオブジェクトを所有する SWF ファイルは、親オブジェクトを所有する SWF ファイルのドメインを信頼するために、Security.allowDomain() メソッドを呼び出す必要があります。

つまり読み込んだexample.com/hoge.swfからexample.net/fugo.swfを読み込んで、イベント伝達を可能にするためには、お互いのドメインを引数にしたSecurity.allowDomain()を実行する必要があるということになります。

サンプルソース

サンプルをwonderflに上げておきました。中央付近に表示されるキャラクターにMouseEvent.CLICKイベントのリスナーを登録していますが、クリックしても反応しません。

キャプチャーフェーズ、ターゲットフェーズ、バブリングフェーズすべてのフェーズでイベントが発生していないことがポイントです。

そこで、上部にある「Security.allowDomain()」というボタンをクリックしたあとで、キャラクターをクリックすると反応することが分かると思います。

なお、http://asmple.com/work/avatar3.swfでは以下のSecurity.allowDomain()が記述してあります。

Security.allowDomain("wonderfl.net");
Security.allowDomain("swf.wonderfl.net");

そして先日、社内の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サンプル

Wonderfl API を使ってみよう！

ちなみに作成したAPI Keyの一覧は、http://wonderfl.net/account/api_keysから見れます。

Client作ってみた

というわけで自分もAS3のClientを作ってみた。こうやって使うイメージ。

// set your api key
WonderflAPIClient.apiKey = "your_wonderfl_api_key";
 
// create client
var client:WonderflAPIClient = new WonderflAPIClient();
 
// listen
client.addEventListener(WonderflAPIClient.GET_USER_COMPLETE, hander);
 
// get user info
client.getUser();
 
// handler
function hander(event:Event):void
{
	trace(client.user.name);
}

ソース

wonderflにあげてあります。L:121以降がWonderflAPIClientです。コピペでご利用下さい。

まとめ

今後のマッシュアップ作品に期待です。私も何か作りたい！

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

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

コレを使って、一番見せたいタイミングに近いところのキャプチャが出来るわけです。ただ、ローカルでwonderfl用のコードを書く際に

Wonderfl.capture_delay(10);

この記述でエラーが起きてしまうので、どうにかならないかと思っていました。

んが、簡単に解決出来ることに気づきました。クラスパスが通っている箇所に以下のようなダミーのクラスを用意しておけば良いですね。

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

package  
{
	public class Wonderfl 
	{
		public static function capture_delay(num:Number):void
		{	
		}
		public static function disable_capture():void
		{
		}
	}	
}

実は他にもメソッドがあるかもしれませんが、取りあえずはこれで事足ります。恥ずかしながら、今まではローカル作業中は、コメントアウトしてwonderflに挙げるときにコメントを外すという地味な作業をしていました。

これで少し手間が省けます。やった。

Threadのtestを書く方法が良く分かりません。どうやるんだろうと思い考えてみたのがこれ。TestThreadはものすごい適当です。

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

package
{
    import flash.events.Event;
    import org.libspark.as3unit.*;
    import org.libspark.as3unit.assert.*;
    import org.libspark.thread.EnterFrameThreadExecutor;
    import org.libspark.thread.Thread;
 
    /**
     * HogeThreadTest
     */
    public class HogeThreadTest 
    {
        beforeClass static function setUp():void
        {
            // Threadの初期化をしておく
            Thread.initialize(new EnterFrameThreadExecutor());
        }
 
        test function asyncMethod():void
        {
            // testしたいThreadを生成
            var thread:HogeThreadTest = new HogeThreadTest();
 
            // test用のThreadでラップする
            var testThread:TestThread = new TestThread(thread);
 
            // test用のThread完了後にdispatchされるEvent.COMPLETEを待つ
            testThread.dispatcher.addEventListener(Event.COMPLETE, async(
            function(event:Event):void
            {
                assertTrue(thread.reactor.isConnected(),
                     "check whether connected reactor.isConnected() is true or not.");
            },1000));
 
            // test用のThreadを実行
            testThread.start();
        }
 
    }
}
 
import flash.events.Event;
import flash.events.EventDispatcher;
import org.libspark.thread.Thread;
 
/**
 * Test用のThread
 */
class TestThread extends Thread
{
    private var _dispatcher:EventDispatcher;
    /**
     * Eventを送出するためにEventDispatcherインスタンスを生成
     */
    public function get dispatcher():EventDispatcher
    {
        return _dispatcher;
    }
 
    /**
     * 保持するThreadインスタンス
     */
    private var _thread:Thread;
 
    /**
     * runメソッド
     */
    override protected function run():void
    {
        // コンストラクタで受け取ったThreadを実行
        _thread.start();
        // 実行終わるのを待つ
        _thread.join();
        // doenを実行する
        next(done);
    }
 
    private function done():void
    {
        // Event.COMPLETEを送出する
        _dispatcher.dispatchEvent(new Event(Event.COMPLETE));
    }
 
    /**
     * 引数でThreadを受け取る
     * @param    thread
     */
    function TestThread(thread:Thread):void
    {
        _dispatcher = new EventDispatcher();
        _thread = thread;
    }
}

まず、TestThreadを作っておきます。TestThreadは、run()メソッドを実行すると以下のような動作をします。

• コンストラクタで受け取ったThreadを実行(start)して待機(join)します。
• 受け取ったThreadが完了したら、dispatcherからEvent.COMPLETEを送出します。

testコードでは、testしたいThreadをTestThredに渡して、async()メソッドでイベントを待機します。

このようなTestThreadみたいなのって実はネイティブでどこかにあったりするんでしょうか。
みなさん、どのようにThreadのtestを書いているのでしょう？このライブラリのtestに良い例があるよ！とかあったら教えて欲しいですよ！

とりあえず、それなりに動くようなりました。
そこで、こっそりとGoogle Codeにて公開してみました。

その名も、as3paintoco(ぺいんとこ)と言います。

機能

主に、以下のような機能を持っています。

• undo, redo機能
• replay機能
• お絵描きした画像の保存機能

使い方

as3paintoco(ぺいんとこ)はFlash Player10.0.32以降に対応しております。ただし、開発中ステータスのため予期しない動作をするかも知れません。その点ご了承下さい。

ライブラリの準備

1. このライブラリは、as3corelibを使用しているので、as3corelib.swcをライブラリパスに通します。
2. as3paintoco_alpha4.swcをダウンロードして、ライブラリパスに通します。

サンプルコード

コンテキストメニューからツールを選んで、キャンバスにお絵描きするサンプルです。

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

package 
{
    import flash.display.Sprite;
    import flash.events.ContextMenuEvent;
    import flash.ui.ContextMenu;
    import flash.ui.ContextMenuItem;
    import jp.wxd.as3paintoco.AS3Paintoco;
    import jp.wxd.as3paintoco.tools.CircleTool;
    import jp.wxd.as3paintoco.tools.ITool;
    import jp.wxd.as3paintoco.tools.LineTool;
    import jp.wxd.as3paintoco.tools.PenTool;
    import jp.wxd.as3paintoco.tools.SelectTool;
    import jp.wxd.as3paintoco.tools.SquareTool;
    import jp.wxd.as3paintoco.tools.TextTool;
 
    /**
     * as3Paintoco sampleコード2
     * @author Copyright (C) naoto koshikawa, All Rights Reserved.
     */
    public class PaintocoWork2 extends Sprite
    {
        //----------------------------------------------------------------------
        //  properties
        //----------------------------------------------------------------------
        //------------------------------
        //  private properties
        //------------------------------
        /**
         * AS3Paintoco instance
         */
        private var _paint:AS3Paintoco;
 
        /**
         * tools
         */
        private var _tools:Object;
 
        //----------------------------------------------------------------------
        //  methods
        //----------------------------------------------------------------------
        //------------------------------
        //  public methods
        //------------------------------
        /**
         * constructor
         */
        public function PaintocoWork2() 
        {
            _tools = {
                penTool: new PenTool(),
                lineTool: new LineTool(),
                squareTool: new SquareTool(),
                circleTool: new CircleTool(),
                textTool: new TextTool(),
                selectTool: new SelectTool()
            };
 
            _tools.textTool.options = {
                size:24
            };
 
            // AS3Paintocoのインスタンスを生成します。
            _paint = new AS3Paintoco(this, 465, 465);
            _paint.replayable = true;
            initialize();
            createMenu();
        }
 
        /**
         * initialize 
         */
        private function initialize():void
        {
           _paint.initialize();
           // 初期ツールを設定します。
            _paint.applyTool(_tools.penTool);
 
            // キャンバスをアクティブにしお絵描き可能にします。
            _paint.activate();
        }
 
        /**
         * create context menu
         */
        private function createMenu():void
        {
            var contextMenu:ContextMenu = new ContextMenu();
            contextMenu.hideBuiltInItems();
 
            var penMenu:ContextMenuItem = new ContextMenuItem("penTool", true);
            var lineMenu:ContextMenuItem = new ContextMenuItem("lineTool");
            var squareMenu:ContextMenuItem = new ContextMenuItem("squareTool");
            var circleMenu:ContextMenuItem = new ContextMenuItem("circleTool");
            var textMenu:ContextMenuItem = new ContextMenuItem("textTool");
            var selectMenu:ContextMenuItem = new ContextMenuItem("selectTool");
 
            penMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
            lineMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
            squareMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
            circleMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
            textMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
            selectMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexToolMenu_menuSelect);
 
            var clearMenu:ContextMenuItem = new ContextMenuItem("clearAction");
            var undoMenu:ContextMenuItem = new ContextMenuItem("undoAction");
            var redoMenu:ContextMenuItem = new ContextMenuItem("redoAction");
            var replayMenu:ContextMenuItem = new ContextMenuItem("replayAction", true);
            var saveMenu:ContextMenuItem = new ContextMenuItem("saveAction", true);
 
            clearMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexActionMenu_menuSelect);
            undoMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexActionMenu_menuSelect);
            redoMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexActionMenu_menuSelect);
            replayMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
                contexActionMenu_menuSelect);
            saveMenu.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT,
				contexActionMenu_menuSelect);
 
            contextMenu.customItems.push(clearMenu);
            contextMenu.customItems.push(undoMenu);
            contextMenu.customItems.push(redoMenu);
            contextMenu.customItems.push(replayMenu);
            contextMenu.customItems.push(penMenu);
            contextMenu.customItems.push(lineMenu);
            contextMenu.customItems.push(squareMenu);
            contextMenu.customItems.push(circleMenu);
            contextMenu.customItems.push(textMenu);
            contextMenu.customItems.push(selectMenu);
            contextMenu.customItems.push(saveMenu);
 
            this.contextMenu = contextMenu;
        }
 
        //----------------------------------------------------------------------
        //  event listener
        //----------------------------------------------------------------------
        /**
         * ContextMenuEvent.MENU_SELECT
         * @param    event
         */
        private function contexToolMenu_menuSelect(event:ContextMenuEvent):void
        {
            var toolKey:String = ContextMenuItem(event.target).caption;
            // 選択されたツールを適用します。
            _paint.applyTool(_tools[toolKey]);
        }
 
        /**
         * ContextMenuEvent.MENU_SELECT
         * @param    event
         */
        private function contexActionMenu_menuSelect(event:ContextMenuEvent):void
        {
            var toolKey:String = ContextMenuItem(event.target).caption;
            switch (toolKey)
            {
                case "clearAction":
                    // 初期化します。
                    initialize();
                    break;
                case "undoAction":
                    // ワンストロークを取り消します。
                    _paint.undo();
                    break;
                case "redoAction":
                    // ワンストロークをやり直します。
                    _paint.redo();
                    break;
                case "replayAction":
                    // 最初からお絵描きを再生します。
                    _paint.replay(5.0);
                    break;
                case "saveAction":
                    // お絵描きしたキャンバスをローカルファイルに保存します。
                    _paint.save("paint.png");
                    break;
            }
        }
    }
}

その他のサンプル

as3paintoco(ぺいんとこ)を使って作成したお絵描きツールです。
現状は、UIを作成する手間がかかるので、今後、簡単に各種ツールボタンやオプション設定用のUIやスキンを作成することもぼんやりと考えております。

まとめ

というわけで、今回は簡単な紹介でした。今後も、お絵描きライブラリのas3paintoco(ぺいんとこ)は開発を進めながら追加機能などを紹介していきます。

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

package
{
	import flash.utils.ByteArray;
	/**
	 * <p>Objectのdeep copyを実行する関数です。</p>
	 */
	public function clone(object:Object):Object
	{
		var byteArray:ByteArray = new ByteArray();
		byteArray.writeObject(object);
		byteArray.position = 0;
		return byteArray.readObject();
	}
}

出典

ActionScript3 における deep copy

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さんありがとうございます。