RequestState.h

[詳解]

/// @file
/// @brief Daemonプロセスへの処理要求状態を保持するクラス RequestState のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_REQUESTSTATE_H
#define AMDAEMON_REQUESTSTATE_H

#include "amdaemon/env.h"

#include <memory>

namespace amdaemon
{
    /// @brief Daemonプロセスへの処理要求状態を保持するクラス。
    /// @see Backup, CanTarget, Aime#sendLog
    ///
    /// このクラスの有効なインスタンスをアプリ側で直接生成することはできない。
    /// Daemonプロセスへ処理要求を行う各種関数の戻り値として取得できる。
    ///
    /// コピーおよびムーブはほぼオーバヘッド無く可能である。
    /// 内部状態はコピーしたインスタンス間で共有される。
    ///
    /// @code
    /// void func(std::vector<amdaemon::BackupRecord>& records)
    /// {
    ///     amdaemon::Backup backup;
    ///     amdaemon::RequestState state = backup.setupRecords(records);
    /// 
    ///     // ほぼオーバヘッドなくコピー可能
    ///     // temp と state は同じ処理要求状態を共有する
    ///     amdaemon::RequestState temp = state;
    /// 
    ///     // …後略…
    /// }
    /// @endcode
    class RequestState
    {
    public:
        // 内部情報構造体の前方宣言。
        struct InnerInfo;

        /// @brief コンストラクタ。
        ///
        /// 無効な処理要求状態として初期化される。
        RequestState();

        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit RequestState(const InnerInfo&);

        /// @brief コピーコンストラクタ。
        /// @param[in] src コピー元。
        RequestState(const RequestState& src);

        /// @brief ムーブコンストラクタ。
        /// @param[in] src ムーブ元。
        RequestState(RequestState&& src);

        /// デストラクタ。
        ‾RequestState();

        /// @brief コピー代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        RequestState& operator=(const RequestState& r);

        /// @brief ムーブ代入演算子のオーバロード。
        /// @param[in] r 右辺値。
        /// @return 自身の参照。
        RequestState& operator=(RequestState&& r);

        /// @brief 要求が有効であるか否かを取得する。
        /// @retval true  要求が有効である場合。
        /// @retval false 要求が無効である場合。
        bool valid() const;

        /// @brief 要求がDaemonプロセスへ送信済みであるか否かを取得する。
        /// @retval true  送信済みである場合。
        /// @retval false 未送信であるか、要求が無効である場合。
        ///
        /// 処理要求元が非同期で動作している場合、
        /// この関数が true を返してもまだ処理完了していない可能性がある。
        /// 処理完了済みか否かはメンバ関数 #isDone で取得できる。
        bool isSent() const;

        /// @brief 要求が処理完了済みであるか否かを取得する。
        /// @retval true  処理完了済みである場合。
        /// @retval false 処理未完了であるか、要求が無効である場合。
        bool isDone() const;

        /// @brief 要求が処理成功したか否かを取得する。
        /// @retval true  処理成功した場合。
        /// @retval false 処理失敗したか、処理未完了であるか、要求が無効である場合。
        ///
        /// メンバ関数 #isDone が false を返す状態の場合、この関数も必ず false を返す。
        bool isSucceeded() const;

    private:
        class Impl;

        /// pimpl インスタンス。
        std::shared_ptr<Impl> _impl;
    };
} // namespace amdaemon

#endif // AMDAEMON_REQUESTSTATE_H