NetDeliveryProgress.h

[詳解]

/// @file
/// @brief NET配信進捗情報構造体 NetDeliveryProgress のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETDELIVERYPROGRESS_H
#define AMDAEMON_NETDELIVERYPROGRESS_H

#include "amdaemon/env.h"

#include <cstdint>

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

    /// @brief NET配信進捗情報構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct NetDeliveryProgress
    {
        std::uint32_t total;    ///< 総項目数。
        std::uint32_t current;  ///< ダウンロード済み項目数。

        /// @brief 進捗を 0 以上 100 以下のパーセント値で取得する。
        /// @return 進捗パーセント値。総項目数が 0 の場合は 0 。
        float toPercentage() const
        {
            return (total == 0) ? 0.0f : static_cast<float>(current * 100.0 / total);
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETDELIVERYPROGRESS_H