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

121 lines
12 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/Utils/SignalR/IHubConnectionMapper.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_e031aa0fb63a9784d5d0be33d19ac57a.html">Utils</a></li><li class="navelem"><a class="el" href="dir_97dd434efc1c72a1193a2c3d45f33b74.html">SignalR</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IHubConnectionMapper.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_hub_connection_mapper_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.Threading;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Threading.Tasks;</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>Microsoft.AspNetCore.SignalR;</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><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a>;</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_host_1_1_security.html">Tgstation.Server.Host.Security</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_host_1_1_utils_1_1_signal_r.html">Tgstation.Server.Host.Utils.SignalR</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</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="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html"> 16</a></span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html">IHubConnectionMapper</a>&lt;THub, THubMethods&gt;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> where THub : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_connection_mapping_hub.html">ConnectionMappingHub</a>&lt;THub, THubMethods&gt;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> where THubMethods : class</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#a0dd70c92d12fd567b71a7bcb73dafe11"> 27</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#a0dd70c92d12fd567b71a7bcb73dafe11">UserConnected</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, THub hub, CancellationToken cancellationToken);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#ae2deb654a3c4d2f7ddd4fe5eac98d93d"> 33</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#ae2deb654a3c4d2f7ddd4fe5eac98d93d">UserDisconnected</a>(<span class="keywordtype">string</span> connectionId);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_connection_mapping_hub_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_connection_mapping_hub.html">Tgstation.Server.Host.Utils.SignalR.ConnectionMappingHub</a></div><div class="ttdoc">Base class for Hub&lt;T&gt;s that want to map their connection IDs to Models.PermissionSets.</div><div class="ttdef"><b>Definition</b> <a href="_connection_mapping_hub_8cs_source.html#l00017">ConnectionMappingHub.cs:20</a></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_utils_1_1_signal_r_1_1_i_hub_connection_mapper_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html">Tgstation.Server.Host.Utils.SignalR.IHubConnectionMapper</a></div><div class="ttdoc">Handles mapping connection IDs to Users for a given THub .</div><div class="ttdef"><b>Definition</b> <a href="_i_hub_connection_mapper_8cs_source.html#l00016">IHubConnectionMapper.cs:19</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper_html_a0dd70c92d12fd567b71a7bcb73dafe11"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#a0dd70c92d12fd567b71a7bcb73dafe11">Tgstation.Server.Host.Utils.SignalR.IHubConnectionMapper.UserConnected</a></div><div class="ttdeci">ValueTask UserConnected(IAuthenticationContext authenticationContext, THub hub, CancellationToken cancellationToken)</div><div class="ttdoc">To be called when a hub connection is made.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper_html_ae2deb654a3c4d2f7ddd4fe5eac98d93d"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_1_1_i_hub_connection_mapper.html#ae2deb654a3c4d2f7ddd4fe5eac98d93d">Tgstation.Server.Host.Utils.SignalR.IHubConnectionMapper.UserDisconnected</a></div><div class="ttdeci">void UserDisconnected(string connectionId)</div><div class="ttdoc">To be called when a hub connection is terminated.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_models_2_chat_bot_8cs_source.html#l00008">ChatBot.cs:9</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 class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils_1_1_signal_r.html">Tgstation.Server.Host.Utils.SignalR</a></div><div class="ttdef"><b>Definition</b> <a href="_comprehensive_hub_context_8cs_source.html#l00014">ComprehensiveHubContext.cs:15</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