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

172 lines
18 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/Controllers/Results/LimitedStreamResultExecutor.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_38cec1532eaed7aa1de0b599a76e3e80.html">Controllers</a></li><li class="navelem"><a class="el" href="dir_a13f130ab75633c98a973b4116486bde.html">Results</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">LimitedStreamResultExecutor.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_limited_stream_result_executor_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.IO;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading.Tasks;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>Microsoft.AspNetCore.Http.Extensions;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>Microsoft.AspNetCore.Mvc;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>Microsoft.AspNetCore.Mvc.Infrastructure;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using </span>Microsoft.Extensions.Logging;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results.html">Tgstation.Server.Host.Controllers.Results</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html"> 15</a></span> <span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html">LimitedStreamResultExecutor</a> : <a class="code hl_class" href="class_file_result_executor_base.html">FileResultExecutorBase</a>, <a class="code hl_class" href="class_i_action_result_executor.html">IActionResultExecutor</a>&lt;LimitedStreamResult&gt;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html#a1580d6734eae31ef251dca95d8f5d0ef"> 21</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html#a1580d6734eae31ef251dca95d8f5d0ef">LimitedStreamResultExecutor</a>(ILogger&lt;LimitedStreamResultExecutor&gt; logger)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> : base(logger)</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> }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</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_controllers_1_1_results_1_1_limited_stream_result_executor.html#ab5ef22f22bfb04f0bedd88eaa468bc33"> 27</a></span> <span class="keyword">public</span> async Task <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html#ab5ef22f22bfb04f0bedd88eaa468bc33">ExecuteAsync</a>(ActionContext context, <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result.html">LimitedStreamResult</a> result)</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ArgumentNullException.ThrowIfNull(context);</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(result);</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> (result)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> var cancellationToken = context.HttpContext.RequestAborted;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> var stream = await result.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result.html#a7a426c34eac3920d440ac4ae0c93f62a">GetResult</a>(cancellationToken);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> var contentLength = stream.Length;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> var (range, rangeLength, serveBody) = SetHeadersAndLog(context, result, contentLength, result.EnableRangeProcessing);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">if</span> (!serveBody)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">return</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> <span class="keywordflow">try</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> var outputStream = context.HttpContext.Response.Body;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">if</span> (range == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> await StreamCopyOperation.CopyToAsync(</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> stream,</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> outputStream,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> contentLength,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> BufferSize,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> cancellationToken);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">else</span></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> stream.Seek(range.From ?? 0, SeekOrigin.Begin);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> await StreamCopyOperation.CopyToAsync(</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> stream,</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> outputStream,</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> rangeLength,</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> BufferSize,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> cancellationToken);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
<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> <span class="keywordflow">catch</span> (OperationCanceledException)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Don&#39;t throw this exception, it&#39;s most likely caused by the client disconnecting.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// However, if it was cancelled for any other reason we need to prevent empty responses.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> context.HttpContext.Abort();</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> }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>}</div>
<div class="ttc" id="aclass_file_result_executor_base_html"><div class="ttname"><a href="class_file_result_executor_base.html">FileResultExecutorBase</a></div></div>
<div class="ttc" id="aclass_i_action_result_executor_html"><div class="ttname"><a href="class_i_action_result_executor.html">IActionResultExecutor</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html">Tgstation.Server.Host.Controllers.Results.LimitedStreamResultExecutor</a></div><div class="ttdoc">IActionResultExecutor&lt;TResult&gt; for LimitedStreamResults.</div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_executor_8cs_source.html#l00015">LimitedStreamResultExecutor.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor_html_a1580d6734eae31ef251dca95d8f5d0ef"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html#a1580d6734eae31ef251dca95d8f5d0ef">Tgstation.Server.Host.Controllers.Results.LimitedStreamResultExecutor.LimitedStreamResultExecutor</a></div><div class="ttdeci">LimitedStreamResultExecutor(ILogger&lt; LimitedStreamResultExecutor &gt; logger)</div><div class="ttdoc">Initializes a new instance of the LimitedStreamResultExecutor class.</div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_executor_8cs_source.html#l00021">LimitedStreamResultExecutor.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor_html_ab5ef22f22bfb04f0bedd88eaa468bc33"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_executor.html#ab5ef22f22bfb04f0bedd88eaa468bc33">Tgstation.Server.Host.Controllers.Results.LimitedStreamResultExecutor.ExecuteAsync</a></div><div class="ttdeci">async Task ExecuteAsync(ActionContext context, LimitedStreamResult result)</div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_executor_8cs_source.html#l00027">LimitedStreamResultExecutor.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result.html">Tgstation.Server.Host.Controllers.Results.LimitedStreamResult</a></div><div class="ttdoc">Very similar to FileStreamResult except it's IActionResultExecutor&lt;TResult&gt; contains a fix for https:...</div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_8cs_source.html#l00018">LimitedStreamResult.cs:19</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result_html_a7a426c34eac3920d440ac4ae0c93f62a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_limited_stream_result.html#a7a426c34eac3920d440ac4ae0c93f62a">Tgstation.Server.Host.Controllers.Results.LimitedStreamResult.GetResult</a></div><div class="ttdeci">ValueTask&lt; Stream &gt; GetResult(CancellationToken cancellationToken)</div><div class="ttdoc">Gets the provided Stream. May be called multiple times, though cancelling any may cause all calls to ...</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results.html">Tgstation.Server.Host.Controllers.Results</a></div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_8cs_source.html#l00013">LimitedStreamResult.cs:14</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