イベント処理の注意点

概要

UnrealEngine の Diarkis Plugin Sample には、サーバからの Response 通知 / Push 通知のコールバックを受け取る仕組みとして、以下の３種類の仕組みを用意しております。

DiarkisDispath クラスを利用した仕組み
EventHandler クラスを利用した仕組み
DiarkisSycData クラスを利用した仕組み

こちらのコールバックイベントの受け取る仕組みはサンプルのコードになりますので、もし自前の仕組みを使用された場合は置き換えて頂くことが可能です。

DiarkisDispath クラスを利用した仕組み

概要

DiarkisDispath クラスは、Diarkis Plugin Sample に用意されたサーバからの Response 通知 / Push 通知のコールバックを受け取る仕組みの一つです。
サーバから通知されたコールバックは、DiarkisXXXXDelegate の DiarkisDispatch にキューイングされます。
キューイングされた DiarkisDispatch は、UDiarkisNetworkManager::Tick() から呼び出される InGameDiarkisInterface::Execute()で実行されています。
キューイングされたイベントは、Tick() の呼び出し間隔で処理されますのでご注意ください。もし、タイムラグなく処理されたい場合は、必要に応じて InGameDiarkisInterface::Execute() を呼び出す場所を調整ください。
現状 DiarkisDispatch クラスの仕組みと EventHandler クラスを利用した仕組みと混在していますが、今後は DiarkisDispathの仕組みが、DiarkisPlugin の Sampleとしてアプリにコールバックイベントを返すメインの仕組みになる予定です。

処理シーケンス

ここでは、UDP サーバの Connect コマンドの処理の流れで説明しますが、他のモジュール（Room, P2P, MatchMakerなど）のコマンドのコールバックイベントも流れは一緒になります。それぞれの処理に合わせてクラスや関数を置き換えてご確認ください。

例えば UDP/TCP サーバ接続のコールバックイベントを受ける際の流れは以下になります。

まずは、サーバからの Response 通知 / Push 通知のコールバックを DiarkisDispatch でキューイングします。

アプリから UDP/TCP サーバに Connect します。
UDP/TCP サーバからの Response や Push 通知は、DiarkisUdpBase クラスで udp_->GetConnectedEvent() コールバックイベントにセットされている DiarkisUdpBase::OnConnect() が呼び出されます
DiarkisUdpBase の子クラス InGameDiarkisUdp::OnConnect() が呼び出されます。
InGameDiarkisUdp::OnConnect() 関数内の Dispatch() でイベントをキューイングします。

void InGameDiarkisUdp::OnConnect(const DiarkisConnectionEventArgs& e)
{
    DiarkisUdpBase::OnConnect(e);
    
    ....
    ....

    Dispatch(args, [this](std::shared_ptr<DiarkisDispatch::Args> args)
    {
        delegate_->OnConnect(*this, *std::static_pointer_cast<IDiarkisUdpDelegate::ConnectArgs>(args));
    });
}

次に、ゲームのスレッドから DiarkisDispatch でキューイングされたイベントを Execute() で実行します。

ゲームのスレッドの UDiarkisNetworkManager::Tick() から InGameDiarkisInterface::Execute() で Delegate が処理されます。
InGameDiarkisUdp::OnConnect() で Dispatch() された delegate_->OnConnect() が呼び出さます。
DiarkisSampleUdpDelegate::OnConnect() が呼び出さます。

DiarkisDispath の関連クラス

役割の概要
- アプリレイヤーで Diarkis コールバックイベントを受け取るためのクラス群（新）
コードの場所
- DiarkisPluginSample/Source/DiarkisExtension/XXXXX/Delegate
各クラス
- DiarkisDispatch.h / DiarkisDispatch.cpp : Diarkis のコールバックイベントをキューイングや実行するクラス
- DiarkisUDPDelegate.h : Diarkis の Group のコールバックイベントをキューに入れるクラス
- DiarkisP2PDelegate.h : Diarkisの P2P のコールバックイベントをキューに入れるクラス
- DiarkisMatchMakerDelegate.h : Diarkis の MatchMaker のコールバックイベントをキューに入れるクラス
- DiarkisRoomDelegate.h : Diarkis の Room のコールバックイベントをキューに入れるクラス
- DiarkisSessionDelegate.h : Diarkis の Session のコールバックイベントをキューに入れるクラス
- DiarkisGroupDelegate.h : Diarkis の Group のコールバックイベントをキューに入れるクラス

