Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Pool<T> | CapyKit Documentation </title>
|
||||
<title> Class Pool<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Pool<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class Pool<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type T.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,276 +70,83 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Pool`1">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Pool_1"> Class Pool<T></h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Pool_1" data-uid="CapyKit.Pool`1" class="text-break">
|
||||
Class Pool<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
objects of type <code class="typeparamref">T</code>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Pool<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of objects to be managed by the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Pool<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__" data-uid="CapyKit.Pool`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
||||
Pool(IEnumerable<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified collection
|
||||
of items.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(IEnumerable<T> collection)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>collection</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_" data-uid="CapyKit.Pool`1.#ctor(System.Int32)">
|
||||
Pool(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified pool size.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(int poolSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>poolSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The size of the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__" data-uid="CapyKit.Pool`1.#ctor(System.Int32,System.Func{`0})">
|
||||
Pool(int, Func<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified pool size
|
||||
<pre><code class="lang-csharp">public class Pool<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of objects to be managed by the pool.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pool<T>>(Pool<T>, Pool<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_"> Pool(int)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size.</p>
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__"> Pool(int, Func<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size
|
||||
and constructor selector.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(int poolSize, Func<T> constructorSelector)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>poolSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The size of the pool.</p>
|
||||
</dd>
|
||||
<dt><code>constructorSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></dt>
|
||||
<dd><p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1_GetAvailableItem_" data-uid="CapyKit.Pool`1.GetAvailableItem*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1_GetAvailableItem" data-uid="CapyKit.Pool`1.GetAvailableItem">
|
||||
GetAvailableItem()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the first available item from the pool and sets its lock.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PoolItem<T> GetAvailableItem()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.PoolItem-1.html">PoolItem</a><T></dt>
|
||||
<dd><p>The first available item from the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1_ReleaseItem_" data-uid="CapyKit.Pool`1.ReleaseItem*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__" data-uid="CapyKit.Pool`1.ReleaseItem(CapyKit.PoolItem{`0})">
|
||||
ReleaseItem(PoolItem<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Releases the lock on the specified item and returns it to the pool.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void ReleaseItem(PoolItem<T> item)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>item</code> <a class="xref" href="CapyKit.PoolItem-1.html">PoolItem</a><T></dt>
|
||||
<dd><p>The item to release.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0___remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method sets the <a class="xref" href="CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_Locked">Locked</a> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
|
||||
it can be retrieved by <a class="xref" href="CapyKit.Pool-1.html#CapyKit_Pool_1_GetAvailableItem">GetAvailableItem()</a>.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize, Func<T> constructorSelector)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<p><code>constructorSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></p>
|
||||
<p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__"> Pool(IEnumerable<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified collection
|
||||
of items.</p>
|
||||
<pre><code class="lang-csharp">public Pool(IEnumerable<T> collection)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>collection</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Pool_1_GetAvailableItem"> GetAvailableItem()</h3>
|
||||
<p>Gets the first available item from the pool and sets its lock.</p>
|
||||
<pre><code class="lang-csharp">public PoolItem<T> GetAvailableItem()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The first available item from the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__"> ReleaseItem(PoolItem<T>)</h3>
|
||||
<p>Releases the lock on the specified item and returns it to the pool.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseItem(PoolItem<T> item)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>item</code> <a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The item to release.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method sets the <span class="xref">CapyKit.PoolItem`1.Locked</span> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
|
||||
it can be retrieved by <span class="xref">CapyKit.Pool`1.GetAvailableItem</span>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue