Accounting.h

[詳解]

/// @file
/// @brief ALL.Net課金処理を提供するMonostateクラス Accounting のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ALLNET_ACCOUNTING_H
#define AMDAEMON_ALLNET_ACCOUNTING_H

#include "amdaemon/env.h"
#include "amdaemon/allnet/AccountingUnit.h"
#include "amdaemon/allnet/AccountingMode.h"
#include "amdaemon/allnet/AccountingPlayCountMonth.h"
#include "amdaemon/allnet/AccountingPlayCountItem.h"
#include "amdaemon/util/TimeSpan.h"
#include "amdaemon/util/DateTime.h"
#include "amdaemon/util/container.h"

#include <functional>
#include <vector>
#include <cstddef>

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

    /// @brief ALL.Net課金処理を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// @ingroup g_common
    class Accounting
    {
    public:
        // 下記は暗黙の定義を用いる。
        //Accounting() = default;
        //‾Accounting() = default;
        //Accounting(const Accounting&) = default;
        //Accounting& operator=(const Accounting&) = default;

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

        /// @brief 課金モードを取得する。
        /// @return 課金モード。課金機能が無効である場合は AccountingMode::None 。
        ///
        /// 通常はDaemonプロセスの設定ファイルで指定した課金モードを返す。
        /// ただしキーチップのALL.Net課金フラグが無効である場合は AccountingMode::None を返す。
        AccountingMode getMode() const;

        /// @brief 課金プレイ可能な状態であるか否かを取得する。
        /// @retval true  課金プレイ可能な状態である場合。
        /// @retval false 課金プレイ不可能な状態である場合。
        ///
        /// 下記のいずれかであれば false を返す。
        ///
        /// - 課金機能が無効である場合。
        /// - 初回締め処理が完了していない場合。
        /// - 初回/定時締め処理中である場合。
        /// - 課金モードB1であり、かつALL.Net認証に成功していない場合。
        /// - ALL.Net関連の進行停止エラーが発生している場合。
        bool isPlayable() const;

        /// @brief 初回/定時締め処理中であるか否かを取得する。
        /// @retval true  初回/定時締め処理中である場合。
        /// @retval false 初回/定時締め処理中ではないか、課金機能が無効である場合。
        ///
        /// 条件式 getSpanUntilReport().isZero() の結果を返す。
        bool isReporting() const
        {
            return this->getSpanUntilReport().isZero();
        }

        /// @brief 次回の定時締め処理までの残り時間を取得する。
        /// @return 次回の定時締め処理までの残り時間。
        ///
        /// 初回/定時締め処理中ならば util::TimeSpan::zero() を返す。
        ///
        /// 課金機能が無効である場合等、現在の状態では初回/定時締め処理を行えない場合は
        /// util::TimeSpan::max() を返す。
        const ::amdaemon::util::TimeSpan& getSpanUntilReport() const;

        /// @brief 課金プレイ回数集計アイテムを取得する。
        /// @param[in] month 集計月種別。
        /// @return 課金プレイ回数集計アイテム。
        ///
        /// @exception Exception
        /// 引数 month に不正な値を指定した場合。
        ///
        /// まだ課金サーバに情報が登録されていない場合等には無効な情報を返す。
        /// 取得した値のメンバ関数 AccountingPlayCountItem#valid によって
        /// 情報が有効であるか否かを調べることができる。
        ///
        /// 稼働開始から2カ月以下の場合であっても、
        /// 今月の情報が有効であるならば先月および先々月の情報も有効となる。
        /// その際、先月および先々月の課金プレイ回数は 0 となっている。
        /// アプリ側では、取得した情報をそのまま表示してしまって構わない。
        const AccountingPlayCountItem& getPlayCountItem(
            AccountingPlayCountMonth month) const;

        /// @brief 直近の初回/定時締め処理成功日時を取得する。
        /// @return
        ///     直近の初回/定時締め処理成功日時。
        ///     情報が存在しない場合や課金機能が無効である場合は util::DateTime::min() 。
        const ::amdaemon::util::DateTime& getReportTime() const;

        /// @brief 直近の日中締め処理成功日時を取得する。
        /// @return
        ///     直近の日中締め処理成功日時。
        ///     情報が存在しない場合や課金機能が無効である場合は util::DateTime::min() 。
        const ::amdaemon::util::DateTime& getBackgroundReportTime() const;

        /// @brief ログフル状態であるか否かを取得する。
        /// @retval true  ログフル状態である場合。
        /// @retval false ログフル状態ではないか、課金機能が無効である場合。
        bool isLogFull() const;

        /// @brief ニアフル警告チェックを行うか否かを取得する。
        /// @retval true  チェックを行う場合。
        /// @retval false チェックを行わないか、課金機能が無効である場合。
        bool isNearFullEnabled() const;

        /// @brief ニアフル警告チェックを行うか否かを設定する。
        /// @param[in] enabled 行うならば true 。行わないならば false 。
        /// @retval true  設定変更できた場合。
        /// @retval false 設定変更できなかったか、課金機能が無効である場合。
        ///
        /// Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。
        bool setNearFullEnabled(bool enabled);

        /// @brief 課金処理対象となるプレイヤー数を取得する。
        /// @return 課金処理対象となるプレイヤー数。課金機能が無効ならば 0 。
        /// @see Core#getPlayerCount
        ///
        /// 課金機能が有効ならば、 Core#getPlayerCount と同じ値を返す。
        std::size_t getPlayerCount() const;

        /// @brief プレイヤーの課金処理インスタンスを取得する。
        /// @param[in] playerIndex プレイヤーインデックス。
        /// @return プレイヤーの課金処理インスタンス。
        /// @see Player
        ///
        /// @exception Exception
        /// - 課金機能が無効である場合。
        /// - 引数 playerIndex にプレイヤー数以上の値を指定した場合。
        ///   プレイヤー数はメンバ関数 #getPlayerCount で取得できる。
        AccountingUnit& getPlayer(std::size_t playerIndex);

        /// @copydoc getPlayer
        const AccountingUnit& getPlayer(std::size_t playerIndex) const;

        /// @brief プレイヤーの課金処理インスタンス配列を取得する。
        /// @return プレイヤーの課金処理インスタンス配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - プレイヤー数を知りたいだけならばメンバ関数 #getPlayerCount を用いること。
        /// - 特定プレイヤーの課金処理インスタンスを取得したいだけならばメンバ関数
        ///   #getPlayer を用いること。
        std::vector<std::reference_wrapper<AccountingUnit>> getPlayers()
        {
            return
                ::amdaemon::util::toContainer<decltype(this->getPlayers())>(
                    this->getPlayerCount(),
                    [this](std::size_t i) -> AccountingUnit& { return this->getPlayer(i); });
        }

        /// @copydoc getPlayers
        std::vector<std::reference_wrapper<const AccountingUnit>>
        getPlayers() const
        {
            return
                ::amdaemon::util::toContainer<decltype(this->getPlayers())>(
                    this->getPlayerCount(),
                    [this](std::size_t i) -> const AccountingUnit&
                    {
                        return this->getPlayer(i);
                    });
        }
    };

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

#endif // AMDAEMON_ALLNET_ACCOUNTING_H