ObjectDeliverer Blueprint APIリファレンス

このページでは、ObjectDelivererがBlueprintに公開するAPIを説明します。C++でも同じAPIを利用できます。各APIの使い分けはユースケースを参照してください。

API全体の関係

ObjectDelivererのAPIは4つの要素で構成されます。

    flowchart TB
	  M["ObjectDelivererManager<br>Start / Send / Close"] --> P["Protocol"]
	  M --> R["PacketRule"]
	  M --> D["DeliveryBox（任意）"]
	  D -->|"Send / Received"| M
	  P -->|"Connected / Disconnected / ReceiveData"| M

UObjectDelivererManager

通信全体を管理するクラスです。Startの実行からCloseまで、通信中は必ず参照を保持してください。

Create Object Deliverer Manager

マネージャーを作成します。

戻り値はメンバー変数に保存します。未保存の場合、ガベージコレクションの対象になり、通信が継続できません。

Start

通信を開始します。

すでに通信中の場合は、先にCloseを呼び出してから再開してください。

Close

通信を終了し、接続とリソースを解放します。接続中のクライアントがすべて切断されます。レベルの終了時（EndPlay）に呼び出してください。

Send

全接続先へデータを送信します。

SendTo

指定した接続先だけへデータを送信します。TCP/IPサーバーで特定のクライアントに送るときに使用します。

IsConnected

接続済みかどうかを返します（true: 接続中、false: 切断）。

ConnectedList

現在接続中の接続先オブジェクトの一覧（読み取り専用）。TCP/IPサーバーで複数クライアントを扱うときに使用します。

With Object Deliverer Logger

ロギングで説明するロガーを取り付けます。戻り値はマネージャー自身のため、作成直後に続けて呼び出せます。nullptrを渡すと取り外します。

Is Event With Game Thread

イベントをゲームスレッドで処理するかどうかの設定（既定: true）。Create Object Deliverer Managerの引数と同じ項目です。

イベント

Protocol

ProtocolはUProtocolFactoryのノードで作成します。作成したProtocolはStartへ渡します。

UProtocolFactoryのノード一覧

各Protocolの挙動と使い分けの詳細は、ユースケースの対応する節を参照してください。

Protocolオブジェクト共通のノード

各Protocolオブジェクト（Create Protocol ...の戻り値の型）には、次のノードが用意されています（一部のProtocolを除く）。

With ...系のノードは戻り値としてProtocol自身を返すため、続けて呼び出せます。バッファサイズの既定値は1MBです。

GetIPAddress / GetIPAddressInString

TCP/IP系のProtocolオブジェクトと、サーバーが受け入れた接続先（ClientSocket）で使用できます。IPアドレスをバイト列または文字列で取得します。送信元を判別したい場合に使用します。

WebSocketクライアントの追加ノード

TLSクライアントの追加ノード（UProtocolTcpIpClientTls）

Create Protocol Tcp Ip Client Tlsの戻り値には、証明書の検証方法を指定するノードが用意されています。

Get Last Tls Errorは、ハンドシェイク失敗（信頼できないCAが署名した証明書チェーンなど）、証明書やCAの設定不備、ハンドシェイク直後の切断の理由を返します。接続が確立した時点でクリアされます。

TLSサーバーの追加ノード（UProtocolTcpIpServerTls）

PacketRule

PacketRuleはUPacketRuleFactoryのノードで作成します。

送信者と受信者で同じルールを設定してください。詳細はユースケースのパケット分割ルールを参照してください。

DeliveryBox

DeliveryBoxはUDeliveryBoxFactoryのノードで作成します。StartのDeliveryBoxへ渡します。

UObjectDeliveryBoxUsingJsonのノード

UUtf8StringDeliveryBoxのノード

ロギング

With Object Deliverer LoggerでUObjectDelivererLoggerをマネージャーへ取り付けると、プラグイン内部のログをBlueprintで受け取れます。

On Log Messageイベントは次の引数を持ちます。

通信が期待どおりに動かないときの原因特定に使用できます。独自のロガーはUObjectDelivererLoggerBaseを継承して作成します。

列挙型

C++での実装例

TCPサーバーをC++で実装する例です。Blueprintの構成と同じ要素を使用します。

void UMyClass::Start()
{
    auto deliverer = UObjectDelivererManager::CreateObjectDelivererManager();

    // イベントハンドラーを設定
    deliverer->Connected.AddDynamic(this, &UMyClass::OnConnect);
    deliverer->Disconnected.AddDynamic(this, &UMyClass::OnDisConnect);
    deliverer->ReceiveData.AddDynamic(this, &UMyClass::OnReceive);

    // 通信を開始
    // プロトコル: TCP/IP サーバー
    // データ分割ルール: ヘッダー(サイズ) + ボディ
    // シリアライゼーション方法: バイト配列
    deliverer->Start(UProtocolFactory::CreateProtocolTcpIpServer(9099),
                     UPacketRuleFactory::CreatePacketRuleSizeBody());
}

void UMyClass::OnConnect(UObjectDelivererProtocol* ClientSocket)
{
    // データを送信
    TArray<uint8> buffer;
    deliverer->Send(buffer);
}

void UMyClass::OnDisConnect(UObjectDelivererProtocol* ClientSocket)
{
    // 切断を処理
    UE_LOG(LogTemp, Log, TEXT("closed"));
}

void UMyClass::OnReceive(UObjectDelivererProtocol* ClientSocket, const TArray<uint8>& Buffer)
{
    // 受信したデータを処理
}

ライフサイクルと保持のまとめ

1. Create Object Deliverer Managerで作成したマネージャーはメンバー変数で保持します。
2. Startに渡したProtocol・PacketRule・DeliveryBoxも、通信中はマネージャーが内部で保持します。DeliveryBoxのReceivedイベントを使う場合は、イベントバインドのためにDeliveryBox自身も変数へ保存してください。
3. TCP/IPサーバー・UDP受信者では、ConnectedイベントのClientSocketとConnectedListで接続先を管理できます。SendToで特定の接続先へ送信できます。
4. 不要になったらCloseを呼び出します。呼び出さないままオブジェクトが破棄されると、接続が残る可能性があります。