WinsockScope.h

[詳解]

/// @file
/// @brief Winsockの初期化と解放を行うRAIIクラス WinsockScope のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_WINSOCKSCOPE_H
#define AMDAEMON_UTIL_WINSOCKSCOPE_H

#include "amdaemon/env.h"

namespace amdaemon
{
namespace util
{
/// @addtogroup g_util
/// @{

    /// @brief Winsockの初期化と解放を行うRAIIクラス。
    ///
    /// コンストラクタで Windows API 関数 WSAStartup を呼び出し、
    /// デストラクタで Windows API 関数 WSACleanup を呼び出す。
    /// これらの Windows API 関数は内部で参照カウンタを保持しているため、
    /// このクラスのインスタンスを入れ子になった関数等で定義しても問題ない。
    ///
    /// 非Windows環境では何も行わない。
    class WinsockScope
    {
    private:
        // safe bool イディオム
        typedef void (WinsockScope::*bool_type)() const;
        void bool_type_func() const { }

    public:
        /// @brief コンストラクタ。
        /// @param[in] major 要求するメジャーバージョン番号。既定値は 2 。
        /// @param[in] minor 要求するマイナーバージョン番号。既定値は 0 。
        ///
        /// Windows環境であれば Windows API 関数 WSAStartup を呼び出す。
        /// 処理の成否はメンバ関数 valid で取得できる。
        WinsockScope(int major = 2, int minor = 0);

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

        /// @brief デストラクタ。
        ///
        /// Windows環境であり、コンストラクタの処理に成功しており、
        /// かつムーブされていなければ Windows API 関数 WSACleanup を呼び出す。
        ‾WinsockScope();

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

        /// @brief コンストラクタ処理の成否を取得する。
        /// @retval true  成功したか、非Windows環境である場合。
        /// @retval false 失敗した場合。
        bool valid() const
        {
            return (getErrorCode() == 0);
        }

        /// @brief  Windows API 関数 WSAStartup の戻り値を取得する。
        /// @return  Windows API 関数 WSAStartup の戻り値。非Windows環境では常に 0 。
        int getErrorCode() const
        {
            return _errorCode;
        }

        /// @brief コンストラクタ処理の成否を表す真偽値相当の値への型変換関数。
        /// @return メンバ関数 valid の戻り値と同等の値。
        /// @note
        /// ライブラリ実装メモ:
        /// VC++2012 は explicit operator をサポートしていないため、
        /// safe bool イディオムを用いている。
        operator bool_type() const
        {
            return valid() ? &WinsockScope::bool_type_func : nullptr;
        }

    private:
        int _errorCode; ///<  Windows API 関数 WSAStartup の戻り値。
        bool _cleanup;  ///<  Windows API 関数 WSACleanup を呼び出すべきならば true 。

    private:
        // コピー禁止
        WinsockScope(const WinsockScope&);              // 宣言のみ
        WinsockScope& operator=(const WinsockScope&);   // 宣言のみ
    };

/// @}
} // namespace util
} // namespace amdaemon

#endif // AMDAEMON_UTIL_WINSOCKSCOPE_H