AccountingHandle.h

[詳解]

/// @file
/// @brief ALL.Net課金プレイを識別するためのハンドル構造体 AccountingHandle のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ALLNET_ACCOUNTINGHANDLE_H
#define AMDAEMON_ALLNET_ACCOUNTINGHANDLE_H

#include "amdaemon/env.h"

#include <cstdint>

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

    //--------------------
    // AccountingHandle 構造体定義
    //--------------------

    /// @brief ALL.Net課金プレイを識別するためのハンドル構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct AccountingHandle
    {
        /// 内部値の表現型。
        typedef std::uint32_t value_type;

        /// 内部値。 0 は無効値。
        value_type value;

        /// @brief ハンドル値を作成する。
        /// @param[in] value 内部値。 0 は無効値。
        /// @return 作成されたハンドル値。
        static AccountingHandle make(value_type value)
        {
            AccountingHandle result = { value };
            return result;
        }

        /// @brief 内部値 0 の無効なハンドル値を作成する。
        /// @return 内部値 0 の無効なハンドル値。
        static AccountingHandle zero()
        {
            return make(0);
        }

        /// @brief 有効な値であるか否かを取得する。
        /// @retval true  有効な値である場合。
        /// @retval false 無効な値である場合。
        ///
        /// 内部値が 0 でなければ true を返す。
        bool valid() const
        {
            return (value != 0);
        }
    };

/// @}

    //--------------------
    // インライン関数定義
    //--------------------

    /// @brief 等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator==(const AccountingHandle& l, const AccountingHandle& r)
    {
        return (l.value == r.value);
    }

    /// @brief 非等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator!=(const AccountingHandle& l, const AccountingHandle& r)
    {
        return !(l == r);
    }

    /// @brief 小なり比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator<(const AccountingHandle& l, const AccountingHandle& r)
    {
        return (l.value < r.value);
    }

    /// @brief 大なり比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator>(const AccountingHandle& l, const AccountingHandle& r)
    {
        return (r < l);
    }

    /// @brief 小なり等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator<=(const AccountingHandle& l, const AccountingHandle& r)
    {
        return !(r < l);
    }

    /// @brief 大なり等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso AccountingHandle
    inline bool operator>=(const AccountingHandle& l, const AccountingHandle& r)
    {
        return !(l < r);
    }
} // namespace allnet
} // namespace amdaemon

namespace std
{
    // 前方宣言
    template<class T> struct hash;

    /// @brief ハッシュ値を求めるファンクタ構造体。
    ///
    /// std::hash クラステンプレートの
    /// amdaemon::allnet::AccountingHandle 構造体に対する特殊化。
    template<>
    struct hash< ::amdaemon::allnet::AccountingHandle >
    {
        /// 戻り値の型。
        typedef size_t result_type;

        /// 引数の型。
        typedef ::amdaemon::allnet::AccountingHandle argument_type;

        /// @brief 引数のハッシュ値を取得する。
        /// @param[in] handle 引数。
        /// @return ハッシュ値。
        result_type operator()(argument_type handle) const
        {
            return static_cast<result_type>(handle.value);
        }
    };
} // namespace std

#endif // AMDAEMON_ALLNET_ACCOUNTINGHANDLE_H