VisualStudioとEOS-SDKを使ったeos_console_testのC++コードを元に、Epic Online ServicesのP2P機能を使って簡単なP2P通信をしてみよう、といった趣旨の記事です

Epic Online Servicesって何？
はじめに
ソースコードはこちら
ビルド環境
ビルド方法
オリジナルからの変更点
DevAuthToolの使い方
実行前準備
動作内容
- マッチング主催者側（eos_console_test）
- マッチング参加者側（eos_console_test_join）
最後に

Epic Online Servicesって何？

Epic Gamesが提供しているオンラインサービスです。ゲームやアプリケーションに組み込むことでオンラインゲームの開発が出来るミドルウエアで、現時点ではコンソール機を含み完全無償で提供されています。

公式ドキュメント
 【CEDEC2020】無料でオンラインゲーム開発～EOS を利用したゲーム開発～
Epic Online Services でできること
 「EOS/UE5 Deep Dive 2023」の資料が公開されました！
『地球防衛軍６』におけるEOS導入と実装事例

はじめに

オリジナルのeos_console_testは、とある勉強会のスライド内容補強のために用意したもので、
EOS-SDKのみを利用し、なるべく構造が簡単になるよう面倒そうな処理はなるべく省き、
Epic Online Servicesのロビー機能が最低限確認できる、といった目的のために作成したものです。

提供コードとしては趣旨に沿ったものであったので、これで良かった、と思うのですが、
ロビーだけあってもしょうがないよなぁ、とも思うのでP2Pの部分も追加してみました。
（~~許可をとるのがちょっと面倒だったため~~完全に業務外となっており、forkする形になっております）

DevAuthToolを前提で複数のアプリを立ち上げて自動的にログイン状態にする、
ロビーへの参加を行う
簡単なP2P管理部分の実装を行う

といった内容を追加したものです

動作させるにはマッチングホスト側と参加側で二名分、Epicアカウントが必要になりますので、事前に作成しておいてください。両方とも同一のアカウントではマッチングが正しく動作しません。

ソースコードはこちら

forkしてP2Pの機能を追加したプロジェクトはこちらになります。

eos_console_test

ビルド環境

動作確認を行ったツール、SDKはこちらの環境を利用しました。

VisualStudio2022 17.8.2
EOS-SDK-27379709-v1.16.1

ビルド方法

ビルド方法や事前準備は、fork以前のプロジェクトと同様となります

eos_console_test/README.md こちらの項目をこなすとビルド出来るようになっております。

オリジナルからの変更点

マッチングホスティング側と参加側でプロジェクトを分離

異なる部分のみをif文で分岐させて、共通処理で動作させてもいいのですが、
動作順序が追いかけづらくなってしまうので分離しました
それぞれのプロジェクトのmain()が上から順に実行されるようになっています。

DevAuthTool前提としてデバッグ中は認証を自動化

ログインするのが大変なので、DevAuthToolで事前にログインしたものを固定の名前で使います。
DevAuthToolのポートは8080で、マッチングホスト側はHOSTING、参加側はJOINという名前で事前に登録しておいてください

P2P処理の実装

ロビーからのEOS_LMS_JOINEDなどを利用してP2Pのマッチング状態を作成します
初期化、通信許可、開通のためのパケット送受信と相互確認、接続後は定期的に通信を行う、といった流れが簡易に実装されています。

DevAuthToolの使い方

なぜ使うのか

ログイン状態を別のプログラムで保留できるようになるため、一度ログインした状態を作ってしまえばデバッグ実行時のログイン認証を大幅に簡略化できるようになります

マニュアル

DevAuthTool

概要

DevAuthToolはSDK内に入っています、
SDK\Tools\EOS_DevAuthTool-win32-x64-1.1.0.zip
が該当アプリケーションです

DevAuthToolはEpicアカウントのログイン処理を代行（というか維持）してくれるツールです
（ゲームを起動するたびにログインするのは非常に面倒なので、現時点で大変に便利なのですが、保存機能などあるともっと喜ばれると思います）

できること

