NetworkTestState.h

[詳解]

/// @file
/// @brief ネットワークセルフテスト状態列挙 NetworkTestState のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETWORKTESTSTATE_H
#define AMDAEMON_NETWORKTESTSTATE_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_network
/// @{

    /// ネットワークセルフテスト状態列挙。
    enum class NetworkTestState
    {
        None = 0,   ///< 未処理。
        Busy,       ///< 処理中。
        Done,       ///< 完了済み。結果取得可能。
    };

    /// @brief @ref NetworkTestState 列挙値の文字列表現値を取得する。
    /// @param[in] state @ref NetworkTestState 列挙値。
    /// @return @ref NetworkTestState 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(NetworkTestState state);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETWORKTESTSTATE_H