WebRequestManager.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  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.WebRequest
  10. {
  11. /// <summary>
  12. /// Web 请求管理器。
  13. /// </summary>
  14. internal sealed partial class WebRequestManager : GameFrameworkModule, IWebRequestManager
  15. {
  16. private readonly TaskPool<WebRequestTask> m_TaskPool;
  17. private float m_Timeout;
  18. private EventHandler<WebRequestStartEventArgs> m_WebRequestStartEventHandler;
  19. private EventHandler<WebRequestSuccessEventArgs> m_WebRequestSuccessEventHandler;
  20. private EventHandler<WebRequestFailureEventArgs> m_WebRequestFailureEventHandler;
  21. /// <summary>
  22. /// 初始化 Web 请求管理器的新实例。
  23. /// </summary>
  24. public WebRequestManager()
  25. {
  26. m_TaskPool = new TaskPool<WebRequestTask>();
  27. m_Timeout = 30f;
  28. }
  29. /// <summary>
  30. /// 获取 Web 请求代理总数量。
  31. /// </summary>
  32. public int TotalAgentCount
  33. {
  34. get
  35. {
  36. return m_TaskPool.TotalAgentCount;
  37. }
  38. }
  39. /// <summary>
  40. /// 获取可用 Web 请求代理数量。
  41. /// </summary>
  42. public int FreeAgentCount
  43. {
  44. get
  45. {
  46. return m_TaskPool.FreeAgentCount;
  47. }
  48. }
  49. /// <summary>
  50. /// 获取工作中 Web 请求代理数量。
  51. /// </summary>
  52. public int WorkingAgentCount
  53. {
  54. get
  55. {
  56. return m_TaskPool.WorkingAgentCount;
  57. }
  58. }
  59. /// <summary>
  60. /// 获取等待 Web 请求数量。
  61. /// </summary>
  62. public int WaitingTaskCount
  63. {
  64. get
  65. {
  66. return m_TaskPool.WaitingTaskCount;
  67. }
  68. }
  69. /// <summary>
  70. /// 获取或设置 Web 请求超时时长,以秒为单位。
  71. /// </summary>
  72. public float Timeout
  73. {
  74. get
  75. {
  76. return m_Timeout;
  77. }
  78. set
  79. {
  80. m_Timeout = value;
  81. }
  82. }
  83. /// <summary>
  84. /// Web 请求开始事件。
  85. /// </summary>
  86. public event EventHandler<WebRequestStartEventArgs> WebRequestStart
  87. {
  88. add
  89. {
  90. m_WebRequestStartEventHandler += value;
  91. }
  92. remove
  93. {
  94. m_WebRequestStartEventHandler -= value;
  95. }
  96. }
  97. /// <summary>
  98. /// Web 请求成功事件。
  99. /// </summary>
  100. public event EventHandler<WebRequestSuccessEventArgs> WebRequestSuccess
  101. {
  102. add
  103. {
  104. m_WebRequestSuccessEventHandler += value;
  105. }
  106. remove
  107. {
  108. m_WebRequestSuccessEventHandler -= value;
  109. }
  110. }
  111. /// <summary>
  112. /// Web 请求失败事件。
  113. /// </summary>
  114. public event EventHandler<WebRequestFailureEventArgs> WebRequestFailure
  115. {
  116. add
  117. {
  118. m_WebRequestFailureEventHandler += value;
  119. }
  120. remove
  121. {
  122. m_WebRequestFailureEventHandler -= value;
  123. }
  124. }
  125. /// <summary>
  126. /// Web 请求管理器轮询。
  127. /// </summary>
  128. /// <param name="elapseSeconds">逻辑流逝时间,以秒为单位。</param>
  129. /// <param name="realElapseSeconds">真实流逝时间,以秒为单位。</param>
  130. internal override void Update(float elapseSeconds, float realElapseSeconds)
  131. {
  132. m_TaskPool.Update(elapseSeconds, realElapseSeconds);
  133. }
  134. /// <summary>
  135. /// 关闭并清理 Web 请求管理器。
  136. /// </summary>
  137. internal override void Shutdown()
  138. {
  139. m_TaskPool.Shutdown();
  140. }
  141. /// <summary>
  142. /// 增加 Web 请求代理辅助器。
  143. /// </summary>
  144. /// <param name="webRequestAgentHelper">要增加的 Web 请求代理辅助器。</param>
  145. public void AddWebRequestAgentHelper(IWebRequestAgentHelper webRequestAgentHelper)
  146. {
  147. WebRequestAgent agent = new WebRequestAgent(webRequestAgentHelper);
  148. agent.WebRequestAgentStart += OnWebRequestAgentStart;
  149. agent.WebRequestAgentSuccess += OnWebRequestAgentSuccess;
  150. agent.WebRequestAgentFailure += OnWebRequestAgentFailure;
  151. m_TaskPool.AddAgent(agent);
  152. }
  153. /// <summary>
  154. /// 根据 Web 请求任务的序列编号获取 Web 请求任务的信息。
  155. /// </summary>
  156. /// <param name="serialId">要获取信息的 Web 请求任务的序列编号。</param>
  157. /// <returns>Web 请求任务的信息。</returns>
  158. public TaskInfo GetWebRequestInfo(int serialId)
  159. {
  160. return m_TaskPool.GetTaskInfo(serialId);
  161. }
  162. /// <summary>
  163. /// 根据 Web 请求任务的标签获取 Web 请求任务的信息。
  164. /// </summary>
  165. /// <param name="tag">要获取信息的 Web 请求任务的标签。</param>
  166. /// <returns>Web 请求任务的信息。</returns>
  167. public TaskInfo[] GetWebRequestInfos(string tag)
  168. {
  169. return m_TaskPool.GetTaskInfos(tag);
  170. }
  171. /// <summary>
  172. /// 根据 Web 请求任务的标签获取 Web 请求任务的信息。
  173. /// </summary>
  174. /// <param name="tag">要获取信息的 Web 请求任务的标签。</param>
  175. /// <param name="results">Web 请求任务的信息。</param>
  176. public void GetAllWebRequestInfos(string tag, List<TaskInfo> results)
  177. {
  178. m_TaskPool.GetTaskInfos(tag, results);
  179. }
  180. /// <summary>
  181. /// 获取所有 Web 请求任务的信息。
  182. /// </summary>
  183. /// <returns>所有 Web 请求任务的信息。</returns>
  184. public TaskInfo[] GetAllWebRequestInfos()
  185. {
  186. return m_TaskPool.GetAllTaskInfos();
  187. }
  188. /// <summary>
  189. /// 获取所有 Web 请求任务的信息。
  190. /// </summary>
  191. /// <param name="results">所有 Web 请求任务的信息。</param>
  192. public void GetAllWebRequestInfos(List<TaskInfo> results)
  193. {
  194. m_TaskPool.GetAllTaskInfos(results);
  195. }
  196. /// <summary>
  197. /// 增加 Web 请求任务。
  198. /// </summary>
  199. /// <param name="webRequestUri">Web 请求地址。</param>
  200. /// <returns>新增 Web 请求任务的序列编号。</returns>
  201. public int AddWebRequest(string webRequestUri)
  202. {
  203. return AddWebRequest(webRequestUri, null, null, Constant.DefaultPriority, null);
  204. }
  205. /// <summary>
  206. /// 增加 Web 请求任务。
  207. /// </summary>
  208. /// <param name="webRequestUri">Web 请求地址。</param>
  209. /// <param name="postData">要发送的数据流。</param>
  210. /// <returns>新增 Web 请求任务的序列编号。</returns>
  211. public int AddWebRequest(string webRequestUri, byte[] postData)
  212. {
  213. return AddWebRequest(webRequestUri, postData, null, Constant.DefaultPriority, null);
  214. }
  215. /// <summary>
  216. /// 增加 Web 请求任务。
  217. /// </summary>
  218. /// <param name="webRequestUri">Web 请求地址。</param>
  219. /// <param name="tag">Web 请求任务的标签。</param>
  220. /// <returns>新增 Web 请求任务的序列编号。</returns>
  221. public int AddWebRequest(string webRequestUri, string tag)
  222. {
  223. return AddWebRequest(webRequestUri, null, tag, Constant.DefaultPriority, null);
  224. }
  225. /// <summary>
  226. /// 增加 Web 请求任务。
  227. /// </summary>
  228. /// <param name="webRequestUri">Web 请求地址。</param>
  229. /// <param name="priority">Web 请求任务的优先级。</param>
  230. /// <returns>新增 Web 请求任务的序列编号。</returns>
  231. public int AddWebRequest(string webRequestUri, int priority)
  232. {
  233. return AddWebRequest(webRequestUri, null, null, priority, null);
  234. }
  235. /// <summary>
  236. /// 增加 Web 请求任务。
  237. /// </summary>
  238. /// <param name="webRequestUri">Web 请求地址。</param>
  239. /// <param name="userData">用户自定义数据。</param>
  240. /// <returns>新增 Web 请求任务的序列编号。</returns>
  241. public int AddWebRequest(string webRequestUri, object userData)
  242. {
  243. return AddWebRequest(webRequestUri, null, null, Constant.DefaultPriority, userData);
  244. }
  245. /// <summary>
  246. /// 增加 Web 请求任务。
  247. /// </summary>
  248. /// <param name="webRequestUri">Web 请求地址。</param>
  249. /// <param name="postData">要发送的数据流。</param>
  250. /// <param name="tag">Web 请求任务的标签。</param>
  251. /// <returns>新增 Web 请求任务的序列编号。</returns>
  252. public int AddWebRequest(string webRequestUri, byte[] postData, string tag)
  253. {
  254. return AddWebRequest(webRequestUri, postData, tag, Constant.DefaultPriority, null);
  255. }
  256. /// <summary>
  257. /// 增加 Web 请求任务。
  258. /// </summary>
  259. /// <param name="webRequestUri">Web 请求地址。</param>
  260. /// <param name="postData">要发送的数据流。</param>
  261. /// <param name="priority">Web 请求任务的优先级。</param>
  262. /// <returns>新增 Web 请求任务的序列编号。</returns>
  263. public int AddWebRequest(string webRequestUri, byte[] postData, int priority)
  264. {
  265. return AddWebRequest(webRequestUri, postData, null, priority, null);
  266. }
  267. /// <summary>
  268. /// 增加 Web 请求任务。
  269. /// </summary>
  270. /// <param name="webRequestUri">Web 请求地址。</param>
  271. /// <param name="postData">要发送的数据流。</param>
  272. /// <param name="userData">用户自定义数据。</param>
  273. /// <returns>新增 Web 请求任务的序列编号。</returns>
  274. public int AddWebRequest(string webRequestUri, byte[] postData, object userData)
  275. {
  276. return AddWebRequest(webRequestUri, postData, null, Constant.DefaultPriority, userData);
  277. }
  278. /// <summary>
  279. /// 增加 Web 请求任务。
  280. /// </summary>
  281. /// <param name="webRequestUri">Web 请求地址。</param>
  282. /// <param name="tag">Web 请求任务的标签。</param>
  283. /// <param name="priority">Web 请求任务的优先级。</param>
  284. /// <returns>新增 Web 请求任务的序列编号。</returns>
  285. public int AddWebRequest(string webRequestUri, string tag, int priority)
  286. {
  287. return AddWebRequest(webRequestUri, null, tag, priority, null);
  288. }
  289. /// <summary>
  290. /// 增加 Web 请求任务。
  291. /// </summary>
  292. /// <param name="webRequestUri">Web 请求地址。</param>
  293. /// <param name="tag">Web 请求任务的标签。</param>
  294. /// <param name="userData">用户自定义数据。</param>
  295. /// <returns>新增 Web 请求任务的序列编号。</returns>
  296. public int AddWebRequest(string webRequestUri, string tag, object userData)
  297. {
  298. return AddWebRequest(webRequestUri, null, tag, Constant.DefaultPriority, userData);
  299. }
  300. /// <summary>
  301. /// 增加 Web 请求任务。
  302. /// </summary>
  303. /// <param name="webRequestUri">Web 请求地址。</param>
  304. /// <param name="priority">Web 请求任务的优先级。</param>
  305. /// <param name="userData">用户自定义数据。</param>
  306. /// <returns>新增 Web 请求任务的序列编号。</returns>
  307. public int AddWebRequest(string webRequestUri, int priority, object userData)
  308. {
  309. return AddWebRequest(webRequestUri, null, null, priority, userData);
  310. }
  311. /// <summary>
  312. /// 增加 Web 请求任务。
  313. /// </summary>
  314. /// <param name="webRequestUri">Web 请求地址。</param>
  315. /// <param name="postData">要发送的数据流。</param>
  316. /// <param name="tag">Web 请求任务的标签。</param>
  317. /// <param name="priority">Web 请求任务的优先级。</param>
  318. /// <returns>新增 Web 请求任务的序列编号。</returns>
  319. public int AddWebRequest(string webRequestUri, byte[] postData, string tag, int priority)
  320. {
  321. return AddWebRequest(webRequestUri, postData, tag, priority, null);
  322. }
  323. /// <summary>
  324. /// 增加 Web 请求任务。
  325. /// </summary>
  326. /// <param name="webRequestUri">Web 请求地址。</param>
  327. /// <param name="postData">要发送的数据流。</param>
  328. /// <param name="tag">Web 请求任务的标签。</param>
  329. /// <param name="userData">用户自定义数据。</param>
  330. /// <returns>新增 Web 请求任务的序列编号。</returns>
  331. public int AddWebRequest(string webRequestUri, byte[] postData, string tag, object userData)
  332. {
  333. return AddWebRequest(webRequestUri, postData, tag, Constant.DefaultPriority, userData);
  334. }
  335. /// <summary>
  336. /// 增加 Web 请求任务。
  337. /// </summary>
  338. /// <param name="webRequestUri">Web 请求地址。</param>
  339. /// <param name="postData">要发送的数据流。</param>
  340. /// <param name="priority">Web 请求任务的优先级。</param>
  341. /// <param name="userData">用户自定义数据。</param>
  342. /// <returns>新增 Web 请求任务的序列编号。</returns>
  343. public int AddWebRequest(string webRequestUri, byte[] postData, int priority, object userData)
  344. {
  345. return AddWebRequest(webRequestUri, postData, null, priority, userData);
  346. }
  347. /// <summary>
  348. /// 增加 Web 请求任务。
  349. /// </summary>
  350. /// <param name="webRequestUri">Web 请求地址。</param>
  351. /// <param name="tag">Web 请求任务的标签。</param>
  352. /// <param name="priority">Web 请求任务的优先级。</param>
  353. /// <param name="userData">用户自定义数据。</param>
  354. /// <returns>新增 Web 请求任务的序列编号。</returns>
  355. public int AddWebRequest(string webRequestUri, string tag, int priority, object userData)
  356. {
  357. return AddWebRequest(webRequestUri, null, tag, priority, userData);
  358. }
  359. /// <summary>
  360. /// 增加 Web 请求任务。
  361. /// </summary>
  362. /// <param name="webRequestUri">Web 请求地址。</param>
  363. /// <param name="postData">要发送的数据流。</param>
  364. /// <param name="tag">Web 请求任务的标签。</param>
  365. /// <param name="priority">Web 请求任务的优先级。</param>
  366. /// <param name="userData">用户自定义数据。</param>
  367. /// <returns>新增 Web 请求任务的序列编号。</returns>
  368. public int AddWebRequest(string webRequestUri, byte[] postData, string tag, int priority, object userData)
  369. {
  370. if (string.IsNullOrEmpty(webRequestUri))
  371. {
  372. throw new GameFrameworkException("Web request uri is invalid.");
  373. }
  374. if (TotalAgentCount <= 0)
  375. {
  376. throw new GameFrameworkException("You must add web request agent first.");
  377. }
  378. WebRequestTask webRequestTask = WebRequestTask.Create(webRequestUri, postData, tag, priority, m_Timeout, userData);
  379. m_TaskPool.AddTask(webRequestTask);
  380. return webRequestTask.SerialId;
  381. }
  382. /// <summary>
  383. /// 根据 Web 请求任务的序列编号移除 Web 请求任务。
  384. /// </summary>
  385. /// <param name="serialId">要移除 Web 请求任务的序列编号。</param>
  386. /// <returns>是否移除 Web 请求任务成功。</returns>
  387. public bool RemoveWebRequest(int serialId)
  388. {
  389. return m_TaskPool.RemoveTask(serialId);
  390. }
  391. /// <summary>
  392. /// 根据 Web 请求任务的标签移除 Web 请求任务。
  393. /// </summary>
  394. /// <param name="tag">要移除 Web 请求任务的标签。</param>
  395. /// <returns>移除 Web 请求任务的数量。</returns>
  396. public int RemoveWebRequests(string tag)
  397. {
  398. return m_TaskPool.RemoveTasks(tag);
  399. }
  400. /// <summary>
  401. /// 移除所有 Web 请求任务。
  402. /// </summary>
  403. /// <returns>移除 Web 请求任务的数量。</returns>
  404. public int RemoveAllWebRequests()
  405. {
  406. return m_TaskPool.RemoveAllTasks();
  407. }
  408. private void OnWebRequestAgentStart(WebRequestAgent sender)
  409. {
  410. if (m_WebRequestStartEventHandler != null)
  411. {
  412. WebRequestStartEventArgs webRequestStartEventArgs = WebRequestStartEventArgs.Create(sender.Task.SerialId, sender.Task.WebRequestUri, sender.Task.UserData);
  413. m_WebRequestStartEventHandler(this, webRequestStartEventArgs);
  414. ReferencePool.Release(webRequestStartEventArgs);
  415. }
  416. }
  417. private void OnWebRequestAgentSuccess(WebRequestAgent sender, byte[] webResponseBytes)
  418. {
  419. if (m_WebRequestSuccessEventHandler != null)
  420. {
  421. WebRequestSuccessEventArgs webRequestSuccessEventArgs = WebRequestSuccessEventArgs.Create(sender.Task.SerialId, sender.Task.WebRequestUri, webResponseBytes, sender.Task.UserData);
  422. m_WebRequestSuccessEventHandler(this, webRequestSuccessEventArgs);
  423. ReferencePool.Release(webRequestSuccessEventArgs);
  424. }
  425. }
  426. private void OnWebRequestAgentFailure(WebRequestAgent sender, string errorMessage)
  427. {
  428. if (m_WebRequestFailureEventHandler != null)
  429. {
  430. WebRequestFailureEventArgs webRequestFailureEventArgs = WebRequestFailureEventArgs.Create(sender.Task.SerialId, sender.Task.WebRequestUri, errorMessage, sender.Task.UserData);
  431. m_WebRequestFailureEventHandler(this, webRequestFailureEventArgs);
  432. ReferencePool.Release(webRequestFailureEventArgs);
  433. }
  434. }
  435. }
  436. }