DevAuthToolで事前準備を行い、EOS_LCT_Developerを指定して認証を行うと、二段階認証などをすっとばしてデバッグ出来るようになります
ビルドやデバッグ機材固有の情報をキーにすれば、入力をすべて飛ばしてデバッグを行うことも出来るようになります

今回の使い方

DevAuthToolを起動し、ポート番号を8080に設定します
登録を二つ作っていますが、すべて異なったEpic アカウントを用意し、それぞれログインする必要があります。
ログインを選び、Epicアカウントにログインし、「HOSTING」と名前を付けます

再びログインを選び、Epicアカウントにログインし、「JOIN」と名前を付けます

両方ログインが完了すると、ツールの左側が↓のようになります

これでDevAuthToolの準備は完了となります

実行前準備

VisualStudio2022で実行するのですが、複数同時デバッグ実行の設定を行うと楽に実行できます

ソリューションエクスプローラーのソリューションを右クリックし、

「スタートアッププロジェクトの構成」を選択します

「スタートアッププロジェクト」の編集が出来るプロパティダイアログへ飛ばされるので、
「マルチスタートアッププロジェクト」を動作するように選択し、
２つあるプロジェクトのアクションを両方とも「開始」に設定し、「OK」を押します
これでデバッグ実行時に２つのアプリケーションが同時にデバッガにアタッチされた状態で立ち上がります。
（両方ともデバッグした状態での実行できるようになります）

コードに小細工をし、デバッガに接続されている場合はDevAuthToolを使い固有名で自動的に認証を動作するようにしてあるため、この動作が不要な場合は良い感じに対処してください。

コード（折りたたまれています）

#define AUTH_CREDENTIALS_TOKEN "HOSTING"
// #define AUTH_CREDENTIALS_TOKEN "JOIN"
EOS_Auth_Credentials auth_credentials = {};

std::string _auth_id, _auth_token;

auth_credentials.ApiVersion = EOS_AUTH_CREDENTIALS_API_LATEST;

if (IsDebuggerPresent())
{
    auth_credentials.Type = EOS_ELoginCredentialType::EOS_LCT_Developer;

    auth_credentials.Id    = "localhost:8080";
    auth_credentials.Token = AUTH_CREDENTIALS_TOKEN;
}

動作内容

マッチング主催者側（eos_console_test）

ロビー作成から待機

EOSを初期化、DevAuthTool経由で"HOSTING"という名前で認証し、ロビーを作成し待機する

ロビーの属性には、"now"という日時情報を付与し、一番新しいロビーがわかるようにしています、

コード（折りたたまれています）

// ロビーを作成
auto lobby = eos.LobbyCreate();
// ロビーに属性を設定
eos.LobbySetAttributes(lobby, i, 1);
// 待機する
EOS::WaitSignal(eos);

void LobbySetAttributes(std::shared_ptr<Lobby> p, int number, int test_value)
{
    // nowという属性に現在の時間を設定する
    auto tm = std::chrono::system_clock::now();
    auto tp_msec = std::chrono::duration_cast<std::chrono::milliseconds>(tm.time_since_epoch());
    AddAttribute(modification, MakeAttribute(attr, "now", (int64_t)tp_msec.count()));
}

これは、デバッガで強制的に終了するなどでロビーをつぶした場合、サーバに残り続けてしまうという問題対策も兼ねています
（一番最新のものが識別できるので、デバッグ中に間違って参加しないようにできます）

他者の参加、P2P許可

ロビーでは誰かが参加してくると、EOS_ELobbyMemberStatus::EOS_LMS_JOINEDが発火し、P2P::OnJoined() へ参加者情報が届きます

コード（折りたたまれています）

