Network.h

[詳解]

/// @file
/// @brief ネットワーク関連処理を提供するMonostateクラス Network のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETWORK_H
#define AMDAEMON_NETWORK_H

#include "amdaemon/env.h"
#include "amdaemon/NetworkProperty.h"
#include "amdaemon/NetworkTestInfo.h"

namespace amdaemon
{
/// @addtogroup g_network
/// @{

    /// @brief ネットワーク関連処理を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    /// 一部の関数は処理完了まで呼び出し元スレッドをブロックする。
    ///
    /// @par アプリ固有の通信処理を行う場合の注意
    /// - アプリ固有のLAN通信処理(サーバ機とサテライト機との通信等)を行う場合、
    ///   メンバ関数 #isLanAvailable が true を返すまでは処理を行ってはならない。
    /// - アプリ固有の店内LAN通信処理(メダルバンク通信等)を行う場合、
    ///   メンバ関数 #isLocationLanAvailable が true を返すまでは処理を行ってはならない。
    /// - アプリ固有のWAN通信処理(タイトルサーバとの通信等)を行う場合、
    ///   メンバ関数 #isWanAvailable が true を返すまでは処理を行ってはならない。
    ///     - ただしALL.Net非対応タイトルの場合はその限りではない。
    ///
    /// @ingroup g_common
    class Network
    {
    public:
        // 下記は暗黙の定義を用いる。
        //Network() = default;
        //‾Network() = default;
        //Network(const Network&) = default;
        //Network& operator=(const Network&) = default;

        /// @brief ネットワーク機能を利用可能であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 機能が無効である場合。
        bool isAvailable() const;

    public:
        // ネットワーク状態

        /// @brief LANを利用可能な状態であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 利用不可能であるか、ネットワーク機能が無効である場合。
        ///
        /// - Daemonプロセスがテスト項目 "IP ADDRESS" に成功すると true を返すようになる。
        ///     - ただし店舗ルータ直下で動作する設定の場合は常に false を返す。
        /// - この関数が true を返す前にアプリ固有のLAN通信処理を行ってはならない。
        /// - 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを
        ///   開始するまで false に戻ることはない。
        bool isLanAvailable() const;

        /// @brief 店内LANを利用可能な状態であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 利用不可能であるか、ネットワーク機能が無効である場合。
        ///
        /// - Daemonプロセスがテスト項目 "HOPS" に成功すると true を返すようになる。
        /// - この関数が true を返す前にアプリ固有の店内LAN通信処理を行ってはならない。
        /// - 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを
        ///   開始するまで false に戻ることはない。
        bool isLocationLanAvailable() const;

        /// @brief WANを利用可能な状態であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 利用不可能であるか、ネットワーク機能が無効である場合。
        ///
        /// - ALL.Net対応タイトルの場合、Daemonプロセスがテスト項目
        ///   "ALL.Net AUTHENTICATION" に成功すると true を返すようになる。
        /// - ALL.Net非対応タイトルの場合は常に false を返す。
        ///     - ALL.Net非対応だがWANを利用するタイトルでは独自に "DNS(WAN)" 相当の
        ///       ネットワークテストを実施する必要がある。
        /// - この関数が true を返す前にアプリ固有のWAN通信処理を行ってはならない。
        ///     - ただしALL.Net非対応タイトルの場合はその限りではない。
        /// - 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを
        ///   開始するまで false に戻ることはない。
        bool isWanAvailable() const;

    public:
        // ネットワーク設定情報

        /// @brief ネットワーク設定情報を取得する。
        /// @return ネットワーク設定情報。
        const NetworkProperty& getProperty() const;

    public:
        // テスト

        /// @brief パワーオンセルフテスト情報を取得する。
        /// @return パワーオンセルフテスト情報。
        /// @see NetworkTestInfo
        ///
        /// 各情報の詳細は NetworkTestInfo クラスの説明を参照すること。
        const NetworkTestInfo& getPowerOnTestInfo() const;

        /// @brief ネットワークテストを開始可能な状態であるか否かを取得する。
        /// @retval true  開始可能な状態である場合。
        /// @retval false 開始不可能な状態である場合。
        /// @see Sequence
        ///
        /// ネットワーク機能が有効かつ現在ゲームテストモード中であれば true を返す。
        /// ゲームテストモード状態の管理は Sequence クラスで行える。
        bool canStartTest() const;

        /// @brief ネットワークテストを開始する。
        /// @retval true  開始成功した場合。
        /// @retval false 開始失敗した場合。
        ///
        /// メンバ関数 #canStartTest が false を返す場合は何もせずに false を返す。
        /// 既にネットワークテストを実施中である場合はリスタートする。
        ///
        /// メンバ関数 #canStartTest が true を返す場合であっても、
        /// Daemonプロセス側の状態等によっては開始できない場合がある。
        /// そのため、必ず戻り値をチェックすること。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool startTest();

        /// @brief ネットワークテスト情報を取得する。
        /// @return ネットワークテスト情報。
        /// @see NetworkTestInfo
        ///
        /// 各情報の詳細は NetworkTestInfo クラスの説明を参照すること。
        const NetworkTestInfo& getTestInfo() const;
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETWORK_H