NetworkProperty.h

[詳解]

/// @file
/// @brief ネットワーク設定情報を提供するクラス NetworkProperty のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETWORKPROPERTY_H
#define AMDAEMON_NETWORKPROPERTY_H

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

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

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief ネットワーク設定情報を提供するクラス。
    /// @see Network
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// Network クラスのメンバ関数 Network#getProperty から取得すること。
    ///
    /// メンバ関数 #valid が false を返す場合、他のメンバ関数が返す値を信用してはならない。
    class NetworkProperty
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit NetworkProperty(InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾NetworkProperty() = default;

        /// @brief 有効なネットワーク設定情報を保持しているか否かを取得する。
        /// @retval true  保持している場合。
        /// @retval false 保持していないか、情報未取得である場合。
        ///
        /// - Daemonプロセスがテスト項目 "IP ADDRESS" にてネットワーク設定情報取得を行うと
        ///   true を返すようになる。
        ///     - リンクアップするまでは情報を取得できないため false を返す。
        ///     - テスト項目 "IP ADDRESS" 自体の成否は問わない。
        /// - この関数が false を返す場合、他のメンバ関数が返す値を信用してはならない。
        /// - 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを
        ///   開始するまで false に戻ることはない。
        bool valid() const;

        /// @brief DHCPが有効であるか否かを取得する。
        /// @retval true  DHCPが有効である場合。
        /// @retval false DHCPが無効であるか、情報未取得である場合。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        bool isDhcpEnabled() const;

        /// @brief 実行環境のIPアドレス値を取得する。
        /// @return IPアドレス値。情報未取得である場合はゼロ値。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        ::amdaemon::util::IpAddress getAddress() const;

        /// @brief 実行環境のサブネットマスク値を取得する。
        /// @return サブネットマスク値。情報未取得である場合はゼロ値。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        ::amdaemon::util::IpAddress getSubnetMask() const;

        /// @brief 実行環境のゲートウェイ値を取得する。
        /// @return ゲートウェイ値。設定されていないか情報未取得である場合はゼロ値。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        ::amdaemon::util::IpAddress getGateway() const;

        /// @brief 実行環境のプライマリDNS値を取得する。
        /// @return プライマリDNS値。設定されていないか情報未取得である場合はゼロ値。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        ::amdaemon::util::IpAddress getPrimaryDns() const;

        /// @brief 実行環境のセカンダリDNS値を取得する。
        /// @return セカンダリDNS値。設定されていないか情報未取得である場合はゼロ値。
        ///
        /// メンバ関数 #valid が true を返すと情報を取得できるようになる。
        ::amdaemon::util::IpAddress getSecondaryDns() const;

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETWORKPROPERTY_H