用于通过 HTTP 安装至本地存储的模块。更多...

继承自 CriDisposable .

类
struct	ModuleConfig
	模块配置更多...

struct	StatusInfo
	状态信息更多...

Public 类型
enum	Status : int { Stop, Busy, Complete, Error }
	状态更多...

enum	Error : int { None, Timeout, Memory, LocalFs, DNS, Connection, SSL, HTTP, Internal }
	错误类型更多...

Public 成员函数
override void	Dispose ()
	丢弃Installer。更多...

void	Copy (string url, string dstPath)
	安装文件。更多...

void	Stop ()
	停止安装处理。更多...

StatusInfo	GetStatusInfo ()
	获取状态信息。更多...

bool	GetCRC32 (out uint ret_val)
	获取CRC32计算结果更多...

静态 Public 成员函数
static void	InitializeModule (ModuleConfig config)
	CriFsWebInstaller 模块初始化更多...

static void	FinalizeModule ()
	结束 CriFsWebInstaller 模块更多...

static void	ExecuteMain ()
	执行Server处理更多...

static bool	SetRequestHeader (string field, string value)
	更改HTTP请求头文件的信息。更多...

Public 属性
const int	InvalidHttpStatusCode = -1
	无效的HTTP状态代码更多...

const long	InvalidContentsSize = -1
	无效的内容大小更多...

属性
static ModuleConfig	defaultModuleConfig `[get]`
	预设模块配置更多...

详细描述

用于通过 HTTP 安装至本地存储的模块。

说明:: 用于将 Web Server上的内容安装至本地存储。

注意:: iOS的本功能的动作条件是 iOS7 以后。

注意:: 在创建 CriWare.CriFsWebInstaller 的实例之前，必须用 CriWare.CriFsWebInstaller::InitializeModule 方法初始化该模块。

成员枚举类型说明

enum Status : int

strong

状态

参见: CriFsWebInstaller::GetStatusInfo

枚举值
Stop	已停止
Busy	处理中
Complete	完成
Error	错误

enum Error : int

strong

错误类型

说明:: 表示Installer句柄错误类型。
可以通过 CriWare.CriFsWebInstaller::GetStatusInfo 函数来获取。

参见: CriFsWebInstaller::GetStatusInfo

枚举值
None	无错误
Timeout	超时错误
Memory	内存分配失败
LocalFs	本地文件系统错误
DNS	DNS错误
Connection	连接错误
SSL	SSL错误
HTTP	HTTP错误
Internal	内部错误

成员函数说明

override void Dispose ( )

inline

丢弃Installer。

注意:: 如果在安装处理过程中丢弃了Installer，则可能会导致本函数内的处理长时间被阻断。

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.FsWebInstaller::InitializeModule 函数前，无法执行本函数。

需要丢弃所有 CriWare.FsWebInstaller 。

参见: CriFsWebInstaller::InitializeModule

static void ExecuteMain ( )

inlinestatic

执行Server处理

说明:: 执行Server处理。需要定期执行。

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

类

Public 类型

Public 成员函数

静态 Public 成员函数

Public 属性

属性

详细描述

成员枚举类型说明

成员函数说明

类成员变量说明

属性说明