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

135 lines
15 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.Common/PipeCommands.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_6f30e6edd07ec356128627ca61aea4cc.html">Tgstation.Server.Host.Common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">PipeCommands.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_pipe_commands_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">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_common.html">Tgstation.Server.Host.Common</a></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span>{</div>
<div class="foldopen" id="foldopen00006" data-start="{" data-end="};">
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html"> 6</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html">PipeCommands</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a63ea122d2f963b127bdac3971c7173f9"> 11</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_common_1_1_pipe_commands.html#a63ea122d2f963b127bdac3971c7173f9">CommandStop</a> = <span class="stringliteral">&quot;stop&quot;</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#aa48ea3c7ad7919922d7330d52b489ec1"> 16</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_common_1_1_pipe_commands.html#aa48ea3c7ad7919922d7330d52b489ec1">CommandGracefulShutdown</a> = <span class="stringliteral">&quot;graceful&quot;</span>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a5118c73a97fc1f6e3484c59c40ceec12"> 21</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_common_1_1_pipe_commands.html#a5118c73a97fc1f6e3484c59c40ceec12">CommandDetachingShutdown</a> = <span class="stringliteral">&quot;detach&quot;</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#ad7fc03298400de7fc74835af54ffb9a1"> 26</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_common_1_1_pipe_commands.html#ad7fc03298400de7fc74835af54ffb9a1">CommandStartupComplete</a> = <span class="stringliteral">&quot;times_up_lets_do_this&quot;</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#if NET6_0_OR_GREATER</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span> <span class="keyword">static</span> System.Collections.Generic.IReadOnlyList&lt;<span class="keywordtype">string</span>&gt; AllCommands { <span class="keyword">get</span>; } = <span class="keyword">new</span>[]</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a63ea122d2f963b127bdac3971c7173f9">CommandStop</a>,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#aa48ea3c7ad7919922d7330d52b489ec1">CommandGracefulShutdown</a>,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a5118c73a97fc1f6e3484c59c40ceec12">CommandDetachingShutdown</a>,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#ad7fc03298400de7fc74835af54ffb9a1">CommandStartupComplete</a>,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> };</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="}">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a06c8d3400eeb8207d35f8f3bae86cfb5"> 46</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">int</span>? <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a06c8d3400eeb8207d35f8f3bae86cfb5">GetServiceCommandId</a>(<span class="keywordtype">string</span> command)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> =&gt; command <span class="keywordflow">switch</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a63ea122d2f963b127bdac3971c7173f9">CommandStop</a> =&gt; 128, <span class="comment">// Windows only allows commands 128-256: https://stackoverflow.com/a/62858106</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#aa48ea3c7ad7919922d7330d52b489ec1">CommandGracefulShutdown</a> =&gt; 129,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a5118c73a97fc1f6e3484c59c40ceec12">CommandDetachingShutdown</a> =&gt; 130,</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#ad7fc03298400de7fc74835af54ffb9a1">CommandStartupComplete</a> or _ =&gt; <span class="keyword">null</span>,</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> };</div>
</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="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html">Tgstation.Server.Host.Common.PipeCommands</a></div><div class="ttdoc">Values able to be passed via the update file path.</div><div class="ttdef"><b>Definition</b> <a href="_pipe_commands_8cs_source.html#l00006">PipeCommands.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html_a06c8d3400eeb8207d35f8f3bae86cfb5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a06c8d3400eeb8207d35f8f3bae86cfb5">Tgstation.Server.Host.Common.PipeCommands.GetServiceCommandId</a></div><div class="ttdeci">static ? int GetServiceCommandId(string command)</div><div class="ttdoc">Gets the int value of a given command .</div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html_a5118c73a97fc1f6e3484c59c40ceec12"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a5118c73a97fc1f6e3484c59c40ceec12">Tgstation.Server.Host.Common.PipeCommands.CommandDetachingShutdown</a></div><div class="ttdeci">const string CommandDetachingShutdown</div><div class="ttdoc">Stops the server ASAP, detaching the watchdog for any running instances.</div><div class="ttdef"><b>Definition</b> <a href="_pipe_commands_8cs_source.html#l00021">PipeCommands.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html_a63ea122d2f963b127bdac3971c7173f9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#a63ea122d2f963b127bdac3971c7173f9">Tgstation.Server.Host.Common.PipeCommands.CommandStop</a></div><div class="ttdeci">const string CommandStop</div><div class="ttdoc">Stops the server ASAP, shutting down any running instances.</div><div class="ttdef"><b>Definition</b> <a href="_pipe_commands_8cs_source.html#l00011">PipeCommands.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html_aa48ea3c7ad7919922d7330d52b489ec1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#aa48ea3c7ad7919922d7330d52b489ec1">Tgstation.Server.Host.Common.PipeCommands.CommandGracefulShutdown</a></div><div class="ttdeci">const string CommandGracefulShutdown</div><div class="ttdoc">Stops the server eventually, waiting for the games in any running instances to reboot.</div><div class="ttdef"><b>Definition</b> <a href="_pipe_commands_8cs_source.html#l00016">PipeCommands.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands_html_ad7fc03298400de7fc74835af54ffb9a1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_common_1_1_pipe_commands.html#ad7fc03298400de7fc74835af54ffb9a1">Tgstation.Server.Host.Common.PipeCommands.CommandStartupComplete</a></div><div class="ttdeci">const string CommandStartupComplete</div><div class="ttdoc">Indicates that the host has finished initializing.</div><div class="ttdef"><b>Definition</b> <a href="_pipe_commands_8cs_source.html#l00026">PipeCommands.cs:26</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_common_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_common.html">Tgstation.Server.Host.Common</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_host_8_common_2_dotnet_helper_8cs_source.html#l00008">DotnetHelper.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