DownloadManager.cs 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. using System;
  8. using System.Collections.Generic;
  9. namespace GameFramework.Download
  10. {
  11. /// <summary>
  12. /// 下载管理器。
  13. /// </summary>
  14. internal sealed partial class DownloadManager : GameFrameworkModule, IDownloadManager
  15. {
  16. private const int OneMegaBytes = 1024 * 1024;
  17. private readonly TaskPool<DownloadTask> m_TaskPool;
  18. private readonly DownloadCounter m_DownloadCounter;
  19. private int m_FlushSize;
  20. private float m_Timeout;
  21. private EventHandler<DownloadStartEventArgs> m_DownloadStartEventHandler;
  22. private EventHandler<DownloadUpdateEventArgs> m_DownloadUpdateEventHandler;
  23. private EventHandler<DownloadSuccessEventArgs> m_DownloadSuccessEventHandler;
  24. private EventHandler<DownloadFailureEventArgs> m_DownloadFailureEventHandler;
  25. /// <summary>
  26. /// 初始化下载管理器的新实例。
  27. /// </summary>
  28. public DownloadManager()
  29. {
  30. m_TaskPool = new TaskPool<DownloadTask>();
  31. m_DownloadCounter = new DownloadCounter(1f, 10f);
  32. m_FlushSize = OneMegaBytes;
  33. m_Timeout = 30f;
  34. m_DownloadStartEventHandler = null;
  35. m_DownloadUpdateEventHandler = null;
  36. m_DownloadSuccessEventHandler = null;
  37. m_DownloadFailureEventHandler = null;
  38. }
  39. /// <summary>
  40. /// 获取游戏框架模块优先级。
  41. /// </summary>
  42. /// <remarks>优先级较高的模块会优先轮询,并且关闭操作会后进行。</remarks>
  43. internal override int Priority
  44. {
  45. get
  46. {
  47. return 5;
  48. }
  49. }
  50. /// <summary>
  51. /// 获取或设置下载是否被暂停。
  52. /// </summary>
  53. public bool Paused
  54. {
  55. get
  56. {
  57. return m_TaskPool.Paused;
  58. }
  59. set
  60. {
  61. m_TaskPool.Paused = value;
  62. }
  63. }
  64. /// <summary>
  65. /// 获取下载代理总数量。
  66. /// </summary>
  67. public int TotalAgentCount
  68. {
  69. get
  70. {
  71. return m_TaskPool.TotalAgentCount;
  72. }
  73. }
  74. /// <summary>
  75. /// 获取可用下载代理数量。
  76. /// </summary>
  77. public int FreeAgentCount
  78. {
  79. get
  80. {
  81. return m_TaskPool.FreeAgentCount;
  82. }
  83. }
  84. /// <summary>
  85. /// 获取工作中下载代理数量。
  86. /// </summary>
  87. public int WorkingAgentCount
  88. {
  89. get
  90. {
  91. return m_TaskPool.WorkingAgentCount;
  92. }
  93. }
  94. /// <summary>
  95. /// 获取等待下载任务数量。
  96. /// </summary>
  97. public int WaitingTaskCount
  98. {
  99. get
  100. {
  101. return m_TaskPool.WaitingTaskCount;
  102. }
  103. }
  104. /// <summary>
  105. /// 获取或设置将缓冲区写入磁盘的临界大小。
  106. /// </summary>
  107. public int FlushSize
  108. {
  109. get
  110. {
  111. return m_FlushSize;
  112. }
  113. set
  114. {
  115. m_FlushSize = value;
  116. }
  117. }
  118. /// <summary>
  119. /// 获取或设置下载超时时长,以秒为单位。
  120. /// </summary>
  121. public float Timeout
  122. {
  123. get
  124. {
  125. return m_Timeout;
  126. }
  127. set
  128. {
  129. m_Timeout = value;
  130. }
  131. }
  132. /// <summary>
  133. /// 获取当前下载速度。
  134. /// </summary>
  135. public float CurrentSpeed
  136. {
  137. get
  138. {
  139. return m_DownloadCounter.CurrentSpeed;
  140. }
  141. }
  142. /// <summary>
  143. /// 下载开始事件。
  144. /// </summary>
  145. public event EventHandler<DownloadStartEventArgs> DownloadStart
  146. {
  147. add
  148. {
  149. m_DownloadStartEventHandler += value;
  150. }
  151. remove
  152. {
  153. m_DownloadStartEventHandler -= value;
  154. }
  155. }
  156. /// <summary>
  157. /// 下载更新事件。
  158. /// </summary>
  159. public event EventHandler<DownloadUpdateEventArgs> DownloadUpdate
  160. {
  161. add
  162. {
  163. m_DownloadUpdateEventHandler += value;
  164. }
  165. remove
  166. {
  167. m_DownloadUpdateEventHandler -= value;
  168. }
  169. }
  170. /// <summary>
  171. /// 下载成功事件。
  172. /// </summary>
  173. public event EventHandler<DownloadSuccessEventArgs> DownloadSuccess
  174. {
  175. add
  176. {
  177. m_DownloadSuccessEventHandler += value;
  178. }
  179. remove
  180. {
  181. m_DownloadSuccessEventHandler -= value;
  182. }
  183. }
  184. /// <summary>
  185. /// 下载失败事件。
  186. /// </summary>
  187. public event EventHandler<DownloadFailureEventArgs> DownloadFailure
  188. {
  189. add
  190. {
  191. m_DownloadFailureEventHandler += value;
  192. }
  193. remove
  194. {
  195. m_DownloadFailureEventHandler -= value;
  196. }
  197. }
  198. /// <summary>
  199. /// 下载管理器轮询。
  200. /// </summary>
  201. /// <param name="elapseSeconds">逻辑流逝时间,以秒为单位。</param>
  202. /// <param name="realElapseSeconds">真实流逝时间,以秒为单位。</param>
  203. internal override void Update(float elapseSeconds, float realElapseSeconds)
  204. {
  205. m_TaskPool.Update(elapseSeconds, realElapseSeconds);
  206. m_DownloadCounter.Update(elapseSeconds, realElapseSeconds);
  207. }
  208. /// <summary>
  209. /// 关闭并清理下载管理器。
  210. /// </summary>
  211. internal override void Shutdown()
  212. {
  213. m_TaskPool.Shutdown();
  214. m_DownloadCounter.Shutdown();
  215. }
  216. /// <summary>
  217. /// 增加下载代理辅助器。
  218. /// </summary>
  219. /// <param name="downloadAgentHelper">要增加的下载代理辅助器。</param>
  220. public void AddDownloadAgentHelper(IDownloadAgentHelper downloadAgentHelper)
  221. {
  222. DownloadAgent agent = new DownloadAgent(downloadAgentHelper);
  223. agent.DownloadAgentStart += OnDownloadAgentStart;
  224. agent.DownloadAgentUpdate += OnDownloadAgentUpdate;
  225. agent.DownloadAgentSuccess += OnDownloadAgentSuccess;
  226. agent.DownloadAgentFailure += OnDownloadAgentFailure;
  227. m_TaskPool.AddAgent(agent);
  228. }
  229. /// <summary>
  230. /// 根据下载任务的序列编号获取下载任务的信息。
  231. /// </summary>
  232. /// <param name="serialId">要获取信息的下载任务的序列编号。</param>
  233. /// <returns>下载任务的信息。</returns>
  234. public TaskInfo GetDownloadInfo(int serialId)
  235. {
  236. return m_TaskPool.GetTaskInfo(serialId);
  237. }
  238. /// <summary>
  239. /// 根据下载任务的标签获取下载任务的信息。
  240. /// </summary>
  241. /// <param name="tag">要获取信息的下载任务的标签。</param>
  242. /// <returns>下载任务的信息。</returns>
  243. public TaskInfo[] GetDownloadInfos(string tag)
  244. {
  245. return m_TaskPool.GetTaskInfos(tag);
  246. }
  247. /// <summary>
  248. /// 根据下载任务的标签获取下载任务的信息。
  249. /// </summary>
  250. /// <param name="tag">要获取信息的下载任务的标签。</param>
  251. /// <param name="results">下载任务的信息。</param>
  252. public void GetDownloadInfos(string tag, List<TaskInfo> results)
  253. {
  254. m_TaskPool.GetTaskInfos(tag, results);
  255. }
  256. /// <summary>
  257. /// 获取所有下载任务的信息。
  258. /// </summary>
  259. /// <returns>所有下载任务的信息。</returns>
  260. public TaskInfo[] GetAllDownloadInfos()
  261. {
  262. return m_TaskPool.GetAllTaskInfos();
  263. }
  264. /// <summary>
  265. /// 获取所有下载任务的信息。
  266. /// </summary>
  267. /// <param name="results">所有下载任务的信息。</param>
  268. public void GetAllDownloadInfos(List<TaskInfo> results)
  269. {
  270. m_TaskPool.GetAllTaskInfos(results);
  271. }
  272. /// <summary>
  273. /// 增加下载任务。
  274. /// </summary>
  275. /// <param name="downloadPath">下载后存放路径。</param>
  276. /// <param name="downloadUri">原始下载地址。</param>
  277. /// <returns>新增下载任务的序列编号。</returns>
  278. public int AddDownload(string downloadPath, string downloadUri)
  279. {
  280. return AddDownload(downloadPath, downloadUri, null, Constant.DefaultPriority, null);
  281. }
  282. /// <summary>
  283. /// 增加下载任务。
  284. /// </summary>
  285. /// <param name="downloadPath">下载后存放路径。</param>
  286. /// <param name="downloadUri">原始下载地址。</param>
  287. /// <param name="tag">下载任务的标签。</param>
  288. /// <returns>新增下载任务的序列编号。</returns>
  289. public int AddDownload(string downloadPath, string downloadUri, string tag)
  290. {
  291. return AddDownload(downloadPath, downloadUri, tag, Constant.DefaultPriority, null);
  292. }
  293. /// <summary>
  294. /// 增加下载任务。
  295. /// </summary>
  296. /// <param name="downloadPath">下载后存放路径。</param>
  297. /// <param name="downloadUri">原始下载地址。</param>
  298. /// <param name="priority">下载任务的优先级。</param>
  299. /// <returns>新增下载任务的序列编号。</returns>
  300. public int AddDownload(string downloadPath, string downloadUri, int priority)
  301. {
  302. return AddDownload(downloadPath, downloadUri, null, priority, null);
  303. }
  304. /// <summary>
  305. /// 增加下载任务。
  306. /// </summary>
  307. /// <param name="downloadPath">下载后存放路径。</param>
  308. /// <param name="downloadUri">原始下载地址。</param>
  309. /// <param name="userData">用户自定义数据。</param>
  310. /// <returns>新增下载任务的序列编号。</returns>
  311. public int AddDownload(string downloadPath, string downloadUri, object userData)
  312. {
  313. return AddDownload(downloadPath, downloadUri, null, Constant.DefaultPriority, userData);
  314. }
  315. /// <summary>
  316. /// 增加下载任务。
  317. /// </summary>
  318. /// <param name="downloadPath">下载后存放路径。</param>
  319. /// <param name="downloadUri">原始下载地址。</param>
  320. /// <param name="tag">下载任务的标签。</param>
  321. /// <param name="priority">下载任务的优先级。</param>
  322. /// <returns>新增下载任务的序列编号。</returns>
  323. public int AddDownload(string downloadPath, string downloadUri, string tag, int priority)
  324. {
  325. return AddDownload(downloadPath, downloadUri, tag, priority, null);
  326. }
  327. /// <summary>
  328. /// 增加下载任务。
  329. /// </summary>
  330. /// <param name="downloadPath">下载后存放路径。</param>
  331. /// <param name="downloadUri">原始下载地址。</param>
  332. /// <param name="tag">下载任务的标签。</param>
  333. /// <param name="userData">用户自定义数据。</param>
  334. /// <returns>新增下载任务的序列编号。</returns>
  335. public int AddDownload(string downloadPath, string downloadUri, string tag, object userData)
  336. {
  337. return AddDownload(downloadPath, downloadUri, tag, Constant.DefaultPriority, userData);
  338. }
  339. /// <summary>
  340. /// 增加下载任务。
  341. /// </summary>
  342. /// <param name="downloadPath">下载后存放路径。</param>
  343. /// <param name="downloadUri">原始下载地址。</param>
  344. /// <param name="priority">下载任务的优先级。</param>
  345. /// <param name="userData">用户自定义数据。</param>
  346. /// <returns>新增下载任务的序列编号。</returns>
  347. public int AddDownload(string downloadPath, string downloadUri, int priority, object userData)
  348. {
  349. return AddDownload(downloadPath, downloadUri, null, priority, userData);
  350. }
  351. /// <summary>
  352. /// 增加下载任务。
  353. /// </summary>
  354. /// <param name="downloadPath">下载后存放路径。</param>
  355. /// <param name="downloadUri">原始下载地址。</param>
  356. /// <param name="tag">下载任务的标签。</param>
  357. /// <param name="priority">下载任务的优先级。</param>
  358. /// <param name="userData">用户自定义数据。</param>
  359. /// <returns>新增下载任务的序列编号。</returns>
  360. public int AddDownload(string downloadPath, string downloadUri, string tag, int priority, object userData)
  361. {
  362. if (string.IsNullOrEmpty(downloadPath))
  363. {
  364. throw new GameFrameworkException("Download path is invalid.");
  365. }
  366. if (string.IsNullOrEmpty(downloadUri))
  367. {
  368. throw new GameFrameworkException("Download uri is invalid.");
  369. }
  370. if (TotalAgentCount <= 0)
  371. {
  372. throw new GameFrameworkException("You must add download agent first.");
  373. }
  374. DownloadTask downloadTask = DownloadTask.Create(downloadPath, downloadUri, tag, priority, m_FlushSize, m_Timeout, userData);
  375. m_TaskPool.AddTask(downloadTask);
  376. return downloadTask.SerialId;
  377. }
  378. /// <summary>
  379. /// 根据下载任务的序列编号移除下载任务。
  380. /// </summary>
  381. /// <param name="serialId">要移除下载任务的序列编号。</param>
  382. /// <returns>是否移除下载任务成功。</returns>
  383. public bool RemoveDownload(int serialId)
  384. {
  385. return m_TaskPool.RemoveTask(serialId);
  386. }
  387. /// <summary>
  388. /// 根据下载任务的标签移除下载任务。
  389. /// </summary>
  390. /// <param name="tag">要移除下载任务的标签。</param>
  391. /// <returns>移除下载任务的数量。</returns>
  392. public int RemoveDownloads(string tag)
  393. {
  394. return m_TaskPool.RemoveTasks(tag);
  395. }
  396. /// <summary>
  397. /// 移除所有下载任务。
  398. /// </summary>
  399. /// <returns>移除下载任务的数量。</returns>
  400. public int RemoveAllDownloads()
  401. {
  402. return m_TaskPool.RemoveAllTasks();
  403. }
  404. private void OnDownloadAgentStart(DownloadAgent sender)
  405. {
  406. if (m_DownloadStartEventHandler != null)
  407. {
  408. DownloadStartEventArgs downloadStartEventArgs = DownloadStartEventArgs.Create(sender.Task.SerialId, sender.Task.DownloadPath, sender.Task.DownloadUri, sender.CurrentLength, sender.Task.UserData);
  409. m_DownloadStartEventHandler(this, downloadStartEventArgs);
  410. ReferencePool.Release(downloadStartEventArgs);
  411. }
  412. }
  413. private void OnDownloadAgentUpdate(DownloadAgent sender, int deltaLength)
  414. {
  415. m_DownloadCounter.RecordDeltaLength(deltaLength);
  416. if (m_DownloadUpdateEventHandler != null)
  417. {
  418. DownloadUpdateEventArgs downloadUpdateEventArgs = DownloadUpdateEventArgs.Create(sender.Task.SerialId, sender.Task.DownloadPath, sender.Task.DownloadUri, sender.CurrentLength, sender.Task.UserData);
  419. m_DownloadUpdateEventHandler(this, downloadUpdateEventArgs);
  420. ReferencePool.Release(downloadUpdateEventArgs);
  421. }
  422. }
  423. private void OnDownloadAgentSuccess(DownloadAgent sender, long length)
  424. {
  425. if (m_DownloadSuccessEventHandler != null)
  426. {
  427. DownloadSuccessEventArgs downloadSuccessEventArgs = DownloadSuccessEventArgs.Create(sender.Task.SerialId, sender.Task.DownloadPath, sender.Task.DownloadUri, sender.CurrentLength, sender.Task.UserData);
  428. m_DownloadSuccessEventHandler(this, downloadSuccessEventArgs);
  429. ReferencePool.Release(downloadSuccessEventArgs);
  430. }
  431. }
  432. private void OnDownloadAgentFailure(DownloadAgent sender, string errorMessage)
  433. {
  434. if (m_DownloadFailureEventHandler != null)
  435. {
  436. DownloadFailureEventArgs downloadFailureEventArgs = DownloadFailureEventArgs.Create(sender.Task.SerialId, sender.Task.DownloadPath, sender.Task.DownloadUri, errorMessage, sender.Task.UserData);
  437. m_DownloadFailureEventHandler(this, downloadFailureEventArgs);
  438. ReferencePool.Release(downloadFailureEventArgs);
  439. }
  440. }
  441. }
  442. }