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

156 lines
17 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.Client/RateLimitException.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_9826fb2d31585a830723e6d7089b5d0e.html">Tgstation.Server.Client</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">RateLimitException.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_rate_limit_exception_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.Linq;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Net.Http;</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.Net.Http.Headers;</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><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a>;</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">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_client.html">Tgstation.Server.Client</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>{</div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html"> 14</a></span> <span class="keyword">public</span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html">RateLimitException</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_client_1_1_api_exception.html">ApiException</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a3a57db9e2ca420da24a144286faf57b0"> 19</a></span> <span class="keyword">public</span> DateTimeOffset? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a3a57db9e2ca420da24a144286faf57b0">RetryAfter</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#acd5833f94108296c26d089c28b93f08b"> 26</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#acd5833f94108296c26d089c28b93f08b">RateLimitException</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">ErrorMessageResponse</a>? errorMessage, HttpResponseMessage responseMessage)</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> : base(errorMessage, responseMessage)</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> <span class="keywordflow">if</span> (responseMessage == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(responseMessage));</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">if</span> (!responseMessage.Headers.TryGetValues(HeaderNames.RetryAfter, out var values))</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span>;</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 secondsString = values.FirstOrDefault();</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">if</span> (UInt32.TryParse(secondsString, out var seconds))</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a3a57db9e2ca420da24a144286faf57b0">RetryAfter</a> = DateTimeOffset.UtcNow.AddSeconds(seconds);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a1bd82db7496764293896d95a761a5b1c"> 43</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a1bd82db7496764293896d95a761a5b1c">RateLimitException</a>()</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>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a8e04b2aea5d904230a1c2e4b76b6d40c"> 51</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a8e04b2aea5d904230a1c2e4b76b6d40c">RateLimitException</a>(<span class="keywordtype">string</span> message)</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> : base(message)</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> }</div>
</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="foldopen" id="foldopen00061" data-start="{" data-end="}">
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#ab30825486f294c98083fb35043f5da0a"> 61</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#ab30825486f294c98083fb35043f5da0a">RateLimitException</a>(<span class="keywordtype">string</span> message, <a class="code hl_class" href="class_exception.html">Exception</a> innerException)</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> : base(message, innerException)</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>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> }</div>
</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>}</div>
<div class="ttc" id="aclass_exception_html"><div class="ttname"><a href="class_exception.html">Exception</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">Tgstation.Server.Api.Models.Response.ErrorMessageResponse</a></div><div class="ttdoc">Represents an error message returned by the server.</div><div class="ttdef"><b>Definition</b> <a href="_error_message_response_8cs_source.html#l00011">ErrorMessageResponse.cs:12</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_api_exception_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_api_exception.html">Tgstation.Server.Client.ApiException</a></div><div class="ttdoc">API related Exceptions.</div><div class="ttdef"><b>Definition</b> <a href="_api_exception_8cs_source.html#l00012">ApiException.cs:13</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html">Tgstation.Server.Client.RateLimitException</a></div><div class="ttdoc">Occurs when a GitHub rate limit occurs.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00014">RateLimitException.cs:15</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html_a1bd82db7496764293896d95a761a5b1c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a1bd82db7496764293896d95a761a5b1c">Tgstation.Server.Client.RateLimitException.RateLimitException</a></div><div class="ttdeci">RateLimitException()</div><div class="ttdoc">Initializes a new instance of the RateLimitException class.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00043">RateLimitException.cs:43</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html_a3a57db9e2ca420da24a144286faf57b0"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a3a57db9e2ca420da24a144286faf57b0">Tgstation.Server.Client.RateLimitException.RetryAfter</a></div><div class="ttdeci">DateTimeOffset? RetryAfter</div><div class="ttdoc">Gets the DateTimeOffset to try the request again after.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00019">RateLimitException.cs:19</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html_a8e04b2aea5d904230a1c2e4b76b6d40c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#a8e04b2aea5d904230a1c2e4b76b6d40c">Tgstation.Server.Client.RateLimitException.RateLimitException</a></div><div class="ttdeci">RateLimitException(string message)</div><div class="ttdoc">Initializes a new instance of the RateLimitException class.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00051">RateLimitException.cs:51</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html_ab30825486f294c98083fb35043f5da0a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#ab30825486f294c98083fb35043f5da0a">Tgstation.Server.Client.RateLimitException.RateLimitException</a></div><div class="ttdeci">RateLimitException(string message, Exception innerException)</div><div class="ttdoc">Initializes a new instance of the RateLimitException class.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00061">RateLimitException.cs:61</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception_html_acd5833f94108296c26d089c28b93f08b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_rate_limit_exception.html#acd5833f94108296c26d089c28b93f08b">Tgstation.Server.Client.RateLimitException.RateLimitException</a></div><div class="ttdeci">RateLimitException(ErrorMessageResponse? errorMessage, HttpResponseMessage responseMessage)</div><div class="ttdoc">Initializes a new instance of the RateLimitException class.</div><div class="ttdef"><b>Definition</b> <a href="_rate_limit_exception_8cs_source.html#l00026">RateLimitException.cs:26</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_response_8cs_source.html#l00005">AdministrationResponse.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_client_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_client.html">Tgstation.Server.Client</a></div><div class="ttdef"><b>Definition</b> <a href="_authenticated_graph_q_l_server_client_8cs_source.html#l00011">AuthenticatedGraphQLServerClient.cs:12</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