NetDeliveryStatus.h

[詳解]

/// @file
/// @brief NET配信ステータス列挙 NetDeliveryStatus のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETDELIVERYSTATUS_H
#define AMDAEMON_NETDELIVERYSTATUS_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_netdelivery
/// @{

    /// @brief NET配信ステータス列挙。
    ///
    /// 関数 toString(NetDeliveryStatus, bool) によって文字列表現値を取得できる。
    enum class NetDeliveryStatus
    {
        Unknown = 0,    ///< 不明。ダウンロード対象が存在しない場合など。
        Error,          ///< 内部エラー。自動復旧不可。
        NotStart,       ///< ダウンロード開始前。
        Download,       ///< ダウンロード中。
        Complete,       ///< ダウンロード完了。
        UpdateReady,    ///< 公開可能。
        UpToDate,       ///< 公開済み。
        Retry,          ///< 内部エラー。エラー原因が解消されると自動復旧する。
    };

    /// @brief @ref NetDeliveryStatus 列挙値の文字列表現値を取得する。
    /// @param[in] status @ref NetDeliveryStatus 列挙値。
    /// @param[in] japanese 日本語表現を用いるならば true 。既定値は false 。
    /// @return @ref NetDeliveryStatus 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(NetDeliveryStatus status, bool japanese = false);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETDELIVERYSTATUS_H