WolfboyDispatcher

ver 1.1.0

dataType : baseType というデータ型があるときに、upstreamからdownstreamへと、 受取手の型の指定をしつつ、流すデータの型特定をせずに、 データを流すことができるディスパッチャ。

From upstream

data -> Dispatcher -> SendTo(byte[], DOWNSTREAM_TARGET_TYPE)

アップストリームからはディスパッチャ経由で特定のクラスに対してデータを流す
(特にデータ型を指定せず流せる)

To downstream(DOWNSTREAM_TARGET_TYPE)

Dispatcher <- SetReceiver(ReceiverMethod<dataType>)

ダウンストリームは自身がもっているメソッドを
「特定のdataTypeを受け取るハンドラ」として登録する

こうすることで、上流からはデータを受け取って欲しいクラスだけを指定してよく分からないデータを送付し、

下流ではセットしたReceiverが受け取れる型のデータだけが届く、というメッセージングの仕組み。

また、型指定によって下流もすぐさま別の下流への上流として振る舞うことができる。

Simple case

次のコードで、upstream classから、downstream classへと、byte[]を送ることができる。 downstream側では、byte[]が特定の型(この場合Message1型)だった場合のみ、データを受け取る。

// in upstream class,

// send data(byte[]) from upstream to downstream.
Dispatchers<MessageBase>.DispatchRoute<SourceEmitter>().SendTo(data, typeof(WantToReceiveMessage1));


// in downstream class,

// receive specific typed data at downstream.
Dispatchers<MessageBase>.DispatchRoute<SourceEmitter>().SetReceiver<Message1>(ReceiveMessage1);

void ReceiveMessage1 (Message1 deserializedData) {
	// deserialized data received!
}

送信する側は送付するデータの型を分別せずに対象を指定して送付することができ、 受信する側はデータが特定の型だった場合のみ、型を指定して受け取ることができる。

また、送付にしも受け取りにも、インスタンスの指定は一切ない。型の指定があるのみ。

Multi Target Dispatch

複数のターゲット型に対してあるデータを投げることができる。

// in upstream class,

// send data(byte[]) from upstream to downstream x N.
Dispatchers<MessageBase>.DispatchRoute<SourceEmitter>().SendTo(data, typeof(WantToReceiveMessage1), typeof(WantToReceiveMessage2), ...);

Multi Level Dispatch

複数のDispatcherを適当な型単位で定義することができるので、 階層構造を持たせてメッセージ伝搬をさせることができる。

次のコードでは、とあるSourceEmitter型をキーとしたディスパッチ経路を指定して、WantToReceiveMessage1型のレシーバに向けてのみデータ(byte[])を流す。

Dispatchers<MessageBase>.DispatchRoute<SourceEmitter>().SendTo(data, typeof(WantToReceiveMessage1));

SourceEmitter型以外の型でDispatchRouteをセットすれば、別の経路として扱うことができる。

これにより、複数の階層をもったオブジェクト構造に対してデータを送付することが可能。

Relay data between Receiver

次のようなコードで、WantToReceiveMessage1クラスのReceiveMessage2メソッドで受け取ったMessage2型のデータを、WantToReceiveMessage1よりさらに下のWantToReceiveMessage2型のレシーバへと、そのまま受けわたすことができる。

public void ReceiveMessage2 (Message2 data) {
	Debug.LogError("ReceiveMessage2 received data:" + data.param2);

	// relay data to next downstream.
	Dispatchers<MessageBase>.DispatchRoute<WantToReceiveMessage1>().Relay(data, typeof(WantToReceiveMessage2));
}

Relayされたデータを受け取るWantToReceiveMessage2型のコードでは、 WantToReceiveMessage1というDispatchRouteから、Message2型のデータを受け取るようになっている。

public class WantToReceiveMessage2 {
	public WantToReceiveMessage2 () {
		Dispatchers<MessageBase>.DispatchRoute<WantToReceiveMessage1>().SetReceiver<Message2>(Receiver);
	}

	public void Receiver (Message2 data) {
		Debug.LogError("WantToReceiveMessage2 received data:" + data.param2);
	}
}

Multi DataType Dispatch

次のコードでは、とあるMessageBase型を基底としたデータを扱うディスパッチャを扱っている。

Dispatchers<MessageBase>.DispatchRoute<SourceEmitter>().SendTo(data, typeof(WantToReceiveMessage1));

Dispatcherに別の基底型をセットすれば、別のデータを運ぶディスパッチャとして使える。