IObjectPool.cs 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  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. namespace GameFramework.ObjectPool
  9. {
  10. /// <summary>
  11. /// 对象池接口。
  12. /// </summary>
  13. /// <typeparam name="T">对象类型。</typeparam>
  14. public interface IObjectPool<T> where T : ObjectBase
  15. {
  16. /// <summary>
  17. /// 获取对象池名称。
  18. /// </summary>
  19. string Name
  20. {
  21. get;
  22. }
  23. /// <summary>
  24. /// 获取对象池完整名称。
  25. /// </summary>
  26. string FullName
  27. {
  28. get;
  29. }
  30. /// <summary>
  31. /// 获取对象池对象类型。
  32. /// </summary>
  33. Type ObjectType
  34. {
  35. get;
  36. }
  37. /// <summary>
  38. /// 获取对象池中对象的数量。
  39. /// </summary>
  40. int Count
  41. {
  42. get;
  43. }
  44. /// <summary>
  45. /// 获取对象池中能被释放的对象的数量。
  46. /// </summary>
  47. int CanReleaseCount
  48. {
  49. get;
  50. }
  51. /// <summary>
  52. /// 获取是否允许对象被多次获取。
  53. /// </summary>
  54. bool AllowMultiSpawn
  55. {
  56. get;
  57. }
  58. /// <summary>
  59. /// 获取或设置对象池自动释放可释放对象的间隔秒数。
  60. /// </summary>
  61. float AutoReleaseInterval
  62. {
  63. get;
  64. set;
  65. }
  66. /// <summary>
  67. /// 获取或设置对象池的容量。
  68. /// </summary>
  69. int Capacity
  70. {
  71. get;
  72. set;
  73. }
  74. /// <summary>
  75. /// 获取或设置对象池对象过期秒数。
  76. /// </summary>
  77. float ExpireTime
  78. {
  79. get;
  80. set;
  81. }
  82. /// <summary>
  83. /// 获取或设置对象池的优先级。
  84. /// </summary>
  85. int Priority
  86. {
  87. get;
  88. set;
  89. }
  90. /// <summary>
  91. /// 创建对象。
  92. /// </summary>
  93. /// <param name="obj">对象。</param>
  94. /// <param name="spawned">对象是否已被获取。</param>
  95. void Register(T obj, bool spawned);
  96. /// <summary>
  97. /// 检查对象。
  98. /// </summary>
  99. /// <returns>要检查的对象是否存在。</returns>
  100. bool CanSpawn();
  101. /// <summary>
  102. /// 检查对象。
  103. /// </summary>
  104. /// <param name="name">对象名称。</param>
  105. /// <returns>要检查的对象是否存在。</returns>
  106. bool CanSpawn(string name);
  107. /// <summary>
  108. /// 获取对象。
  109. /// </summary>
  110. /// <returns>要获取的对象。</returns>
  111. T Spawn();
  112. /// <summary>
  113. /// 获取对象。
  114. /// </summary>
  115. /// <param name="name">对象名称。</param>
  116. /// <returns>要获取的对象。</returns>
  117. T Spawn(string name);
  118. /// <summary>
  119. /// 回收对象。
  120. /// </summary>
  121. /// <param name="obj">要回收的对象。</param>
  122. void Unspawn(T obj);
  123. /// <summary>
  124. /// 回收对象。
  125. /// </summary>
  126. /// <param name="target">要回收的对象。</param>
  127. void Unspawn(object target);
  128. /// <summary>
  129. /// 设置对象是否被加锁。
  130. /// </summary>
  131. /// <param name="obj">要设置被加锁的对象。</param>
  132. /// <param name="locked">是否被加锁。</param>
  133. void SetLocked(T obj, bool locked);
  134. /// <summary>
  135. /// 设置对象是否被加锁。
  136. /// </summary>
  137. /// <param name="target">要设置被加锁的对象。</param>
  138. /// <param name="locked">是否被加锁。</param>
  139. void SetLocked(object target, bool locked);
  140. /// <summary>
  141. /// 设置对象的优先级。
  142. /// </summary>
  143. /// <param name="obj">要设置优先级的对象。</param>
  144. /// <param name="priority">优先级。</param>
  145. void SetPriority(T obj, int priority);
  146. /// <summary>
  147. /// 设置对象的优先级。
  148. /// </summary>
  149. /// <param name="target">要设置优先级的对象。</param>
  150. /// <param name="priority">优先级。</param>
  151. void SetPriority(object target, int priority);
  152. /// <summary>
  153. /// 释放对象。
  154. /// </summary>
  155. /// <param name="obj">要释放的对象。</param>
  156. /// <returns>释放对象是否成功。</returns>
  157. bool ReleaseObject(T obj);
  158. /// <summary>
  159. /// 释放对象。
  160. /// </summary>
  161. /// <param name="target">要释放的对象。</param>
  162. /// <returns>释放对象是否成功。</returns>
  163. bool ReleaseObject(object target);
  164. /// <summary>
  165. /// 释放对象池中的可释放对象。
  166. /// </summary>
  167. void Release();
  168. /// <summary>
  169. /// 释放对象池中的可释放对象。
  170. /// </summary>
  171. /// <param name="toReleaseCount">尝试释放对象数量。</param>
  172. void Release(int toReleaseCount);
  173. /// <summary>
  174. /// 释放对象池中的可释放对象。
  175. /// </summary>
  176. /// <param name="releaseObjectFilterCallback">释放对象筛选函数。</param>
  177. void Release(ReleaseObjectFilterCallback<T> releaseObjectFilterCallback);
  178. /// <summary>
  179. /// 释放对象池中的可释放对象。
  180. /// </summary>
  181. /// <param name="toReleaseCount">尝试释放对象数量。</param>
  182. /// <param name="releaseObjectFilterCallback">释放对象筛选函数。</param>
  183. void Release(int toReleaseCount, ReleaseObjectFilterCallback<T> releaseObjectFilterCallback);
  184. /// <summary>
  185. /// 释放对象池中的所有未使用对象。
  186. /// </summary>
  187. void ReleaseAllUnused();
  188. }
  189. }