void Lobby::OnLobbyMemberStatusReceivedCallbackInfo(const EOS_Lobby_LobbyMemberStatusReceivedCallbackInfo& data)
{
    switch (data.CurrentStatus)
    {
        case EOS_ELobbyMemberStatus::EOS_LMS_CLOSED:
            puts("EOS_LMS_CLOSED");
            break;
        case EOS_ELobbyMemberStatus::EOS_LMS_DISCONNECTED:
            puts("EOS_LMS_DISCONNECTED");
            m_p2p.OnLeft(data.TargetUserId);
            break;
        case EOS_ELobbyMemberStatus::EOS_LMS_JOINED:
            m_p2p.OnJoined(data.TargetUserId);
            puts("EOS_LMS_JOINED");
            break;
        case EOS_ELobbyMemberStatus::EOS_LMS_KICKED:
            puts("EOS_LMS_KICKED");
            break;
        case EOS_ELobbyMemberStatus::EOS_LMS_LEFT:
            puts("EOS_LMS_LEFT");
            m_p2p.OnLeft(data.TargetUserId);
            break;
        case EOS_ELobbyMemberStatus::EOS_LMS_PROMOTED:
            puts("EOS_LMS_PROMOTED");
            break;
        default:
            puts("error");
            break;
    }
}

P2P::OnJoinedではその情報を元に、「P2P::Link」を作成し、EOS_P2P_AcceptConnectionを行います。

コード（折りたたまれています）

void P2P::OnJoined(EOS_ProductUserId id)
{
    const auto _id = eos::Account<EOS_ProductUserId>::ToString(id);
    m_links[_id] = std::make_shared<Link>(*this, id);
}

/// @brief 接続許可を設定します
void P2P::Link::AcceptConnection()
{
    EOS_P2P_AcceptConnectionOptions options;
    options.ApiVersion   = EOS_P2P_ACCEPTCONNECTION_API_LATEST;
    options.LocalUserId  = m_p2p.m_local_user_id;
    options.RemoteUserId = m_product_id;
    options.SocketId = &m_p2p.m_socket_id;
    eos::Error r = EOS_P2P_AcceptConnection(m_p2p.m_p2p, &options);
}

P2P定期処理

P2P::Update では有効なP2P::Linkの定期処理を行っています

コード（折りたたまれています）

void P2P::Update()
{
    for (auto& l : m_links)
    {
        l.second->Update();
    }
}

void P2P::Link::Update()
{
    auto IntervalZero = []()
    { return std::chrono::system_clock::time_point(std::chrono::system_clock::time_point::duration::zero()); };

    switch (m_state)
    {
        case STATE::INIT:
            m_state = STATE::WAKEUP;
            // 初回はすぐに動作してほしいのですぐにタイムアウトとなる時間を指定する
            m_interval_old  = IntervalZero();
            m_keepalive_old = std::chrono::system_clock::now();
            break;
        case STATE::WAKEUP:
            // 相手から反応があるまでブートコード送信を繰り返す
            // 中断する場合は、ここでタイムアウトしてロビーから切断する
            if (IsTimeout(m_interval_old, WAKE_INTERVAL))
            {
                m_interval_old = std::chrono::system_clock::now();
                puts("STATE::WAKEUP");

                m_p2p.Wake(m_product_id);

                if (m_p2p.GetEstablished(m_product_id) >= ESTABLISHED_LEVEL::WAKEUP)
                {
                    // 接続が確立したので、通信監視へ
                    m_state = STATE::WAKEUP_ACK;

                    m_interval_old = IntervalZero();
                }
            }

            // タイムアウト判定、ここはちょっと長めの判定をしたほうがいいのかもしれません
            assert(!IsTimeout(m_keepalive_old, PREWAKE_KEEPALIVE));
            break;
        case STATE::WAKEUP_ACK:
            // 相手から反応があるまで２度目のブートコード送信を繰り返す
            // 中断する場合は、ここでタイムアウトしてロビーから切断する
            if (IsTimeout(m_interval_old, WAKE_INTERVAL))
            {
                m_interval_old = std::chrono::system_clock::now();
                puts("STATE::WAKEUP_ACK");

                m_p2p.Wake(m_product_id, true);

                if (m_p2p.GetEstablished(m_product_id) >= ESTABLISHED_LEVEL::ALREADY_WAKEUP)
                {
                    // 接続が確立したので、通信監視へ
                    m_state = STATE::KEEPALIVE;

                    m_interval_old = IntervalZero();
                }
            }

            // タイムアウト判定
            assert(!IsTimeout(m_keepalive_old, KEEPALIVE));
            break;
        case STATE::KEEPALIVE:
            // この状態はやることがとくにないので、必要に応じて監視などに利用する

            // タイムアウト判定
            assert(!IsTimeout(m_keepalive_old, KEEPALIVE));
            break;
    }
}

