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

ネットワーク関連処理を提供するMonostateクラス。 [詳解]

#include <Network.h>

公開メンバ関数

bool isAvailable () const
 ネットワーク機能を利用可能であるか否かを取得する。 [詳解]
 
bool isLanAvailable () const
 LANを利用可能な状態であるか否かを取得する。 [詳解]
 
bool isLocationLanAvailable () const
 店内LANを利用可能な状態であるか否かを取得する。 [詳解]
 
bool isWanAvailable () const
 WANを利用可能な状態であるか否かを取得する。 [詳解]
 
const NetworkPropertygetProperty () const
 ネットワーク設定情報を取得する。 [詳解]
 
const NetworkTestInfogetPowerOnTestInfo () const
 パワーオンセルフテスト情報を取得する。 [詳解]
 
bool canStartTest () const
 ネットワークテストを開始可能な状態であるか否かを取得する。 [詳解]
 
bool startTest ()
 ネットワークテストを開始する。 [詳解]
 
const NetworkTestInfogetTestInfo () const
 ネットワークテスト情報を取得する。 [詳解]
 

詳解

ネットワーク関連処理を提供するMonostateクラス。

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。 一部の関数は処理完了まで呼び出し元スレッドをブロックする。

アプリ固有の通信処理を行う場合の注意
  • アプリ固有のLAN通信処理(サーバ機とサテライト機との通信等)を行う場合、 メンバ関数 isLanAvailable が true を返すまでは処理を行ってはならない。
  • アプリ固有の店内LAN通信処理(メダルバンク通信等)を行う場合、 メンバ関数 isLocationLanAvailable が true を返すまでは処理を行ってはならない。
  • アプリ固有のWAN通信処理(タイトルサーバとの通信等)を行う場合、 メンバ関数 isWanAvailable が true を返すまでは処理を行ってはならない。
    • ただしALL.Net非対応タイトルの場合はその限りではない。

関数詳解

bool amdaemon::Network::isAvailable ( ) const

ネットワーク機能を利用可能であるか否かを取得する。

戻り値
true利用可能である場合。
false機能が無効である場合。
bool amdaemon::Network::isLanAvailable ( ) const

LANを利用可能な状態であるか否かを取得する。

戻り値
true利用可能である場合。
false利用不可能であるか、ネットワーク機能が無効である場合。
  • Daemonプロセスがテスト項目 "IP ADDRESS" に成功すると true を返すようになる。
    • ただし店舗ルータ直下で動作する設定の場合は常に false を返す。
  • この関数が true を返す前にアプリ固有のLAN通信処理を行ってはならない。
  • 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを 開始するまで false に戻ることはない。
bool amdaemon::Network::isLocationLanAvailable ( ) const

店内LANを利用可能な状態であるか否かを取得する。

戻り値
true利用可能である場合。
false利用不可能であるか、ネットワーク機能が無効である場合。
  • Daemonプロセスがテスト項目 "HOPS" に成功すると true を返すようになる。
  • この関数が true を返す前にアプリ固有の店内LAN通信処理を行ってはならない。
  • 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを 開始するまで false に戻ることはない。
bool amdaemon::Network::isWanAvailable ( ) const

WANを利用可能な状態であるか否かを取得する。

戻り値
true利用可能である場合。
false利用不可能であるか、ネットワーク機能が無効である場合。
  • ALL.Net対応タイトルの場合、Daemonプロセスがテスト項目 "ALL.Net AUTHENTICATION" に成功すると true を返すようになる。
  • ALL.Net非対応タイトルの場合は常に false を返す。
    • ALL.Net非対応だがWANを利用するタイトルでは独自に "DNS(WAN)" 相当の ネットワークテストを実施する必要がある。
  • この関数が true を返す前にアプリ固有のWAN通信処理を行ってはならない。
    • ただしALL.Net非対応タイトルの場合はその限りではない。
  • 一度 true を返した後は再度パワーオンセルフテストまたはネットワークテストを 開始するまで false に戻ることはない。
const NetworkProperty& amdaemon::Network::getProperty ( ) const

ネットワーク設定情報を取得する。

戻り値
ネットワーク設定情報。
const NetworkTestInfo& amdaemon::Network::getPowerOnTestInfo ( ) const

パワーオンセルフテスト情報を取得する。

戻り値
パワーオンセルフテスト情報。
参照
NetworkTestInfo

各情報の詳細は NetworkTestInfo クラスの説明を参照すること。

bool amdaemon::Network::canStartTest ( ) const

ネットワークテストを開始可能な状態であるか否かを取得する。

戻り値
true開始可能な状態である場合。
false開始不可能な状態である場合。
参照
Sequence

ネットワーク機能が有効かつ現在ゲームテストモード中であれば true を返す。 ゲームテストモード状態の管理は Sequence クラスで行える。

bool amdaemon::Network::startTest ( )

ネットワークテストを開始する。

戻り値
true開始成功した場合。
false開始失敗した場合。

メンバ関数 canStartTest が false を返す場合は何もせずに false を返す。 既にネットワークテストを実施中である場合はリスタートする。

メンバ関数 canStartTest が true を返す場合であっても、 Daemonプロセス側の状態等によっては開始できない場合がある。 そのため、必ず戻り値をチェックすること。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

const NetworkTestInfo& amdaemon::Network::getTestInfo ( ) const

ネットワークテスト情報を取得する。

戻り値
ネットワークテスト情報。
参照
NetworkTestInfo

各情報の詳細は NetworkTestInfo クラスの説明を参照すること。


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