cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_database_context_factory_8cs_source.html
T

144 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Database/DatabaseContextFactory.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_3a3ab2f663730d5bed7026cf41734e8a.html">Database</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">DatabaseContextFactory.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_database_context_factory_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>Microsoft.Extensions.DependencyInjection;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span>{</div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html"> 9</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_database_1_1_database_context_factory.html">DatabaseContextFactory</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_factory.html">IDatabaseContextFactory</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2"> 14</a></span> readonly IServiceScopeFactory <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="}">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#ac543a4e3bf61cec7ef0cee9abab7d0e4"> 20</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#ac543a4e3bf61cec7ef0cee9abab7d0e4">DatabaseContextFactory</a>(IServiceScopeFactory <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>)</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> this.scopeFactory = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>));</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">using </span>var scope = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>.CreateScope();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> scope.ServiceProvider.GetRequiredService&lt;<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a>&gt;();</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> }</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#aa0f2badeb4e28beb151ff0046c5be2cd"> 29</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_database_1_1_database_context_factory.html#aa0f2badeb4e28beb151ff0046c5be2cd">UseContext</a>(Func&lt;IDatabaseContext, ValueTask&gt; operation)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> ArgumentNullException.ThrowIfNull(operation);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> await <span class="keyword">using </span>var scope = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>.CreateAsyncScope();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> await operation(scope.ServiceProvider.GetRequiredService&lt;<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a>&gt;());</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#abe7674bde9f2ac573f91d994b5ca3421"> 38</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_database_1_1_database_context_factory.html#abe7674bde9f2ac573f91d994b5ca3421">UseContextTaskReturn</a>(Func&lt;IDatabaseContext, Task&gt; operation)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> ArgumentNullException.ThrowIfNull(operation);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> await <span class="keyword">using </span>var scope = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">scopeFactory</a>.CreateAsyncScope();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> await operation(scope.ServiceProvider.GetRequiredService&lt;<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a>&gt;());</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html">Tgstation.Server.Host.Database.DatabaseContextFactory</a></div><div class="ttdef"><b>Definition</b> <a href="_database_context_factory_8cs_source.html#l00009">DatabaseContextFactory.cs:10</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory_html_a82349a843b7d53e907fbdcfd46bf91d2"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#a82349a843b7d53e907fbdcfd46bf91d2">Tgstation.Server.Host.Database.DatabaseContextFactory.scopeFactory</a></div><div class="ttdeci">readonly IServiceScopeFactory scopeFactory</div><div class="ttdoc">The IServiceScopeFactory for the DatabaseContextFactory.</div><div class="ttdef"><b>Definition</b> <a href="_database_context_factory_8cs_source.html#l00014">DatabaseContextFactory.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory_html_aa0f2badeb4e28beb151ff0046c5be2cd"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#aa0f2badeb4e28beb151ff0046c5be2cd">Tgstation.Server.Host.Database.DatabaseContextFactory.UseContext</a></div><div class="ttdeci">async ValueTask UseContext(Func&lt; IDatabaseContext, ValueTask &gt; operation)</div><div class="ttdoc">Run an operation in the scope of an IDatabaseContext.A ValueTask representing the running operation ...</div><div class="ttdef"><b>Definition</b> <a href="_database_context_factory_8cs_source.html#l00029">DatabaseContextFactory.cs:29</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory_html_abe7674bde9f2ac573f91d994b5ca3421"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#abe7674bde9f2ac573f91d994b5ca3421">Tgstation.Server.Host.Database.DatabaseContextFactory.UseContextTaskReturn</a></div><div class="ttdeci">async ValueTask UseContextTaskReturn(Func&lt; IDatabaseContext, Task &gt; operation)</div><div class="ttdoc">Run an operation in the scope of an IDatabaseContext.A ValueTask representing the running operation ...</div><div class="ttdef"><b>Definition</b> <a href="_database_context_factory_8cs_source.html#l00038">DatabaseContextFactory.cs:38</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory_html_ac543a4e3bf61cec7ef0cee9abab7d0e4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_factory.html#ac543a4e3bf61cec7ef0cee9abab7d0e4">Tgstation.Server.Host.Database.DatabaseContextFactory.DatabaseContextFactory</a></div><div class="ttdeci">DatabaseContextFactory(IServiceScopeFactory scopeFactory)</div><div class="ttdoc">Initializes a new instance of the DatabaseContextFactory class.</div><div class="ttdef"><b>Definition</b> <a href="_database_context_factory_8cs_source.html#l00020">DatabaseContextFactory.cs:20</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_factory.html">Tgstation.Server.Host.Database.IDatabaseContextFactory</a></div><div class="ttdoc">Factory for scoping usage of IDatabaseContexts. Meant for use by Components.</div><div class="ttdef"><b>Definition</b> <a href="_i_database_context_factory_8cs_source.html#l00009">IDatabaseContextFactory.cs:10</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">Tgstation.Server.Host.Database.IDatabaseContext</a></div><div class="ttdoc">Represents the database.</div><div class="ttdef"><b>Definition</b> <a href="_i_database_context_8cs_source.html#l00016">IDatabaseContext.cs:17</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_database_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a></div><div class="ttdef"><b>Definition</b> <a href="_database_collection_8cs_source.html#l00009">DatabaseCollection.cs:10</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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 View Git Blame Copy Permalink