123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409 |
- //------------------------------------------------------------
- // Game Framework
- // Copyright © 2013-2021 loyalsoft. All rights reserved.
- // Homepage: http://www.game7000.com/
- // Feedback: http://www.game7000.com/
- //------------------------------------------------------------
- using GameFramework;
- using GameFramework.Download;
- using System.Collections.Generic;
- using UnityEngine;
- namespace UnityGameFramework.Runtime
- {
- /// <summary>
- /// 下载组件。
- /// </summary>
- [DisallowMultipleComponent]
- [AddComponentMenu("Game Framework/Download")]
- public sealed class DownloadComponent : GameFrameworkComponent
- {
- private const int DefaultPriority = 0;
- private const int OneMegaBytes = 1024 * 1024;
- private IDownloadManager m_DownloadManager = null;
- private EventComponent m_EventComponent = null;
- [SerializeField]
- private Transform m_InstanceRoot = null;
- [SerializeField]
- private string m_DownloadAgentHelperTypeName = "UnityGameFramework.Runtime.UnityWebRequestDownloadAgentHelper";
- [SerializeField]
- private DownloadAgentHelperBase m_CustomDownloadAgentHelper = null;
- [SerializeField]
- private int m_DownloadAgentHelperCount = 3;
- [SerializeField]
- private float m_Timeout = 30f;
- [SerializeField]
- private int m_FlushSize = OneMegaBytes;
- /// <summary>
- /// 获取或设置下载是否被暂停。
- /// </summary>
- public bool Paused
- {
- get
- {
- return m_DownloadManager.Paused;
- }
- set
- {
- m_DownloadManager.Paused = value;
- }
- }
- /// <summary>
- /// 获取下载代理总数量。
- /// </summary>
- public int TotalAgentCount
- {
- get
- {
- return m_DownloadManager.TotalAgentCount;
- }
- }
- /// <summary>
- /// 获取可用下载代理数量。
- /// </summary>
- public int FreeAgentCount
- {
- get
- {
- return m_DownloadManager.FreeAgentCount;
- }
- }
- /// <summary>
- /// 获取工作中下载代理数量。
- /// </summary>
- public int WorkingAgentCount
- {
- get
- {
- return m_DownloadManager.WorkingAgentCount;
- }
- }
- /// <summary>
- /// 获取等待下载任务数量。
- /// </summary>
- public int WaitingTaskCount
- {
- get
- {
- return m_DownloadManager.WaitingTaskCount;
- }
- }
- /// <summary>
- /// 获取或设置下载超时时长,以秒为单位。
- /// </summary>
- public float Timeout
- {
- get
- {
- return m_DownloadManager.Timeout;
- }
- set
- {
- m_DownloadManager.Timeout = m_Timeout = value;
- }
- }
- /// <summary>
- /// 获取或设置将缓冲区写入磁盘的临界大小,仅当开启断点续传时有效。
- /// </summary>
- public int FlushSize
- {
- get
- {
- return m_DownloadManager.FlushSize;
- }
- set
- {
- m_DownloadManager.FlushSize = m_FlushSize = value;
- }
- }
- /// <summary>
- /// 获取当前下载速度。
- /// </summary>
- public float CurrentSpeed
- {
- get
- {
- return m_DownloadManager.CurrentSpeed;
- }
- }
- /// <summary>
- /// 游戏框架组件初始化。
- /// </summary>
- protected override void Awake()
- {
- base.Awake();
- m_DownloadManager = GameFrameworkEntry.GetModule<IDownloadManager>();
- if (m_DownloadManager == null)
- {
- Log.Fatal("Download manager is invalid.");
- return;
- }
- m_DownloadManager.DownloadStart += OnDownloadStart;
- m_DownloadManager.DownloadUpdate += OnDownloadUpdate;
- m_DownloadManager.DownloadSuccess += OnDownloadSuccess;
- m_DownloadManager.DownloadFailure += OnDownloadFailure;
- m_DownloadManager.FlushSize = m_FlushSize;
- m_DownloadManager.Timeout = m_Timeout;
- }
- private void Start()
- {
- m_EventComponent = GameEntry.GetComponent<EventComponent>();
- if (m_EventComponent == null)
- {
- Log.Fatal("Event component is invalid.");
- return;
- }
- if (m_InstanceRoot == null)
- {
- m_InstanceRoot = new GameObject("Download Agent Instances").transform;
- m_InstanceRoot.SetParent(gameObject.transform);
- m_InstanceRoot.localScale = Vector3.one;
- }
- for (int i = 0; i < m_DownloadAgentHelperCount; i++)
- {
- AddDownloadAgentHelper(i);
- }
- }
- /// <summary>
- /// 根据下载任务的序列编号获取下载任务的信息。
- /// </summary>
- /// <param name="serialId">要获取信息的下载任务的序列编号。</param>
- /// <returns>下载任务的信息。</returns>
- public GameFramework.TaskInfo GetDownloadInfo(int serialId)
- {
- return m_DownloadManager.GetDownloadInfo(serialId);
- }
- /// <summary>
- /// 根据下载任务的标签获取下载任务的信息。
- /// </summary>
- /// <param name="tag">要获取信息的下载任务的标签。</param>
- /// <returns>下载任务的信息。</returns>
- public GameFramework.TaskInfo[] GetDownloadInfos(string tag)
- {
- return m_DownloadManager.GetDownloadInfos(tag);
- }
- /// <summary>
- /// 根据下载任务的标签获取下载任务的信息。
- /// </summary>
- /// <param name="tag">要获取信息的下载任务的标签。</param>
- /// <param name="results">下载任务的信息。</param>
- public void GetDownloadInfos(string tag, List<GameFramework.TaskInfo> results)
- {
- m_DownloadManager.GetDownloadInfos(tag, results);
- }
- /// <summary>
- /// 获取所有下载任务的信息。
- /// </summary>
- /// <returns>所有下载任务的信息。</returns>
- public GameFramework.TaskInfo[] GetAllDownloadInfos()
- {
- return m_DownloadManager.GetAllDownloadInfos();
- }
- /// <summary>
- /// 获取所有下载任务的信息。
- /// </summary>
- /// <param name="results">所有下载任务的信息。</param>
- public void GetAllDownloadInfos(List<GameFramework.TaskInfo> results)
- {
- m_DownloadManager.GetAllDownloadInfos(results);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri)
- {
- return AddDownload(downloadPath, downloadUri, null, DefaultPriority, null);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="tag">下载任务的标签。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, string tag)
- {
- return AddDownload(downloadPath, downloadUri, tag, DefaultPriority, null);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="priority">下载任务的优先级。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, int priority)
- {
- return AddDownload(downloadPath, downloadUri, null, priority, null);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, object userData)
- {
- return AddDownload(downloadPath, downloadUri, null, DefaultPriority, userData);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="tag">下载任务的标签。</param>
- /// <param name="priority">下载任务的优先级。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, string tag, int priority)
- {
- return AddDownload(downloadPath, downloadUri, tag, priority, null);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="tag">下载任务的标签。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, string tag, object userData)
- {
- return AddDownload(downloadPath, downloadUri, tag, DefaultPriority, userData);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="priority">下载任务的优先级。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, int priority, object userData)
- {
- return AddDownload(downloadPath, downloadUri, null, priority, userData);
- }
- /// <summary>
- /// 增加下载任务。
- /// </summary>
- /// <param name="downloadPath">下载后存放路径。</param>
- /// <param name="downloadUri">原始下载地址。</param>
- /// <param name="tag">下载任务的标签。</param>
- /// <param name="priority">下载任务的优先级。</param>
- /// <param name="userData">用户自定义数据。</param>
- /// <returns>新增下载任务的序列编号。</returns>
- public int AddDownload(string downloadPath, string downloadUri, string tag, int priority, object userData)
- {
- return m_DownloadManager.AddDownload(downloadPath, downloadUri, tag, priority, userData);
- }
- /// <summary>
- /// 根据下载任务的序列编号移除下载任务。
- /// </summary>
- /// <param name="serialId">要移除下载任务的序列编号。</param>
- /// <returns>是否移除下载任务成功。</returns>
- public bool RemoveDownload(int serialId)
- {
- return m_DownloadManager.RemoveDownload(serialId);
- }
- /// <summary>
- /// 根据下载任务的标签移除下载任务。
- /// </summary>
- /// <param name="tag">要移除下载任务的标签。</param>
- /// <returns>移除下载任务的数量。</returns>
- public int RemoveDownloads(string tag)
- {
- return m_DownloadManager.RemoveDownloads(tag);
- }
- /// <summary>
- /// 移除所有下载任务。
- /// </summary>
- /// <returns>移除下载任务的数量。</returns>
- public int RemoveAllDownloads()
- {
- return m_DownloadManager.RemoveAllDownloads();
- }
- /// <summary>
- /// 增加下载代理辅助器。
- /// </summary>
- /// <param name="index">下载代理辅助器索引。</param>
- private void AddDownloadAgentHelper(int index)
- {
- DownloadAgentHelperBase downloadAgentHelper = Helper.CreateHelper(m_DownloadAgentHelperTypeName, m_CustomDownloadAgentHelper, index);
- if (downloadAgentHelper == null)
- {
- Log.Error("Can not create download agent helper.");
- return;
- }
- downloadAgentHelper.name = Utility.Text.Format("Download Agent Helper - {0}", index.ToString());
- Transform transform = downloadAgentHelper.transform;
- transform.SetParent(m_InstanceRoot);
- transform.localScale = Vector3.one;
- m_DownloadManager.AddDownloadAgentHelper(downloadAgentHelper);
- }
- private void OnDownloadStart(object sender, GameFramework.Download.DownloadStartEventArgs e)
- {
- m_EventComponent.Fire(this, DownloadStartEventArgs.Create(e));
- }
- private void OnDownloadUpdate(object sender, GameFramework.Download.DownloadUpdateEventArgs e)
- {
- m_EventComponent.Fire(this, DownloadUpdateEventArgs.Create(e));
- }
- private void OnDownloadSuccess(object sender, GameFramework.Download.DownloadSuccessEventArgs e)
- {
- m_EventComponent.Fire(this, DownloadSuccessEventArgs.Create(e));
- }
- private void OnDownloadFailure(object sender, GameFramework.Download.DownloadFailureEventArgs e)
- {
- Log.Warning("Download failure, download serial id '{0}', download path '{1}', download uri '{2}', error message '{3}'.", e.SerialId.ToString(), e.DownloadPath, e.DownloadUri, e.ErrorMessage);
- m_EventComponent.Fire(this, DownloadFailureEventArgs.Create(e));
- }
- }
- }
|