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/_fetch_options_extensions_8cs_source.html
T

177 lines
19 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/Extensions/FetchOptionsExtensions.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_5ae0a4770cfe9bc511dad7df7deabb23.html">Extensions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">FetchOptionsExtensions.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_fetch_options_extensions_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;</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>LibGit2Sharp;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>LibGit2Sharp.Handlers;</div>
<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">using </span>Microsoft.Extensions.Logging;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_jobs.html">Tgstation.Server.Host.Jobs</a>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html"> 16</a></span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html">FetchOptionsExtensions</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<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_extensions_1_1_fetch_options_extensions.html#aee0e1a7712aa907faf658940322b8478"> 27</a></span> <span class="keyword">public</span> <span class="keyword">static</span> FetchOptions <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#aee0e1a7712aa907faf658940322b8478">Hydrate</a>(</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">this</span> FetchOptions fetchOptions,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ILogger logger,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html">JobProgressReporter</a> progressReporter,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> CredentialsHandler credentialsHandler,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> CancellationToken cancellationToken)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> ArgumentNullException.ThrowIfNull(fetchOptions);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ArgumentNullException.ThrowIfNull(logger);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> fetchOptions.OnProgress = _ =&gt; !cancellationToken.IsCancellationRequested;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> fetchOptions.OnTransferProgress = transferProgress =&gt;</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> <span class="keywordflow">if</span> (progressReporter != <span class="keyword">null</span>)</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> var percentage = ((double)transferProgress.IndexedObjects + transferProgress.ReceivedObjects) / (transferProgress.TotalObjects * 2);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> progressReporter.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html#ac736a80d9d56a20711468d9b8e27e3c1">ReportProgress</a>(percentage);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> !cancellationToken.IsCancellationRequested;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> };</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> fetchOptions.OnUpdateTips = (_, _, _) =&gt; !cancellationToken.IsCancellationRequested;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> fetchOptions.CredentialsProvider = credentialsHandler;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> fetchOptions.RepositoryOperationStarting = _ =&gt; !cancellationToken.IsCancellationRequested;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> fetchOptions.OnTransferProgress = <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#ad2b564fc1ab3f6caf84958bc85d5236a">TransferProgressHandler</a>(</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> logger,</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> progressReporter,</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> cancellationToken);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> fetchOptions;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div>
</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#ad2b564fc1ab3f6caf84958bc85d5236a"> 66</a></span> <span class="keyword">static</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#ad2b564fc1ab3f6caf84958bc85d5236a">TransferProgressHandler</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#ad2b564fc1ab3f6caf84958bc85d5236a">TransferProgressHandler</a>(ILogger logger, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html">JobProgressReporter</a> progressReporter, CancellationToken cancellationToken) =&gt; transferProgress =&gt;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">double</span>? percentage;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> var totalObjectsToProcess = transferProgress.TotalObjects * 2;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> var processedObjects = transferProgress.IndexedObjects + transferProgress.ReceivedObjects;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">if</span> (totalObjectsToProcess &lt; processedObjects || totalObjectsToProcess == 0)</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> percentage = <span class="keyword">null</span>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> {</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> percentage = (double)processedObjects / totalObjectsToProcess;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">if</span> (percentage &lt; 0)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> percentage = <span class="keyword">null</span>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordflow">if</span> (percentage == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> logger.LogDebug(</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="stringliteral">&quot;Bad transfer progress values (Please tell Cyberboss)! Indexed: {indexed}, Received: {received}, Total: {total}&quot;</span>,</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> transferProgress.IndexedObjects,</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> transferProgress.ReceivedObjects,</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> transferProgress.TotalObjects);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> progressReporter?.ReportProgress(percentage);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> !cancellationToken.IsCancellationRequested;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> };</div>
</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> }</div>
</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html">Tgstation.Server.Host.Extensions.FetchOptionsExtensions</a></div><div class="ttdoc">Extension methods for FetchOptions.</div><div class="ttdef"><b>Definition</b> <a href="_fetch_options_extensions_8cs_source.html#l00016">FetchOptionsExtensions.cs:17</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions_html_ad2b564fc1ab3f6caf84958bc85d5236a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#ad2b564fc1ab3f6caf84958bc85d5236a">Tgstation.Server.Host.Extensions.FetchOptionsExtensions.TransferProgressHandler</a></div><div class="ttdeci">static TransferProgressHandler TransferProgressHandler(ILogger logger, JobProgressReporter progressReporter, CancellationToken cancellationToken)</div><div class="ttdoc">Generate a LibGit2Sharp.Handlers.TransferProgressHandler from a given progressReporter and cancellat...</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions_html_aee0e1a7712aa907faf658940322b8478"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_fetch_options_extensions.html#aee0e1a7712aa907faf658940322b8478">Tgstation.Server.Host.Extensions.FetchOptionsExtensions.Hydrate</a></div><div class="ttdeci">static FetchOptions Hydrate(this FetchOptions fetchOptions, ILogger logger, JobProgressReporter progressReporter, CredentialsHandler credentialsHandler, CancellationToken cancellationToken)</div><div class="ttdoc">Hydrate a given set of fetchOptions .</div><div class="ttdef"><b>Definition</b> <a href="_fetch_options_extensions_8cs_source.html#l00027">FetchOptionsExtensions.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html">Tgstation.Server.Host.Jobs.JobProgressReporter</a></div><div class="ttdoc">Progress reporter for a Job.</div><div class="ttdef"><b>Definition</b> <a href="_job_progress_reporter_8cs_source.html#l00013">JobProgressReporter.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter_html_ac736a80d9d56a20711468d9b8e27e3c1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_progress_reporter.html#ac736a80d9d56a20711468d9b8e27e3c1">Tgstation.Server.Host.Jobs.JobProgressReporter.ReportProgress</a></div><div class="ttdeci">void ReportProgress(double? progress)</div><div class="ttdoc">Report progress.</div><div class="ttdef"><b>Definition</b> <a href="_job_progress_reporter_8cs_source.html#l00137">JobProgressReporter.cs:137</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_extensions.html">Tgstation.Server.Host.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_application_builder_extensions_8cs_source.html#l00021">ApplicationBuilderExtensions.cs:22</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_jobs_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_jobs.html">Tgstation.Server.Host.Jobs</a></div><div class="ttdef"><b>Definition</b> <a href="_i_job_manager_8cs_source.html#l00007">IJobManager.cs:8</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