mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-27 23:17:20 +01:00
117 lines
17 KiB
HTML
117 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>tgstation-server: src/Tgstation.Server.Host/Components/Watchdog/ISessionController.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="tgs.ico"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">tgstation-server
|
|
</div>
|
|
<div id="projectbrief">The /tg/station 13 server suite</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="api.html"><span>API</span></a></li>
|
|
<li><a href="architecture.html"><span>Architecture</span></a></li>
|
|
<li><a href="namespaces.html"><span>Packages</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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_7a3fd032a1362a6005a1fc9227a8dd86.html">Components</a></li><li class="navelem"><a class="el" href="dir_02f69155ced6ccca99a24744a5273903.html">Watchdog</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ISessionController.cs</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_i_session_controller_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="keyword">using</span> <a class="code" href="namespace_system.html">System</a>.Threading;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="keyword">using</span> <a class="code" href="namespace_system.html">System</a>.Threading.Tasks;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="keyword">using</span> <a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server.html">Server</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host.html">Host</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_core.html">Core</a>;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">namespace </span><a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9">Server</a>.Host.Components.Watchdog</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> {</div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html"> 10</a></span>  <span class="keyword">interface </span><a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html">ISessionController</a> : <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_process_base.html">IProcessBase</a></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  {</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#adaa02ab9bccaaf1ad18f199e319724bc"> 15</a></span>  Task<LaunchResult> <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_launch_result.html">LaunchResult</a> { <span class="keyword">get</span>; }</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#ae1efcc624f78a7c1ce978b000d09d382"> 20</a></span>  <span class="keywordtype">bool</span> IsPrimary { <span class="keyword">get</span>; }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#af1deb0ef8ce6a9f45326caa2e7aa78ea"> 25</a></span>  <span class="keywordtype">bool</span> TerminationWasRequested { <span class="keyword">get</span>; }</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#a420a602d40898c12599cba77b1df12af"> 30</a></span>  <a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#af7163ca98f9f5e5c731043ecdace3745">ApiValidationStatus</a> <a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#af7163ca98f9f5e5c731043ecdace3745">ApiValidationStatus</a> { <span class="keyword">get</span>; }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#ab8c54c9d9b013c7456401a3b3173238d"> 35</a></span>  <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_dmb_provider.html">IDmbProvider</a> Dmb { <span class="keyword">get</span>; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#aa343d746e958dbfe2a22f4a7a4fb33cd"> 40</a></span>  ushort? Port { <span class="keyword">get</span>; }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#a4aff175710c5f3e1acffe941131a4ffa"> 45</a></span>  <span class="keywordtype">bool</span> ClosePortOnReboot { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#af12460cd54ebce65ecf71fb8dad516c4"> 50</a></span>  <a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#a3b33ca95a6257e0c719adc7b54444ab8">RebootState</a> <a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#a3b33ca95a6257e0c719adc7b54444ab8">RebootState</a> { <span class="keyword">get</span>; }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html#aa22611bb1515c92112cb88c1fd2a346b"> 55</a></span>  Task OnReboot { <span class="keyword">get</span>; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_reattach_information.html">ReattachInformation</a> Release();</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  Task<string> SendCommand(<span class="keywordtype">string</span> command, CancellationToken cancellationToken);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  Task<bool> SetPort(ushort newPort, CancellationToken cancellatonToken);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Task<bool> SetRebootState(<a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#a3b33ca95a6257e0c719adc7b54444ab8">RebootState</a> newRebootState, CancellationToken cancellationToken);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> ResetRebootState();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> EnableCustomChatCommands();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> }</div><div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_launch_result_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_launch_result.html">Tgstation.Server.Host.Components.Watchdog.LaunchResult</a></div><div class="ttdoc">Represents the result of trying to start a DD process </div><div class="ttdef"><b>Definition:</b> <a href="_launch_result_8cs_source.html#l00009">LaunchResult.cs:9</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_api_1_1_models_html_a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9">Tgstation.Server.Api.Models.IrcPasswordType.Server</a></div><div class="ttdoc">Use server authentication </div></div>
|
|
<div class="ttc" id="namespace_system_html"><div class="ttname"><a href="namespace_system.html">System</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_i_session_controller.html">Tgstation.Server.Host.Components.Watchdog.ISessionController</a></div><div class="ttdoc">Handles communication with a DreamDaemon IProcess </div><div class="ttdef"><b>Definition:</b> <a href="_i_session_controller_8cs_source.html#l00010">ISessionController.cs:10</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_core_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_core.html">Tgstation.Server.Host.Core</a></div><div class="ttdef"><b>Definition:</b> <a href="_application_8cs_source.html#l00034">Application.cs:34</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_process_base_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_process_base.html">Tgstation.Server.Host.Core.IProcessBase</a></div><div class="ttdoc">Represents process lifetime </div><div class="ttdef"><b>Definition:</b> <a href="_i_process_base_8cs_source.html#l00009">IProcessBase.cs:9</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_html"><div class="ttname"><a href="namespace_tgstation_1_1_server.html">Tgstation.Server</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_dmb_provider_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_dmb_provider.html">Tgstation.Server.Host.Components.IDmbProvider</a></div><div class="ttdoc">Provides absolute paths to the latest compiled .dmbs </div><div class="ttdef"><b>Definition:</b> <a href="_i_dmb_provider_8cs_source.html#l00009">IDmbProvider.cs:9</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host.html">Tgstation.Server.Host</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_html_a3b33ca95a6257e0c719adc7b54444ab8"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#a3b33ca95a6257e0c719adc7b54444ab8">Tgstation.Server.Host.Components.Watchdog.RebootState</a></div><div class="ttdeci">RebootState</div><div class="ttdoc">Represents the action to take when /world/Reboot() is called </div><div class="ttdef"><b>Definition:</b> <a href="_reboot_state_8cs_source.html#l00006">RebootState.cs:6</a></div></div>
|
|
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_reattach_information_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_reattach_information.html">Tgstation.Server.Host.Components.Watchdog.ReattachInformation</a></div><div class="ttdoc">Parameters necessary for duplicating a ISessionController session </div><div class="ttdef"><b>Definition:</b> <a href="_components_2_watchdog_2_reattach_information_8cs_source.html#l00009">ReattachInformation.cs:9</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_html"><div class="ttname"><a href="namespace_tgstation.html">Tgstation</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_html_af7163ca98f9f5e5c731043ecdace3745"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog.html#af7163ca98f9f5e5c731043ecdace3745">Tgstation.Server.Host.Components.Watchdog.ApiValidationStatus</a></div><div class="ttdeci">ApiValidationStatus</div><div class="ttdoc">Status of DMAPI validation </div><div class="ttdef"><b>Definition:</b> <a href="_api_validation_status_8cs_source.html#l00006">ApiValidationStatus.cs:6</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|