mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-28 23:52:36 +01:00
Deploy code docs to GitHub Pages for workflow run 3273
Commit: 074d1d0e4b
This commit is contained in:
tgstation-server-ci[bot]
@@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.9.5"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>tgstation-server: src/Tgstation.Server.Host/Security/IdentityCacheObject.cs Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -30,7 +30,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.5 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
@@ -47,6 +47,11 @@ $(function() {
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function() { init_codefold(0); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
@@ -85,7 +90,8 @@ $(function() {
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html"> 12</a></span> sealed <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html">IdentityCacheObject</a> : <a class="code hl_class" href="class_i_async_disposable.html">IAsyncDisposable</a></div>
|
||||
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html"> 12</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html">IdentityCacheObject</a> : <a class="code hl_class" href="class_i_async_disposable.html">IAsyncDisposable</a></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> {</div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a86a823a9e7ee94f2497bfae86c1efeed"> 17</a></span> <span class="keyword">public</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">ISystemIdentity</a> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a86a823a9e7ee94f2497bfae86c1efeed">SystemIdentity</a> { <span class="keyword">get</span>; }</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
||||
@@ -93,6 +99,7 @@ $(function() {
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee"> 27</a></span> readonly Task <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee">task</a>;</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
||||
<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a77e5495fa90b8eed2f2d86c6fb711da8"> 36</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a77e5495fa90b8eed2f2d86c6fb711da8">IdentityCacheObject</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">ISystemIdentity</a> systemIdentity, <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer.html">IAsyncDelayer</a> asyncDelayer, Action onExpiry, DateTimeOffset expiry)</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> {</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a86a823a9e7ee94f2497bfae86c1efeed">SystemIdentity</a> = systemIdentity ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(systemIdentity));</div>
|
||||
@@ -124,31 +131,35 @@ $(function() {
|
||||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
||||
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee">task</a> = DisposeOnExipiry(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#ac8422fda839cd16fd8b467bb4947f8a1">cancellationTokenSource</a>.Token);</div>
|
||||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
||||
<div class="foldopen" id="foldopen00069" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a9c1da3c83acd4488eb0bd222df31e3ac"> 69</a></span> <span class="keyword">public</span> async ValueTask <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a9c1da3c83acd4488eb0bd222df31e3ac">DisposeAsync</a>()</div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> {</div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#ac8422fda839cd16fd8b467bb4947f8a1">cancellationTokenSource</a>.Cancel();</div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#ac8422fda839cd16fd8b467bb4947f8a1">cancellationTokenSource</a>.Dispose();</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> await <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee">task</a>;</div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
|
||||
<div class="ttc" id="aclass_i_async_disposable_html"><div class="ttname"><a href="class_i_async_disposable.html">IAsyncDisposable</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html">Tgstation.Server.Host.Security.IdentityCacheObject</a></div><div class="ttdoc">For keeping a specific ISystemIdentity alive for a period of time.</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00012">IdentityCacheObject.cs:13</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a2d1a4fc7b7fee56456ccebfb699ad8ee"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee">Tgstation.Server.Host.Security.IdentityCacheObject.task</a></div><div class="ttdeci">readonly Task task</div><div class="ttdoc">The Task to clean up SystemIdentity.</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00027">IdentityCacheObject.cs:27</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a77e5495fa90b8eed2f2d86c6fb711da8"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a77e5495fa90b8eed2f2d86c6fb711da8">Tgstation.Server.Host.Security.IdentityCacheObject.IdentityCacheObject</a></div><div class="ttdeci">IdentityCacheObject(ISystemIdentity systemIdentity, IAsyncDelayer asyncDelayer, Action onExpiry, DateTimeOffset expiry)</div><div class="ttdoc">Initializes a new instance of the IdentityCacheObject class.</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00036">IdentityCacheObject.cs:36</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a86a823a9e7ee94f2497bfae86c1efeed"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a86a823a9e7ee94f2497bfae86c1efeed">Tgstation.Server.Host.Security.IdentityCacheObject.SystemIdentity</a></div><div class="ttdeci">ISystemIdentity SystemIdentity</div><div class="ttdoc">The ISystemIdentity the IdentityCache manages.</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00017">IdentityCacheObject.cs:17</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a9c1da3c83acd4488eb0bd222df31e3ac"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a9c1da3c83acd4488eb0bd222df31e3ac">Tgstation.Server.Host.Security.IdentityCacheObject.DisposeAsync</a></div><div class="ttdeci">async ValueTask DisposeAsync()</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00069">IdentityCacheObject.cs:69</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_ac8422fda839cd16fd8b467bb4947f8a1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#ac8422fda839cd16fd8b467bb4947f8a1">Tgstation.Server.Host.Security.IdentityCacheObject.cancellationTokenSource</a></div><div class="ttdeci">readonly CancellationTokenSource cancellationTokenSource</div><div class="ttdoc">The cancellationTokenSource for the IdentityCache.</div><div class="ttdef"><b>Definition:</b> <a href="_identity_cache_object_8cs_source.html#l00022">IdentityCacheObject.cs:22</a></div></div>
|
||||
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">Tgstation.Server.Host.Security.ISystemIdentity</a></div><div class="ttdoc">Represents a user on the current global::System.Runtime.InteropServices.OSPlatform.</div><div class="ttdef"><b>Definition:</b> <a href="_i_system_identity_8cs_source.html#l00010">ISystemIdentity.cs:11</a></div></div>
|
||||
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer.html">Tgstation.Server.Host.Utils.IAsyncDelayer</a></div><div class="ttdoc">For waiting asynchronously.</div><div class="ttdef"><b>Definition:</b> <a href="_i_async_delayer_8cs_source.html#l00010">IAsyncDelayer.cs:11</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html">Tgstation.Server.Host.Security.IdentityCacheObject</a></div><div class="ttdoc">For keeping a specific ISystemIdentity alive for a period of time.</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00012">IdentityCacheObject.cs:13</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a2d1a4fc7b7fee56456ccebfb699ad8ee"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a2d1a4fc7b7fee56456ccebfb699ad8ee">Tgstation.Server.Host.Security.IdentityCacheObject.task</a></div><div class="ttdeci">readonly Task task</div><div class="ttdoc">The Task to clean up SystemIdentity.</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00027">IdentityCacheObject.cs:27</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a77e5495fa90b8eed2f2d86c6fb711da8"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a77e5495fa90b8eed2f2d86c6fb711da8">Tgstation.Server.Host.Security.IdentityCacheObject.IdentityCacheObject</a></div><div class="ttdeci">IdentityCacheObject(ISystemIdentity systemIdentity, IAsyncDelayer asyncDelayer, Action onExpiry, DateTimeOffset expiry)</div><div class="ttdoc">Initializes a new instance of the IdentityCacheObject class.</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00036">IdentityCacheObject.cs:36</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a86a823a9e7ee94f2497bfae86c1efeed"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a86a823a9e7ee94f2497bfae86c1efeed">Tgstation.Server.Host.Security.IdentityCacheObject.SystemIdentity</a></div><div class="ttdeci">ISystemIdentity SystemIdentity</div><div class="ttdoc">The ISystemIdentity the IdentityCache manages.</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00017">IdentityCacheObject.cs:17</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_a9c1da3c83acd4488eb0bd222df31e3ac"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#a9c1da3c83acd4488eb0bd222df31e3ac">Tgstation.Server.Host.Security.IdentityCacheObject.DisposeAsync</a></div><div class="ttdeci">async ValueTask DisposeAsync()</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00069">IdentityCacheObject.cs:69</a></div></div>
|
||||
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object_html_ac8422fda839cd16fd8b467bb4947f8a1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_identity_cache_object.html#ac8422fda839cd16fd8b467bb4947f8a1">Tgstation.Server.Host.Security.IdentityCacheObject.cancellationTokenSource</a></div><div class="ttdeci">readonly CancellationTokenSource cancellationTokenSource</div><div class="ttdoc">The cancellationTokenSource for the IdentityCache.</div><div class="ttdef"><b>Definition</b> <a href="_identity_cache_object_8cs_source.html#l00022">IdentityCacheObject.cs:22</a></div></div>
|
||||
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_system_identity.html">Tgstation.Server.Host.Security.ISystemIdentity</a></div><div class="ttdoc">Represents a user on the current global::System.Runtime.InteropServices.OSPlatform.</div><div class="ttdef"><b>Definition</b> <a href="_i_system_identity_8cs_source.html#l00010">ISystemIdentity.cs:11</a></div></div>
|
||||
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer.html">Tgstation.Server.Host.Utils.IAsyncDelayer</a></div><div class="ttdoc">For waiting asynchronously.</div><div class="ttdef"><b>Definition</b> <a href="_i_async_delayer_8cs_source.html#l00010">IAsyncDelayer.cs:11</a></div></div>
|
||||
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer_html_aeb604334bd297d47506dc23e0d115977"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_async_delayer.html#aeb604334bd297d47506dc23e0d115977">Tgstation.Server.Host.Utils.IAsyncDelayer.Delay</a></div><div class="ttdeci">Task Delay(TimeSpan timeSpan, CancellationToken cancellationToken)</div><div class="ttdoc">Create a Task that completes after a given timeSpan .</div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a></div><div class="ttdef"><b>Definition:</b> <a href="_abstract_http_client_factory_8cs_source.html#l00009">AbstractHttpClientFactory.cs:10</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>
|
||||
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a></div><div class="ttdef"><b>Definition</b> <a href="_abstract_http_client_factory_8cs_source.html#l00009">AbstractHttpClientFactory.cs:10</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
||||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user