P2P::Linkの定点動作の役割は主に２つあり、

初動時に相互通信が確立したのを確認するための専用の通信を行う
通信確認が終わったら待機状態に入る

のふたつを行います（Link::Update()の部分になります）

最初に相互通信の確立確認を行っているのは、相手側が通信を受け入れるまで通信が行われず、
到達したか不明瞭な状態となってしまうため、これを防ぐ目的です

このタイミングはRUDPでも届かないようなので、儀式だと思ってやっておきましょう。

コード（折りたたまれています）

/// @brief 初回接続確立までのダミーパケットを送信する
/// @param user_id 送信先
/// @param is_ack 最初はfalse、trueには相手からの応答があった後に切り替える
void P2P::Wake(EOS_ProductUserId user_id, bool is_ack = false)
{
    puts(__func__);

    Head head = {};

    head.m_no = (++m_packet_no);

    head.established_level = is_ack ? ESTABLISHED_LEVEL::ALREADY_WAKEUP : ESTABLISHED_LEVEL::WAKEUP;
    Send(user_id, &head, sizeof(head), EOS_EPacketReliability::EOS_PR_ReliableOrdered);
}
/// @brief user_id に対してパケットを送信する
/// @param user_id 送信先ID
void P2P::Send(EOS_ProductUserId      user_id,
          const void*            mem,
          uint32_t               len,
          EOS_EPacketReliability reliability = EOS_EPacketReliability::EOS_PR_UnreliableUnordered)
{
    if (!m_local_user_id.IsValid())
    {
        return;
    }

    EOS_P2P_SendPacketOptions options = {};

    options.ApiVersion            = EOS_P2P_SENDPACKET_API_LATEST;
    options.LocalUserId           = m_local_user_id;
    options.RemoteUserId          = user_id;
    options.SocketId              = &m_socket_id;
    options.bAllowDelayedDelivery = EOS_FALSE;
    options.Channel               = 0;
    options.Reliability           = reliability;

    options.DataLengthBytes = len;
    options.Data            = mem;

    eos::Error r = EOS_P2P_SendPacket(m_p2p, &options);
    assert(r.IsSuccess());
}

接続が確立した後は、定期的に通信を行い接続が継続していることを確認しておきます

ホスティング側の動作ログ（折りたたまれています）

Initialize
Authorize
Connect
LobbyCreate
LobbySetAttributes
wait(break ctrl+c)
EOS_LMS_JOINED
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
Keepalive
received 00022d5ff:12:12
Keepalive
received 00022d5ff:13:12
Keepalive
received 00022d5ff:14:12
STATE::WAKEUP
Wake
Keepalive
received 00022d5ff:15:12
STATE::WAKEUP_ACK
Wake
Keepalive
received 00022d5ff:16:12
STATE::WAKEUP_ACK
Wake
Keepalive
received 00022d5ff:17:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:18:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:19:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:20:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:21:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:22:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:23:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:24:12
KEEPALIVE(POST)
Keepalive
received 00022d5ff:25:12
EOS_LMS_LEFT

マッチング参加者側（eos_console_test_join）

参加するべきロビーを特定する

EOSを初期化、DevAuthTool経由で"JOIN"という名前で認証します
次に参加するロビーを探すのですが、EOS_EComparisonOp::EOS_CO_DISTANCEを使い、
一番新しいもの順にソートして、0番目のロビーへ参加するようにしてあります、

コード（折りたたまれています）

{
    auto search = eos.LobbySearchCreate(5);

    EOS_Lobby_AttributeData attr;

    search->AddParameter(EOS::MakeAttribute(attr, "now", std::numeric_limits<int64_t>::max()),
                         EOS_EComparisonOp::EOS_CO_DISTANCE);
    eos.LobbySearchExecute(search);

    search->ResultDump();

    assert(0 < search->GetSearchResultCount());

    eos::Handle<EOS_HLobbyDetails> details_handle;
    search->GetDetail(0, details_handle);

    lobbies.push_back(eos.LobbyJoin(details_handle));
}

