DnsResolver.h

[詳解]

/// @file
/// @brief ドメイン名のIPv4名前解決を非同期で行うクラス DnsResolver のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_DNSRESOLVER_H
#define AMDAEMON_UTIL_DNSRESOLVER_H

#include "amdaemon/env.h"
#include "amdaemon/util/IpAddress.h"

#include <memory>

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

    /// ドメイン名のIPv4名前解決を非同期で行うクラス。
    class DnsResolver
    {
    public:
        /// @brief コンストラクタ。
        ///
        /// 無効なインスタンスとして初期化する。
        /// 他のインスタンスのコピー先変数を予め宣言しておく場合等に用いられる。
        DnsResolver();

        /// @brief コンストラクタ。
        /// @param[in] name ドメイン名。
        ///
        /// @exception Exception
        /// - 引数 name に nullptr を指定した場合。
        /// - 非同期処理の開始に失敗した場合。
        ///
        /// インスタンス構築と同時に名前解決処理を開始する。
        DnsResolver(const wchar_t* name);

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

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

        /// デストラクタ。
        ~DnsResolver();

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

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

        /// @brief 名前解決対象のドメイン名を取得する。
        /// @return 名前解決対象のドメイン名。無効なインスタンスならば空文字列。
        const wchar_t* getName() const;

        /// @brief 有効なインスタンスであるか否かを取得する。
        /// @retval true  有効なインスタンスである場合。
        /// @retval false 無効なインスタンスである場合。
        bool valid() const;

        /// @brief 名前解決処理の完了まで待機する。
        /// @retval true  処理が成功した場合。
        /// @retval false 処理が失敗したか、無効なインスタンスである場合。
        bool sync() const;

        /// @brief 名前解決処理が完了したか否かを取得する。
        /// @retval true  完了した場合。
        /// @retval false 未完了であるか、無効なインスタンスである場合。
        bool isDone() const;

        /// @brief 名前解決処理が成功したか否かを取得する。
        /// @retval true  成功した場合。
        /// @retval false 失敗したか、未完了である場合。
        bool isSucceeded() const;

        /// @brief 名前解決結果のIPアドレス値を取得する。
        /// @return IPアドレス値。名前解決に成功していない場合は IpAddress::zero() 。
        IpAddress getAddress() const;

    private:
        struct Data;

        /// 内部データ。
        std::shared_ptr<Data> _data;
    };

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

#endif // AMDAEMON_UTIL_DNSRESOLVER_H