Auth.h

[詳解]

/// @file
/// @brief ALL.Net認証情報を提供するMonostateクラス Auth のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ALLNET_AUTH_H
#define AMDAEMON_ALLNET_AUTH_H

#include "amdaemon/env.h"
#include "amdaemon/allnet/LineType.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
namespace allnet
{
/// @addtogroup g_allnet
/// @{

    /// @brief ALL.Net認証情報を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// 取得した認証レスポンスを画面表示する際は、
    /// ALL.Net Programmer's Manual の「ゲーム画面に表示する際の注意事項」を確認すること。
    ///
    /// @ingroup g_common
    class Auth
    {
    public:
        /// @brief 店舗ニックネームのパート数を取得する。
        /// @return 店舗ニックネームのパート数。固定値 2 。
        static std::size_t getLocationNicknamePartCount();

        /// @brief 地域名のパート数を取得する。
        /// @return 地域名のパート数。固定値 4 。
        static std::size_t getRegionNamePartCount();

    public:
        // 下記は暗黙の定義を用いる。
        //Auth() = default;
        //‾Auth() = default;
        //Auth(const Auth&) = default;
        //Auth& operator=(const Auth&) = default;

        /// @brief ALL.Net認証機能を利用可能であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 機能が無効である場合。
        ///
        /// Daemonプロセスの設定ファイルでALL.Net認証設定を有効にしている場合であっても、
        /// キーチップのALL.Net認証フラグが無効である場合は false を返す。
        bool isAvailable() const;

        /// @brief 認証が成功済みであるか否かを取得する。
        /// @retval true  成功済みである場合。
        /// @retval false 未成功である場合。未試行の場合や認証機能が無効である場合も含む。
        bool isGood() const;

        /// @brief 開発店舗であるか否かを取得する。
        /// @retval true  開発店舗である場合。
        /// @retval false 開発店舗ではないか、認証未成功の場合。
        ///
        /// 認証が成功済みであれば有効な値を返す。
        ///
        /// ALL.Net ID を用いて判定を行っている。
        /// ALL.Net委員会の方針上、 ALL.Net ID は返さないため、
        /// ロケーションの判定には店舗IDを用いること。
        bool isDevelop() const;

        /// @brief 回線種別を取得する。
        /// @return 回線種別。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        LineType getLineType() const;

        /// @brief 認証レスポンスのゲームサーバURIを取得する。
        /// @return ゲームサーバURI。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        const wchar_t* getGameServerUri() const;

        /// @brief 認証レスポンスのゲームサーバホスト名を取得する。
        /// @return ゲームサーバホスト名。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        const wchar_t* getGameServerHost() const;

        /// @brief 認証レスポンスの店舗IDを取得する。
        /// @return 店舗ID。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        std::uint32_t getLocationId() const;

        /// @brief 認証レスポンスの店舗名を取得する。
        /// @return 店舗名。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        const wchar_t* getLocationName() const;

        /// @brief 認証レスポンスの店舗ニックネームを取得する。
        /// @param[in] partIndex パートインデックス。 0 以上パート数未満。
        /// @return 店舗ニックネーム。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// @exception Exception
        /// 引数 partIndex にパート数以上の値を指定した場合。
        /// パート数は静的メンバ関数 #getLocationNicknamePartCount で取得できる。
        ///
        /// 認証が成功済みであれば有効な値を返す。
        ///
        /// 画面表示の際は、2行で表示するか、連結して1行で表示すること。
        /// 連結する場合、間に文字を挟んではならない。(半角スペース等も不可)
        const wchar_t* getLocationNickname(std::size_t partIndex) const;

        /// @brief 認証レスポンスの地域コードを取得する。
        /// @return 地域コード。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        std::int32_t getRegionCode() const;

        /// @brief 認証レスポンスの地域名を取得する。
        /// @param[in] partIndex パートインデックス。 0 以上パート数未満。
        /// @return 地域名。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// @exception Exception
        /// 引数 partIndex にパート数以上の値を指定した場合。
        /// パート数は静的メンバ関数 #getRegionNamePartCount で取得できる。
        ///
        /// 認証が成功済みであれば有効な値を返す。
        const wchar_t* getRegionName(std::size_t partIndex) const;

        /// @brief 認証レスポンスの国コードを取得する。
        /// @return 国コード。認証未成功の場合は不定値。
        /// @see isGood
        ///
        /// 認証が成功済みであれば有効な値を返す。
        const wchar_t* getCountryCode() const;
    };

/// @}
} // namespace allnet
} // namespace amdaemon

#endif // AMDAEMON_ALLNET_AUTH_H