既に参加しているユーザーを登録する

参加時にすでに参加済みのユーザーに対して P2P::OnJoined() を行い、「P2P::Link」を作成します

コード（折りたたまれています）

Lobby::Lobby() {
    {
        auto GetDetails = [](EOS_HLobby lobby, EOS_LobbyId id, EOS_ProductUserId local_id)
        {
            EOS_Lobby_CopyLobbyDetailsHandleOptions options;
            options.ApiVersion  = EOS_LOBBY_COPYLOBBYDETAILSHANDLE_API_LATEST;
            options.LobbyId     = id;
            options.LocalUserId = local_id;

            EOS_HLobbyDetails details;

            eos::Error r = EOS_Lobby_CopyLobbyDetailsHandle(lobby, &options, &details);
            assert(r.IsSuccess());

            return eos::Handle<EOS_LobbyDetailsHandle*>(details, EOS_LobbyDetails_Release);
        };

        auto details = GetDetails(lobby, id, m_eos.m_local_user_id);

        auto GetMemberCount = [](eos::Handle<EOS_LobbyDetailsHandle*> details)
        {
            EOS_LobbyDetails_GetMemberCountOptions count_options;
            count_options.ApiVersion = EOS_LOBBYDETAILS_GETMEMBERCOUNT_API_LATEST;

            return EOS_LobbyDetails_GetMemberCount(details, &count_options);
        };
        auto GetMemberId = [](eos::Handle<EOS_LobbyDetailsHandle*> details, uint32_t index)
        {
            EOS_LobbyDetails_GetMemberByIndexOptions options;
            options.ApiVersion  = EOS_LOBBYDETAILS_GETMEMBERBYINDEX_API_LATEST;
            options.MemberIndex = index;

            return eos::EpicAccount<EOS_ProductUserId>(EOS_LobbyDetails_GetMemberByIndex(details, &options));
        };

        // 初期からいるものを参加済みに登録する
        for (uint32_t i = 0; i < GetMemberCount(details); i++)
        {
            auto member_id = GetMemberId(details, i);

            // 自分はリンクには登録しないようにする
            if (member_id == m_eos.m_local_user_id)
            {
                continue;
            }

            m_p2p.OnJoined(member_id);
        }
    }
}

P2P定期処理

この後は、ホストの動作とほぼ同じ流れでの処理が行われます
双方で、EOS_P2P_AcceptConnectionを行い、相互に通信を開始することで相互通信が確立できます。

参加側の動作ログ（折りたたまれています）

  Initialize
Authorize
Connect
wait(10000ms)(break ctrl+c)
search 1
index:0[
 NOW 1703125307976
 TEST 1
]
LobbyJoin
wait
wait(45000ms)(break ctrl+c)
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
STATE::WAKEUP
Wake
Keepalive
received 00024b70:17:12
STATE::WAKEUP
Wake
Keepalive
received 00024b70:18:12
STATE::WAKEUP_ACK
Wake
Keepalive
received 00024b70:19:12
KEEPALIVE(POST)
Keepalive
received 00024b70:20:12
KEEPALIVE(POST)
Keepalive
received 00024b70:21:12
KEEPALIVE(POST)
Keepalive
received 00024b70:22:12
KEEPALIVE(POST)
Keepalive
received 00024b70:23:12
KEEPALIVE(POST)
Keepalive
received 00024b70:24:12
KEEPALIVE(POST)
Keepalive
received 00024b70:25:12
KEEPALIVE(POST)
Keepalive
received 00024b70:26:12
KEEPALIVE(POST)
Keepalive
received 00024b70:27:12
LobbyLeave
KEEPALIVE(POST)
Hello World!

最後に

Epic Online Servicesはかなり便利なオンラインサービスなのですが、
資料や採用例の情報が少なく、少しだけでも貢献できればと考え記事と動作するサンプルコードを書いてみました。
読んでいただいた方のなんらかの助力になれば幸いです。