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

155 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/GraphQL/Subscription.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_26e902284bbadb812716475690544a7b.html">GraphQL</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Subscription.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_subscription_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><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>HotChocolate;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>HotChocolate.Authorization;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>HotChocolate.Execution;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using </span>HotChocolate.Subscriptions;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">using </span>HotChocolate.Types;</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">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html">Tgstation.Server.Host.GraphQL.Subscriptions</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> [Authorize(ApplyPolicy.Validation)] <span class="comment">// See https://github.com/ChilliCream/graphql-platform/issues/6259</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> [GraphQLDescription(GraphQLDescription)]</div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html"> 22</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_host_1_1_graph_q_l_1_1_subscription.html">Subscription</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<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_graph_q_l_1_1_subscription.html#a248e8b77ba54ea450b23b1732372b64b"> 27</a></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a248e8b77ba54ea450b23b1732372b64b">GraphQLDescription</a> = <span class="stringliteral">&quot;Root Subscription type. Note that subscriptions are performed over Server Sent events.&quot;</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ab401f4c9f95799e278391d569bd1c5dd"> 34</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ab401f4c9f95799e278391d569bd1c5dd">SessionInvalidatedTopic</a>(<a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">IAuthenticationContext</a> authenticationContext)</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ArgumentNullException.ThrowIfNull(authenticationContext);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">return</span> $<span class="stringliteral">&quot;SessionInvalidated.{authenticationContext.SessionId}&quot;</span>;</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="foldopen00048" data-start="{" data-end="}">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a350b119fe1ca1674f586089f3b66a196"> 48</a></span> <span class="keyword">public</span> ValueTask&lt;ISourceStream&lt;SessionInvalidationReason&gt;&gt; <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a350b119fe1ca1674f586089f3b66a196">SessionInvalidatedStream</a>(</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> [Service] HotChocolate.Subscriptions.ITopicEventReceiver receiver, <span class="comment">// Intentionally not using our override here, topic callers are built to explicitly handle cases of server shutdown</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> [Service] <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_session_invalidation_tracker.html">ISessionInvalidationTracker</a> invalidationTracker,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> [Service] <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">IAuthenticationContext</a> authenticationContext,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> CancellationToken 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> ArgumentNullException.ThrowIfNull(receiver);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> ArgumentNullException.ThrowIfNull(invalidationTracker);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> var subscription = receiver.SubscribeAsync&lt;<a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html#a520354dfdc2747522110b03b9f1e4a9f">SessionInvalidationReason</a>&gt;(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ab401f4c9f95799e278391d569bd1c5dd">SessionInvalidatedTopic</a>(authenticationContext), cancellationToken);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> invalidationTracker.TrackSession(authenticationContext);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> subscription;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> [Subscribe(With = nameof(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a350b119fe1ca1674f586089f3b66a196">SessionInvalidatedStream</a>))]</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ae8329083151a76d8844bcba7916a3333"> 68</a></span> <span class="keyword">public</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html#a520354dfdc2747522110b03b9f1e4a9f">SessionInvalidationReason</a> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ae8329083151a76d8844bcba7916a3333">SessionInvalidated</a>([EventMessage] <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html#a520354dfdc2747522110b03b9f1e4a9f">SessionInvalidationReason</a> sessionInvalidationReason)</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> =&gt; sessionInvalidationReason;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html">Tgstation.Server.Host.GraphQL.Subscription</a></div><div class="ttdoc">Root type for GraphQL subscriptions.</div><div class="ttdef"><b>Definition</b> <a href="_subscription_8cs_source.html#l00022">Subscription.cs:23</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription_html_a248e8b77ba54ea450b23b1732372b64b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a248e8b77ba54ea450b23b1732372b64b">Tgstation.Server.Host.GraphQL.Subscription.GraphQLDescription</a></div><div class="ttdeci">const string GraphQLDescription</div><div class="ttdoc">Description to show on the Subscription type.</div><div class="ttdef"><b>Definition</b> <a href="_subscription_8cs_source.html#l00027">Subscription.cs:27</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription_html_a350b119fe1ca1674f586089f3b66a196"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#a350b119fe1ca1674f586089f3b66a196">Tgstation.Server.Host.GraphQL.Subscription.SessionInvalidatedStream</a></div><div class="ttdeci">ValueTask&lt; ISourceStream&lt; SessionInvalidationReason &gt; &gt; SessionInvalidatedStream([Service] HotChocolate.Subscriptions.ITopicEventReceiver receiver, [Service] ISessionInvalidationTracker invalidationTracker, [Service] IAuthenticationContext authenticationContext, CancellationToken cancellationToken)</div><div class="ttdoc">ISourceStream for SessionInvalidated(SessionInvalidationReason).</div><div class="ttdef"><b>Definition</b> <a href="_subscription_8cs_source.html#l00048">Subscription.cs:48</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription_html_ab401f4c9f95799e278391d569bd1c5dd"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ab401f4c9f95799e278391d569bd1c5dd">Tgstation.Server.Host.GraphQL.Subscription.SessionInvalidatedTopic</a></div><div class="ttdeci">static string SessionInvalidatedTopic(IAuthenticationContext authenticationContext)</div><div class="ttdoc">Gets the topic name for the login session represented by a given authenticationContext .</div><div class="ttdef"><b>Definition</b> <a href="_subscription_8cs_source.html#l00034">Subscription.cs:34</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription_html_ae8329083151a76d8844bcba7916a3333"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscription.html#ae8329083151a76d8844bcba7916a3333">Tgstation.Server.Host.GraphQL.Subscription.SessionInvalidated</a></div><div class="ttdeci">SessionInvalidationReason SessionInvalidated([EventMessage] SessionInvalidationReason sessionInvalidationReason)</div><div class="ttdoc">Receive a SessionInvalidationReason immediately before the current login session is invalidated.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">Tgstation.Server.Host.Security.IAuthenticationContext</a></div><div class="ttdoc">For creating and accessing authentication contexts.</div><div class="ttdef"><b>Definition</b> <a href="_i_authentication_context_8cs_source.html#l00011">IAuthenticationContext.cs:12</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_session_invalidation_tracker_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_session_invalidation_tracker.html">Tgstation.Server.Host.Security.ISessionInvalidationTracker</a></div><div class="ttdoc">Handles invalidating user sessions.</div><div class="ttdef"><b>Definition</b> <a href="_i_session_invalidation_tracker_8cs_source.html#l00008">ISessionInvalidationTracker.cs:9</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html">Tgstation.Server.Host.GraphQL.Subscriptions</a></div><div class="ttdef"><b>Definition</b> <a href="_i_topic_event_receiver_8cs_source.html#l00001">ITopicEventReceiver.cs:2</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions_html_a520354dfdc2747522110b03b9f1e4a9f"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_subscriptions.html#a520354dfdc2747522110b03b9f1e4a9f">Tgstation.Server.Host.GraphQL.Subscriptions.SessionInvalidationReason</a></div><div class="ttdeci">SessionInvalidationReason</div><div class="ttdoc">Reasons TGS may invalidate a user's login session.</div><div class="ttdef"><b>Definition</b> <a href="_session_invalidation_reason_8cs_source.html#l00006">SessionInvalidationReason.cs:7</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_graph_q_l.html">Tgstation.Server.Host.GraphQL</a></div><div class="ttdef"><b>Definition</b> <a href="_authorization_helper_8cs_source.html#l00013">AuthorizationHelper.cs:14</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.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