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

193 lines
21 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/Extensions/HubConnectionExtensions.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><li class="navelem"><a class="el" href="dir_51aa30b5ee353a290d87fa1d3883a0e0.html">Extensions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">HubConnectionExtensions.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_hub_connection_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.Linq;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading.Tasks;</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">using </span>Microsoft.AspNetCore.SignalR.Client;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_client_1_1_extensions.html"> 8</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_client_1_1_extensions.html">Tgstation.Server.Client.Extensions</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html"> 13</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_client_1_1_extensions_1_1_hub_connection_extensions.html">HubConnectionExtensions</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</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_client_1_1_extensions_1_1_hub_connection_extensions.html#aee53b96fbf5cc6c7c6ae5e5e87714a0a"> 21</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#aee53b96fbf5cc6c7c6ae5e5e87714a0a">ProxyOn&lt;TClientProxy&gt;</a>(<span class="keyword">this</span> HubConnection hubConnection, TClientProxy proxy)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> where TClientProxy : <span class="keyword">class</span></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="keywordflow">if</span> (hubConnection == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(hubConnection));</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">if</span> (proxy == <span class="keyword">null</span>)</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(proxy));</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#a7fcdfc5660189917d34b3bf6652293ba">ProxyOn</a>(hubConnection, typeof(TClientProxy), proxy);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#a7fcdfc5660189917d34b3bf6652293ba"> 39</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#a7fcdfc5660189917d34b3bf6652293ba">ProxyOn</a>(<span class="keyword">this</span> HubConnection hubConnection, Type proxyType, <span class="keywordtype">object</span> proxyObject)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> var clientMethods = proxyType.GetMethods();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> var cancellationTokenType = typeof(CancellationToken);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">foreach</span> (var clientMethod <span class="keywordflow">in</span> clientMethods)</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> var parametersList = clientMethod</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> .GetParameters()</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> .Select(parameterInfo =&gt; parameterInfo.ParameterType)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> .ToList();</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> var cancellationTokenIndex = parametersList.IndexOf(cancellationTokenType);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">if</span> (cancellationTokenIndex != -1)</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> parametersList.RemoveAt(cancellationTokenIndex);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#if DEBUG</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">if</span> (parametersList.IndexOf(cancellationTokenType) != -1)</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException(<span class="stringliteral">&quot;Cannot ProxyOn a method with multiple CancellationToken parameters!&quot;</span>);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> var parameters = parametersList.ToArray();</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">object</span>?[] AddCancellationTokenToParametersArray(<span class="keywordtype">object</span>?[] parametersArray)</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> <span class="keywordflow">if</span> (cancellationTokenIndex == -1)</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> parametersArray;</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> var newList = parametersArray.ToList();</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> newList.Insert(cancellationTokenIndex, CancellationToken.None);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> newList.ToArray();</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> var returnType = clientMethod.ReturnType;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">if</span> (returnType != typeof(Task))</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> <span class="keywordflow">if</span> (returnType.BaseType != typeof(Task))</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException($<span class="stringliteral">&quot;Return type {returnType} of {proxyType.FullName}.{clientMethod.Name} is not supported! Only Task and derivatives are supported.&quot;</span>);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> var resultProperty = returnType.GetProperty(nameof(Task&lt;object&gt;.Result));</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> hubConnection.On(</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> clientMethod.Name,</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> parameters,</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> async (parameterArray, _) =&gt;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> var task = (Task)clientMethod.Invoke(proxyObject, AddCancellationTokenToParametersArray(parameterArray));</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> await task;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">return</span> resultProperty.GetValue(task);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> },</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> hubConnection);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> hubConnection.On(</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> clientMethod.Name,</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> parameters,</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> (parameterArray) =&gt;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> (Task)clientMethod.Invoke(proxyObject, AddCancellationTokenToParametersArray(parameterArray));</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> });</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordflow">foreach</span> (var inheritedInterface <span class="keywordflow">in</span> proxyType.GetInterfaces())</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#a7fcdfc5660189917d34b3bf6652293ba">ProxyOn</a>(hubConnection, inheritedInterface, proxyObject);</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> }</div>
</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> }</div>
</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>}</div>
</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html">Tgstation.Server.Client.Extensions.HubConnectionExtensions</a></div><div class="ttdoc">Extension methods for the HubConnection class.</div><div class="ttdef"><b>Definition</b> <a href="_hub_connection_extensions_8cs_source.html#l00013">HubConnectionExtensions.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions_html_a7fcdfc5660189917d34b3bf6652293ba"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#a7fcdfc5660189917d34b3bf6652293ba">Tgstation.Server.Client.Extensions.HubConnectionExtensions.ProxyOn</a></div><div class="ttdeci">static void ProxyOn(this HubConnection hubConnection, Type proxyType, object proxyObject)</div><div class="ttdoc">Apply a given proxyObject to a given hubConnection .</div><div class="ttdef"><b>Definition</b> <a href="_hub_connection_extensions_8cs_source.html#l00039">HubConnectionExtensions.cs:39</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions_html_aee53b96fbf5cc6c7c6ae5e5e87714a0a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_client_1_1_extensions_1_1_hub_connection_extensions.html#aee53b96fbf5cc6c7c6ae5e5e87714a0a">Tgstation.Server.Client.Extensions.HubConnectionExtensions.ProxyOn&lt; TClientProxy &gt;</a></div><div class="ttdeci">static void ProxyOn&lt; TClientProxy &gt;(this HubConnection hubConnection, TClientProxy proxy)</div><div class="ttdoc">Apply a given proxy to a given hubConnection .</div><div class="ttdef"><b>Definition</b> <a href="_hub_connection_extensions_8cs_source.html#l00021">HubConnectionExtensions.cs:21</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_client_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_client_1_1_extensions.html">Tgstation.Server.Client.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_hub_connection_extensions_8cs_source.html#l00008">HubConnectionExtensions.cs:9</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