CRIWARE Unity Plugin Manual  Last Updated: 2022-08-24
CriFsInstaller クラス

ファイルのインストールを行うためのモジュールです。 [詳解]

CriDisposableを継承しています。

公開型

enum  Status { Stop, Busy, Complete, Error }
 インストーラの状態を示す値です。 [詳解]
 

公開メンバ関数

override void Dispose ()
 インストーラを破棄します。 [詳解]
 
void Copy (CriFsBinder binder, string srcPath, string dstPath, int installBufferSize)
 ファイルをコピーします。 [詳解]
 
void Stop ()
 インストール処理を停止します。 [詳解]
 
Status GetStatus ()
 インストーラのステータスを取得します。 [詳解]
 
float GetProgress ()
 インストール処理の進捗状況を取得します。 [詳解]
 

静的公開メンバ関数

static void ExecuteMain ()
 定期実行関数 [詳解]
 

詳解

ファイルのインストールを行うためのモジュールです。

説明:
ファイルのインストールを行うためのモジュールです。
サーバ上のコンテンツをローカルストレージにインストールするために使用します。
注意:
ネットワーク接続がタイムアウトした場合、CriFsInstallerは無限リトライを行います。 ただし以下の場合はエラーとなり、リトライは行いません。
  • インストール元のファイルの存在を確認中、ネットワーク接続がタイムアウトした
  • インストール元のファイルが存在しなかった 本クラスでは、無限リトライを中断するタイミングを判定しません。
備考:
どのタイミングで無限リトライを中断するかについては、アプリケーション側の実装に任されます。
例えば、以下の手順による中断処理が考えられます。
  1. CriWare.CriFsInstaller::GetProgress 関数でインストール進捗状況の値を取得する。
  2. 一定時間後、再びインストール進捗状況の値を取得する。
  3. 手順1.と手順2.で得た値が等しい場合、CriWare.CriFsInstaller::Stop 関数でインストールを停止する。

列挙型メンバ詳解

enum Status
strong

インストーラの状態を示す値です。

参照
CriFsInstaller::GetStatus
列挙値
Stop 

停止中

Busy 

インストール中

Complete 

インストール完了

Error 

エラーが発生

関数詳解

override void Dispose ( )
inline

インストーラを破棄します。

注意:
インストール処理中にインストーラを破棄した場合、 本関数内で処理が長時間ブロックされる可能性があります。
void Copy ( CriFsBinder  binder,
string  srcPath,
string  dstPath,
int  installBufferSize 
)
inline

ファイルをコピーします。

引数
binderバインダ
srcPathコピー元ファイルパス名
dstPathコピー先ファイルパス名
installBufferSizeインストールバッファサイズ
説明:
ファイルのコピーを開始します。

本関数は即時復帰関数です。
コピーの完了状態を取得するには CriWare.CriFsInstaller::GetStatus 関数を使用してください。
参照
CriFsInstaller::GetStatus
void Stop ( )
inline

インストール処理を停止します。

説明:
処理を停止します。

本関数は即時復帰関数です。
停止の完了状態を取得するには CriWare.CriFsInstaller::GetStatus 関数を使用してください。
参照
CriFsInstaller::GetStatus
Status GetStatus ( )
inline

インストーラのステータスを取得します。

戻り値
ステータス
参照
CriFsInstaller::Status
float GetProgress ( )
inline

インストール処理の進捗状況を取得します。

戻り値
進捗状況
説明:
処理の進捗状況を取得します。
進捗状況は0.0?1.0の32ビット浮動小数点数です。
static void ExecuteMain ( )
inlinestatic

定期実行関数

説明:
インストール処理を進めます。定期的に実行する必要があります。

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