Game Framework  2021.05.31
DownloadComponent类 参考

下载组件。 更多...

类 DownloadComponent 继承关系图:
GameFrameworkComponent

Public 成员函数

TaskInfo GetDownloadInfo (int serialId)
 根据下载任务的序列编号获取下载任务的信息。 更多...
 
TaskInfo[] GetDownloadInfos (string tag)
 根据下载任务的标签获取下载任务的信息。 更多...
 
void GetDownloadInfos (string tag, List< TaskInfo > results)
 根据下载任务的标签获取下载任务的信息。 更多...
 
TaskInfo[] GetAllDownloadInfos ()
 获取所有下载任务的信息。 更多...
 
void GetAllDownloadInfos (List< TaskInfo > results)
 获取所有下载任务的信息。 更多...
 
int AddDownload (string downloadPath, string downloadUri)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, string tag)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, int priority)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, object userData)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, string tag, int priority)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, string tag, object userData)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, int priority, object userData)
 增加下载任务。 更多...
 
int AddDownload (string downloadPath, string downloadUri, string tag, int priority, object userData)
 增加下载任务。 更多...
 
bool RemoveDownload (int serialId)
 根据下载任务的序列编号移除下载任务。 更多...
 
int RemoveDownloads (string tag)
 根据下载任务的标签移除下载任务。 更多...
 
int RemoveAllDownloads ()
 移除所有下载任务。 更多...
 

Protected 成员函数

override void Awake ()
 游戏框架组件初始化。 更多...
 

属性

bool Paused [get, set]
 获取或设置下载是否被暂停。 更多...
 
int TotalAgentCount [get]
 获取下载代理总数量。 更多...
 
int FreeAgentCount [get]
 获取可用下载代理数量。 更多...
 
int WorkingAgentCount [get]
 获取工作中下载代理数量。 更多...
 
int WaitingTaskCount [get]
 获取等待下载任务数量。 更多...
 
float Timeout [get, set]
 获取或设置下载超时时长,以秒为单位。 更多...
 
int FlushSize [get, set]
 获取或设置将缓冲区写入磁盘的临界大小,仅当开启断点续传时有效。 更多...
 
float CurrentSpeed [get]
 获取当前下载速度。 更多...
 

详细描述

下载组件。

成员函数说明

◆ AddDownload() [1/8]

int AddDownload ( string  downloadPath,
string  downloadUri 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
返回
新增下载任务的序列编号。

◆ AddDownload() [2/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
int  priority 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
priority下载任务的优先级。
返回
新增下载任务的序列编号。

◆ AddDownload() [3/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
int  priority,
object  userData 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
priority下载任务的优先级。
userData用户自定义数据。
返回
新增下载任务的序列编号。

◆ AddDownload() [4/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
object  userData 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
userData用户自定义数据。
返回
新增下载任务的序列编号。

◆ AddDownload() [5/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
string  tag 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
tag下载任务的标签。
返回
新增下载任务的序列编号。

◆ AddDownload() [6/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
string  tag,
int  priority 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
tag下载任务的标签。
priority下载任务的优先级。
返回
新增下载任务的序列编号。

◆ AddDownload() [7/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
string  tag,
int  priority,
object  userData 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
tag下载任务的标签。
priority下载任务的优先级。
userData用户自定义数据。
返回
新增下载任务的序列编号。

◆ AddDownload() [8/8]

int AddDownload ( string  downloadPath,
string  downloadUri,
string  tag,
object  userData 
)

增加下载任务。

参数
downloadPath下载后存放路径。
downloadUri原始下载地址。
tag下载任务的标签。
userData用户自定义数据。
返回
新增下载任务的序列编号。

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ GetAllDownloadInfos() [1/2]

TaskInfo [] GetAllDownloadInfos ( )

获取所有下载任务的信息。

返回
所有下载任务的信息。

◆ GetAllDownloadInfos() [2/2]

void GetAllDownloadInfos ( List< TaskInfo results)

获取所有下载任务的信息。

参数
results所有下载任务的信息。

◆ GetDownloadInfo()

TaskInfo GetDownloadInfo ( int  serialId)

根据下载任务的序列编号获取下载任务的信息。

参数
serialId要获取信息的下载任务的序列编号。
返回
下载任务的信息。

◆ GetDownloadInfos() [1/2]

TaskInfo [] GetDownloadInfos ( string  tag)

根据下载任务的标签获取下载任务的信息。

参数
tag要获取信息的下载任务的标签。
返回
下载任务的信息。

◆ GetDownloadInfos() [2/2]

void GetDownloadInfos ( string  tag,
List< TaskInfo results 
)

根据下载任务的标签获取下载任务的信息。

参数
tag要获取信息的下载任务的标签。
results下载任务的信息。

◆ RemoveAllDownloads()

int RemoveAllDownloads ( )

移除所有下载任务。

返回
移除下载任务的数量。

◆ RemoveDownload()

bool RemoveDownload ( int  serialId)

根据下载任务的序列编号移除下载任务。

参数
serialId要移除下载任务的序列编号。
返回
是否移除下载任务成功。

◆ RemoveDownloads()

int RemoveDownloads ( string  tag)

根据下载任务的标签移除下载任务。

参数
tag要移除下载任务的标签。
返回
移除下载任务的数量。

属性说明

◆ CurrentSpeed

float CurrentSpeed
get

获取当前下载速度。

◆ FlushSize

int FlushSize
getset

获取或设置将缓冲区写入磁盘的临界大小,仅当开启断点续传时有效。

◆ FreeAgentCount

int FreeAgentCount
get

获取可用下载代理数量。

◆ Paused

bool Paused
getset

获取或设置下载是否被暂停。

◆ Timeout

float Timeout
getset

获取或设置下载超时时长,以秒为单位。

◆ TotalAgentCount

int TotalAgentCount
get

获取下载代理总数量。

◆ WaitingTaskCount

int WaitingTaskCount
get

获取等待下载任务数量。

◆ WorkingAgentCount

int WorkingAgentCount
get

获取工作中下载代理数量。