AM Daemon ライブラリリファレンス
公開メンバ関数 | 全メンバ一覧
amdaemon::NetworkProperty クラス

ネットワーク設定情報を提供するクラス。 [詳解]

#include <NetworkProperty.h>

公開メンバ関数

 NetworkProperty (InnerIndexHolder)
 コンストラクタ。 [詳解]
 
bool valid () const
 有効なネットワーク設定情報を保持しているか否かを取得する。 [詳解]
 
bool isDhcpEnabled () const
 DHCPが有効であるか否かを取得する。 [詳解]
 
::amdaemon::util::IpAddress getAddress () const
 実行環境のIPアドレス値を取得する。 [詳解]
 
::amdaemon::util::IpAddress getSubnetMask () const
 実行環境のサブネットマスク値を取得する。 [詳解]
 
::amdaemon::util::IpAddress getGateway () const
 実行環境のゲートウェイ値を取得する。 [詳解]
 
::amdaemon::util::IpAddress getPrimaryDns () const
 実行環境のプライマリDNS値を取得する。 [詳解]
 
::amdaemon::util::IpAddress getSecondaryDns () const
 実行環境のセカンダリDNS値を取得する。 [詳解]
 

詳解

ネットワーク設定情報を提供するクラス。

参照
Network

このクラスのインスタンスをアプリ側で直接生成することはできない。 Network クラスのメンバ関数 Network::getProperty から取得すること。

メンバ関数 valid が false を返す場合、他のメンバ関数が返す値を信用してはならない。

構築子と解体子

amdaemon::NetworkProperty::NetworkProperty ( InnerIndexHolder  )
explicit

コンストラクタ。

覚え書き
アプリ側からは利用できない。

関数詳解

bool amdaemon::NetworkProperty::valid ( ) const

有効なネットワーク設定情報を保持しているか否かを取得する。

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

DHCPが有効であるか否かを取得する。

戻り値
trueDHCPが有効である場合。
falseDHCPが無効であるか、情報未取得である場合。

メンバ関数 valid が true を返すと情報を取得できるようになる。

::amdaemon::util::IpAddress amdaemon::NetworkProperty::getAddress ( ) const

実行環境のIPアドレス値を取得する。

戻り値
IPアドレス値。情報未取得である場合はゼロ値。

メンバ関数 valid が true を返すと情報を取得できるようになる。

::amdaemon::util::IpAddress amdaemon::NetworkProperty::getSubnetMask ( ) const

実行環境のサブネットマスク値を取得する。

戻り値
サブネットマスク値。情報未取得である場合はゼロ値。

メンバ関数 valid が true を返すと情報を取得できるようになる。

::amdaemon::util::IpAddress amdaemon::NetworkProperty::getGateway ( ) const

実行環境のゲートウェイ値を取得する。

戻り値
ゲートウェイ値。設定されていないか情報未取得である場合はゼロ値。

メンバ関数 valid が true を返すと情報を取得できるようになる。

::amdaemon::util::IpAddress amdaemon::NetworkProperty::getPrimaryDns ( ) const

実行環境のプライマリDNS値を取得する。

戻り値
プライマリDNS値。設定されていないか情報未取得である場合はゼロ値。

メンバ関数 valid が true を返すと情報を取得できるようになる。

::amdaemon::util::IpAddress amdaemon::NetworkProperty::getSecondaryDns ( ) const

実行環境のセカンダリDNS値を取得する。

戻り値
セカンダリDNS値。設定されていないか情報未取得である場合はゼロ値。

メンバ関数 valid が true を返すと情報を取得できるようになる。


このクラス詳解は次のファイルから抽出されました: