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

LANインストール情報を提供するMonostateクラス。 [詳解]

#include <LanInstall.h>

公開メンバ関数

bool isAvailable () const
 LANインストール機能を利用可能であるか否かを取得する。 [詳解]
 
bool isClient () const
 LANインストールクライアントとして動作するか否かを取得する。 [詳解]
 
bool isServer () const
 LANインストールサーバとして動作するか否かを取得する。 [詳解]
 
bool isExitNeeded () const
 LANインストールによるセガブート遷移要求があるか否かを取得する。 [詳解]
 
std::int32_t getServerCount () const
 LANインストールサーバ検出数を取得する。 [詳解]
 

詳解

LANインストール情報を提供するMonostateクラス。

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。

関数詳解

bool amdaemon::LanInstall::isAvailable ( ) const
inline

LANインストール機能を利用可能であるか否かを取得する。

戻り値
true利用可能である場合。
false機能が無効である場合。

条件式 (isClient() || isServer()) の結果を返す。

bool amdaemon::LanInstall::isClient ( ) const

LANインストールクライアントとして動作するか否かを取得する。

戻り値
trueLANインストールクライアントとして動作する場合。
falseLANインストールクライアントとして動作しない場合。

この関数とメンバ関数 isServer が両方とも true を返すことはない。 LANインストールを行わない設定の場合はどちらも false を返す。

bool amdaemon::LanInstall::isServer ( ) const

LANインストールサーバとして動作するか否かを取得する。

戻り値
trueLANインストールサーバとして動作する場合。
falseLANインストールサーバとして動作しない場合。

この関数とメンバ関数 isClient が両方とも true を返すことはない。 LANインストールを行わない設定の場合はどちらも false を返す。

bool amdaemon::LanInstall::isExitNeeded ( ) const

LANインストールによるセガブート遷移要求があるか否かを取得する。

戻り値
trueセガブート遷移要求がある場合。
falseセガブート遷移要求がない場合。
参照
Core::kill

LANインストールクライアントとして動作していない場合は常に false を返す。

LANインストールクライアントとして動作しており、この関数が true を返す場合、 イメージ更新のためにアプリ終了フローへ遷移する必要がある。 アプリ終了フローについては Core クラスの説明を参照すること。

std::int32_t amdaemon::LanInstall::getServerCount ( ) const

LANインストールサーバ検出数を取得する。

戻り値
LANインストールサーバ検出数。自身も含む。未検出ならば -1 。

自身を含め、LAN上に存在するLANインストールサーバの検出数を返す。

  • 未検出時には -1 を返す。
  • サーバを検出できないまま約3分経過すると 0 を返す。
  • サーバを検出した場合は即座に 1 以上の値を返す。 ただし内部実装の都合上、最大検出数は 2 となる。 3 以上になることはない。
  • 0 や 1 を返す状態で新たにサーバを検出した場合は数値が増加する。 一方、検出済みのLANインストールサーバが切断された場合等に数値が減ることはない。
  • ゲームテストモードの開始時および終了時には -1 に戻って検出し直しとなる。

この関数が 2 を返す場合、自身がLANインストールクライアントならば ERROR 8405 、LANインストールサーバならば ERROR 8406 が同時に発生する。

この関数が 0 を返す場合、Daemonプロセス側で進行停止エラーとすることはないが、 ゲームアプリ側で進行停止エラーとしたい場合は ERROR 8404 を用いること。 ERROR 8404 自体は AM Daemon 標準のエラーリソースDLLで定義済みであるため、 タイトル側で個別に定義する必要はない。 エラー発生には Error クラスのメンバ関数 Error::set を用いること。

LANインストールを行わない設定の場合は常に -1 を返す。


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