EventHandler クラスを利用した仕組み

概要

EventHandler クラスは、Diarkis Plugin Sample に用意されたサーバからの Response 通知 / Push 通知のコールバックを受け取る仕組みの一つで、BluePrint用コールバックイベントを返すための仕組みとして用意されています。
サーバから通知されたコールバックは、DiarkisNetworkXXXXEventEmitter の UDiarkisNetworkEventHandler にキューイングされます。
キューイングされた UDiarkisNetworkEventHandler は、UDiarkisNetworkManager::Tick() から呼び出される IUDiarkisNetworkEventHandler::Update() で実行されています。
キューイングされたイベントは、Tick() の呼び出し間隔で処理されますのでご注意ください。もし、タイムラグなく処理されたい場合は、必要に応じて UDiarkisNetworkEventHandler::Update() を呼び出す場所を調整ください。
現状 DiarkisDispatch クラスの仕組みと EventHandler クラスを利用した仕組みと混在していますが、今後は DiarkisDispathの仕組みが、DiarkisPlugin の Sampleとしてアプリにコールバックイベントを返すメインの仕組みになる予定です。

処理シーケンス

例えば UDP/TCP サーバ接続のコールバックイベントを受ける際の流れは以下になります。

まずは、サーバからの Response 通知 / Push 通知のコールバックを EventHandler でキューイングします。

アプリから UDP/TCP サーバに Connect します。
UDP/TCP サーバからの Response や Push 通知は、udp_->GetConnectedEvent() コールバックイベントにセットされている DiarkisUdpBase::OnConnect() が呼び出されます。
DiarkisUdpBase OnConnect() が呼び出され、内部的に udp_->IsConnected() == true に変更されます。
UDiarkisNetworkManager::Tick() から UpdateConnected() が定期的に呼び出され、GetUdpBase()->IsConnected()==true に切り替わった時に、EnqueueOnNetworkConnect() が呼び出されます。
UDiarkisNetworkCoreEventEmitter::EnqueueOnNetworkConnect() で OnNetworkConnect がキューイングされます。

次に、ゲームのスレッドから UDiarkisNetworkEventHandler でキューイングされたイベントを Update() で実行します。

ゲームのスレッドの UDiarkisNetworkManager::Tick() から EventHandler->Update() が呼び出されます。
UDiarkisNetworkEventHandler::Update() で、キューイングされたイベントが Event->CallFunction() で呼び出されます。
IDiarkisNetworkCoreEvent の派生クラスの ADiarkisSampleBase の子クラスの BPDiarkisPluginSample::OnNetworkConnect() のイベントが呼び出されます。
BPDiarkisPluginSample の親クラスの ADiarkisSampleBase::OnNetworkConnect_Implementation()が呼び出されます。

DiarkisSycData クラスを利用した仕組み

概要

DiarkisSycData クラスは、Diarkis Plugin Sample に用意されたサーバからの Response 通知 / Push 通知のコールバックを受け取る仕組みの一つで、キャラクターの位置同期など遅延を抑えたいコールバックイベントを処理する仕組みとして用意されています。

まずは、Room のリレー通信、P2P通信で取得した Payload をキューイングします。

DiarkisRoom::OnRoomMemberBroadcast() が呼び出されます。
syncData_->OnPositionSync() が呼び出ばれます。
payloadSyncQueue.push() で Payload をキューイングします。

次に、キューイングし Payload をデキューします。

UDiarkisSyncComponent::TickComponent() の処理で、 DiarkisRemoteMovementSync::UpdateMovement() が呼び出されます。
DequeueLastFrame() で Payload をデキューします。

前へDiarkis プラグインの基本的な使い方次へサンプル

最終更新 5 日前

役に立ちましたか？