mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 15:01:52 -05:00
76 lines
4 KiB
Markdown
76 lines
4 KiB
Markdown
# Pool<T> Class
|
|
|
|
|
|
A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type *T*.
|
|
|
|
|
|
|
|
## Definition
|
|
**Namespace:** <a href="N_CapyKit">CapyKit</a>
|
|
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
|
|
|
|
**C#**
|
|
``` C#
|
|
public class Pool<T>
|
|
|
|
```
|
|
**F#**
|
|
``` F#
|
|
type Pool<'T> = class end
|
|
```
|
|
|
|
<table><tr><td><strong>Inheritance</strong></td><td><a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> → Pool(T)</td></tr>
|
|
</table>
|
|
|
|
|
|
|
|
#### Type Parameters
|
|
<dl><dt /><dd>The type of objects to be managed by the pool.</dd></dl>
|
|
|
|
## Constructors
|
|
<table>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Pool_1__ctor">Pool(T)(IEnumerable(T))</a></td>
|
|
<td>Initializes a new instance of the Pool(T) class with the specified collection of items.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Pool_1__ctor_1">Pool(T)(Int32)</a></td>
|
|
<td>Initializes a new instance of the Pool(T) class with the specified pool size.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Pool_1__ctor_2">Pool(T)(Int32, Func(T))</a></td>
|
|
<td>Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.</td></tr>
|
|
</table>
|
|
|
|
## Methods
|
|
<table>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)" target="_blank" rel="noopener noreferrer">Equals</a></td>
|
|
<td>Determines whether the specified object is equal to the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td>
|
|
<td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Pool_1_GetAvailableItem">GetAvailableItem</a></td>
|
|
<td>Gets the first available item from the pool and sets its lock.</td></tr>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
|
|
<td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td>
|
|
<td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td>
|
|
<td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Pool_1_ReleaseItem">ReleaseItem</a></td>
|
|
<td>Releases the lock on the specified item and returns it to the pool.</td></tr>
|
|
<tr>
|
|
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
|
|
<td>Returns a string that represents the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
|
|
</table>
|
|
|
|
## See Also
|
|
|
|
|
|
#### Reference
|
|
<a href="N_CapyKit">CapyKit Namespace</a>
|