HTTP によるローカルストレージへのインストールを行うモジュールです。 [詳解]

CriDisposableを継承しています。

クラス
struct	ModuleConfig
	モジュールコンフィギュレーション [詳解]

struct	StatusInfo
	ステータス情報 [詳解]

公開型
enum	Status : int { Stop, Busy, Complete, Error }
	ステータス [詳解]

enum	Error : int { None, Timeout, Memory, LocalFs, DNS, Connection, SSL, HTTP, Internal }
	エラー種別 [詳解]

公開メンバ関数
override void	Dispose ()
	インストーラを破棄します。 [詳解]

void	Copy (string url, string dstPath)
	ファイルをインストールします。 [詳解]

void	Stop ()
	インストール処理を停止します。 [詳解]

StatusInfo	GetStatusInfo ()
	ステータス情報を取得します。 [詳解]

bool	GetCRC32 (out uint ret_val)
	CRC32計算結果の取得 [詳解]

静的公開メンバ関数
static void	InitializeModule (ModuleConfig config)
	CriFsWebInstaller モジュールの初期化 [詳解]

static void	FinalizeModule ()
	CriFsWebInstaller モジュールの終了 [詳解]

static void	ExecuteMain ()
	サーバ処理の実行 [詳解]

static bool	SetRequestHeader (string field, string value)
	HTTPリクエストヘッダの情報を変更します。 [詳解]

公開変数類
const int	InvalidHttpStatusCode = -1
	無効なHTTPステータスコード [詳解]

const long	InvalidContentsSize = -1
	無効なコンテンツサイズ [詳解]

プロパティ
static ModuleConfig	defaultModuleConfig `[get]`
	デフォルトモジュールコンフィギュレーション [詳解]

詳解

HTTP によるローカルストレージへのインストールを行うモジュールです。

説明:: Web サーバ上のコンテンツをローカルストレージにインストールするために使用します。

注意:: iOSでの本機能の動作要件は iOS7 以降になります。

注意:: CriWare.CriFsWebInstaller のインスタンスを生成する前に、 CriWare.CriFsWebInstaller::InitializeModule メソッドでモジュールを初期化する必要があります。

列挙型メンバ詳解

enum Status : int

strong

ステータス

参照: CriFsWebInstaller::GetStatusInfo

列挙値
Stop	停止中
Busy	処理中
Complete	完了
Error	エラー

enum Error : int

strong

エラー種別

説明:: インストーラハンドルのエラー種別を表します。
CriWare.CriFsWebInstaller::GetStatusInfo 関数により取得できます。

参照: CriFsWebInstaller::GetStatusInfo

列挙値
None	エラーなし
Timeout	タイムアウトエラー
Memory	メモリ確保失敗
LocalFs	ローカルファイルシステムエラー
DNS	DNSエラー
Connection	接続エラー
SSL	SSLエラー
HTTP	HTTPエラー
Internal	内部エラー

関数詳解

override void Dispose ( )

inline

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

注意:: インストール処理中にインストーラを破棄した場合、本関数内で処理が長時間ブロックされる可能性があります。

void Copy	(	string	url,
		string	dstPath
	)

inline

ファイルをインストールします。

引数

url	インストール元URL
dstPath	インストール先ファイルパス名

説明:: ファイルのインストールを開始します。
本関数は即時復帰関数です。
コピーの完了状態を取得するには CriWare.CriFsWebInstaller::GetStatusInfo 関数を使用してください。

注意:

- インストール先のファイルが存在する場合はエラー CriFsWebInstaller.Error.LocalFs が発生します。

インストール先のフォルダが存在しない場合はエラー CriFsWebInstaller.Error.LocalFs が発生します。

参照: CriFsWebInstaller::GetStatusInfo

void Stop ( )

inline

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

説明:: 処理を停止します。
本関数は即時復帰関数です。
停止の完了状態を取得するには CriWare.CriFsWebInstaller::GetStatusInfo 関数を使用してください。

参照: CriFsInstaller::GetStatus

StatusInfo GetStatusInfo ( )

inline

ステータス情報を取得します。

戻り値: ステータス情報

参照: CriFsWebInstaller::StatusInfo

bool GetCRC32 ( out uint ret_val )

inline

CRC32計算結果の取得

引数

ret_val CRC結果格納用

説明:: Status.Complete状態でのみ有効なチェックサムを返却します。
Status.Complete以外で取得した場合、CRC結果の値は0になります。
本関数は ModuleConfig.crcEnabled=true の場合のみ使用可能です。

参照: CriFsWebInstaller::StatusInfo

static void InitializeModule ( ModuleConfig config )

inlinestatic

CriFsWebInstaller モジュールの初期化

引数

config コンフィギュレーション

説明:: CriFsWebInstaller モジュールを初期化します。
モジュールの機能を利用するには、必ずこの関数を実行する必要があります。
（モジュールの機能は、本関数を実行後、 CriWare.CriFsWebInstaller::FinalizeModule 関数を実行するまでの間、利用可能です。）

注意:: 本関数を実行後、必ず対になる CriWare.CriFsWebInstaller::FinalizeModule 関数を実行してください。
また、 CriWare.CriFsWebInstaller::FinalizeModule 関数を実行するまでは、本関数を再度実行することはできません。

参照: CriFsWebInstaller::ModuleConfig, CriFsWebInstaller::FinalizeModule

static void FinalizeModule ( )

inlinestatic

CriFsWebInstaller モジュールの終了

説明:: CriFsWebInstaller モジュールを終了します。

注意:

- CriWare.CriFsWebInstaller::InitializeModule 関数実行前に本関数を実行することはできません。

全ての CriWare.CriFsWebInstaller が破棄されている必要があります。

参照: CriFsWebInstaller::InitializeModule

static void ExecuteMain ( )

inlinestatic

サーバ処理の実行

説明:: サーバ処理を実行します。定期的に実行する必要があります。

static bool SetRequestHeader	(	string	field,
		string	value
	)

inlinestatic

HTTPリクエストヘッダの情報を変更します。

引数

field	フィールド名
value	フィールドの値

説明:: HTTPリクエストヘッダの情報を変更します。
この関数は CriWare.CriFsWebInstaller::InitializeModule 関数実行後に呼び出す必要があります。
インストール実行前に本関数を実行してください。
すでにフィールド名が登録されていた場合、フィールドの値を上書きします。
フィールドの値として null が渡された場合、フィールドを削除します。

メンバ詳解

const int InvalidHttpStatusCode = -1

無効なHTTPステータスコード

説明:: 無効なHTTPステータスコードを表わす定数です。
HTTP以外の原因でインストールに失敗した場合にセットされます。
この値は負値であることが保証されます。

参照: CriFsWebInstaller::StatusInfo.httpStatusCode

const long InvalidContentsSize = -1

無効なコンテンツサイズ

説明:: インストール対象のサイズが取得出来ていない場合にセットされます。
この値は負値であることが保証されます。

参照: CriFsWebInstaller::StatusInfo.contentsSize

プロパティ詳解

ModuleConfig defaultModuleConfig

staticget

デフォルトモジュールコンフィギュレーション

説明:: デフォルトモジュールコンフィグです。

備考:: 本プロパティで取得したデフォルトコンフィギュレーションを必要に応じて変更して CriWare.CriFsWebInstaller::InitializeModule 関数に指定してください。

参照: CriFsWebInstaller::InitializeModule

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

CriFsWebInstaller.cs

クラス

公開型

公開メンバ関数

静的公開メンバ関数

公開変数類

プロパティ

詳解

列挙型メンバ詳解

関数詳解

メンバ詳解

プロパティ詳解