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

Deploy code docs to GitHub Pages for workflow run 2139

Browse Source 
Commit: 0b0c50d4af
This commit is contained in:
tgstation-server
2024-01-19 12:01:56 +00:00
parent bd11d0c55d
commit 920fed4d9c
6 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_general_configuration_8cs_source.html
+6 -3
View File
@@ -178,9 +178,12 @@ $(function() {
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (this.GetCopyDirectoryTaskThrottle() &lt; 1)</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException(</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> $<span class="stringliteral">&quot;{nameof(DeploymentDirectoryCopyTasksPerCore)} is too large for the CPU core count of {Environment.ProcessorCount} and overflows a 32-bit signed integer. Please lower the value!&quot;</span>);</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> }</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> }</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span>}</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="keywordflow">if</span> (<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a51431792c5538add1bdad55e499a4971">ByondTopicTimeout</a> &lt;= 1000)</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> logger.LogWarning(<span class="stringliteral">&quot;The timeout for sending BYOND topics is very low ({ms}ms). Topic calls may fail to complete at all!&quot;</span>, <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a51431792c5538add1bdad55e499a4971">ByondTopicTimeout</a>);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> }</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> }</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span>}</div>
<div class="ttc" id="aclass_json_converter_html"><div class="ttname"><a href="class_json_converter.html">JsonConverter</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html">Tgstation.Server.Api.Models.Internal.ServerInformationBase</a></div><div class="ttdoc">Base class for Response.ServerInformationResponse.</div><div class="ttdef"><b>Definition:</b> <a href="_server_information_base_8cs_source.html#l00008">ServerInformationBase.cs:9</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base_html_a3e9282b16ff9ab6138fad75472968029"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html#a3e9282b16ff9ab6138fad75472968029">Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit</a></div><div class="ttdeci">uint UserGroupLimit</div><div class="ttdoc">The maximum number of user groups allowed.</div><div class="ttdef"><b>Definition:</b> <a href="_server_information_base_8cs_source.html#l00028">ServerInformationBase.cs:28</a></div></div>
_tgstation_8_server_8_api_8_assembly_info_8cs_source.html
+1 -1
View File
@@ -94,7 +94,7 @@ $(function() {
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>[assembly: System.Reflection.AssemblyCopyrightAttribute(<span class="stringliteral">&quot;Copyright (c) Jordan Brown 2018&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyDescriptionAttribute(<span class="stringliteral">&quot;API definitions for tgstation-server.&quot;</span>)]</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>[assembly: System.Reflection.AssemblyFileVersionAttribute(<span class="stringliteral">&quot;13.0.1.0&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;13.0.1+100887232a36bb73a95f15415a4d729c623fb2b9&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;13.0.1+0b0c50d4afa5c94267ca1bda1c241aed43a46016&quot;</span>)]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>[assembly: System.Reflection.AssemblyProductAttribute(<span class="stringliteral">&quot;Tgstation.Server.Api&quot;</span>)]</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>[assembly: System.Reflection.AssemblyTitleAttribute(<span class="stringliteral">&quot;Tgstation.Server.Api&quot;</span>)]</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>[assembly: System.Reflection.AssemblyVersionAttribute(<span class="stringliteral">&quot;13.0.1.0&quot;</span>)]</div>
_tgstation_8_server_8_common_8_assembly_info_8cs_source.html
+1 -1
View File
@@ -94,7 +94,7 @@ $(function() {
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>[assembly: System.Reflection.AssemblyCopyrightAttribute(<span class="stringliteral">&quot;Copyright (c) Jordan Brown 2018&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyDescriptionAttribute(<span class="stringliteral">&quot;Common functions for tgstation-server.&quot;</span>)]</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>[assembly: System.Reflection.AssemblyFileVersionAttribute(<span class="stringliteral">&quot;7.0.0.0&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;7.0.0+100887232a36bb73a95f15415a4d729c623fb2b9&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;7.0.0+0b0c50d4afa5c94267ca1bda1c241aed43a46016&quot;</span>)]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>[assembly: System.Reflection.AssemblyProductAttribute(<span class="stringliteral">&quot;Tgstation.Server.Common&quot;</span>)]</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>[assembly: System.Reflection.AssemblyTitleAttribute(<span class="stringliteral">&quot;Tgstation.Server.Common&quot;</span>)]</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>[assembly: System.Reflection.AssemblyVersionAttribute(<span class="stringliteral">&quot;7.0.0.0&quot;</span>)]</div>
_tgstation_8_server_8_host_8_assembly_info_8cs_source.html
+1 -1
View File
@@ -92,7 +92,7 @@ $(function() {
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>[assembly: System.Reflection.AssemblyCompanyAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host&quot;</span>)]</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>[assembly: System.Reflection.AssemblyConfigurationAttribute(<span class="stringliteral">&quot;Release&quot;</span>)]</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>[assembly: System.Reflection.AssemblyFileVersionAttribute(<span class="stringliteral">&quot;6.1.2.0&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;6.1.2+100887232a36bb73a95f15415a4d729c623fb2b9&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;6.1.2+0b0c50d4afa5c94267ca1bda1c241aed43a46016&quot;</span>)]</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>[assembly: System.Reflection.AssemblyProductAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyTitleAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host&quot;</span>)]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>[assembly: System.Reflection.AssemblyVersionAttribute(<span class="stringliteral">&quot;6.1.2.0&quot;</span>)]</div>
_tgstation_8_server_8_host_8_common_8_assembly_info_8cs_source.html
+1 -1
View File
@@ -92,7 +92,7 @@ $(function() {
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>[assembly: System.Reflection.AssemblyCompanyAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host.Common&quot;</span>)]</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>[assembly: System.Reflection.AssemblyConfigurationAttribute(<span class="stringliteral">&quot;Release&quot;</span>)]</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>[assembly: System.Reflection.AssemblyFileVersionAttribute(<span class="stringliteral">&quot;6.1.2.0&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;6.1.2+100887232a36bb73a95f15415a4d729c623fb2b9&quot;</span>)]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>[assembly: System.Reflection.AssemblyInformationalVersionAttribute(<span class="stringliteral">&quot;6.1.2+0b0c50d4afa5c94267ca1bda1c241aed43a46016&quot;</span>)]</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>[assembly: System.Reflection.AssemblyProductAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host.Common&quot;</span>)]</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>[assembly: System.Reflection.AssemblyTitleAttribute(<span class="stringliteral">&quot;Tgstation.Server.Host.Common&quot;</span>)]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>[assembly: System.Reflection.AssemblyVersionAttribute(<span class="stringliteral">&quot;6.1.2.0&quot;</span>)]</div>
class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html
+7 -3
View File
@@ -310,12 +310,16 @@ Static Private Attributes</h2></td></tr>
<div class="line"><span class="lineno"> 187</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (this.GetCopyDirectoryTaskThrottle() &lt; 1)</div>
<div class="line"><span class="lineno"> 188</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException(</div>
<div class="line"><span class="lineno"> 189</span> $<span class="stringliteral">&quot;{nameof(DeploymentDirectoryCopyTasksPerCore)} is too large for the CPU core count of {Environment.ProcessorCount} and overflows a 32-bit signed integer. Please lower the value!&quot;</span>);</div>
<div class="line"><span class="lineno"> 190</span> }</div>
<div class="line"><span class="lineno"> 190</span> </div>
<div class="line"><span class="lineno"> 191</span> <span class="keywordflow">if</span> (<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a51431792c5538add1bdad55e499a4971">ByondTopicTimeout</a> &lt;= 1000)</div>
<div class="line"><span class="lineno"> 192</span> logger.LogWarning(<span class="stringliteral">&quot;The timeout for sending BYOND topics is very low ({ms}ms). Topic calls may fail to complete at all!&quot;</span>, <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a51431792c5538add1bdad55e499a4971">ByondTopicTimeout</a>);</div>
<div class="line"><span class="lineno"> 193</span> }</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration_html_a0013cf7d170889a776193f9c0792a78d"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a0013cf7d170889a776193f9c0792a78d">Tgstation.Server.Host.Configuration.GeneralConfiguration.DeploymentDirectoryCopyTasksPerCore</a></div><div class="ttdeci">uint? DeploymentDirectoryCopyTasksPerCore</div><div class="ttdoc">A limit on the amount of tasks used for asynchronous I/O when copying directories during the deployme...</div><div class="ttdef"><b>Definition:</b> <a href="_general_configuration_8cs_source.html#l00135">GeneralConfiguration.cs:135</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration_html_a11cacc87b093badf8b45cc9fd858df54"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a11cacc87b093badf8b45cc9fd858df54">Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion</a></div><div class="ttdeci">static readonly Version CurrentConfigVersion</div><div class="ttdoc">The current ConfigVersion.</div><div class="ttdef"><b>Definition:</b> <a href="_general_configuration_8cs_source.html#l00079">GeneralConfiguration.cs:79</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration_html_a51431792c5538add1bdad55e499a4971"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a51431792c5538add1bdad55e499a4971">Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout</a></div><div class="ttdeci">uint ByondTopicTimeout</div><div class="ttdoc">The timeout in milliseconds for sending and receiving topics to/from DreamDaemon. Note that a single ...</div><div class="ttdef"><b>Definition:</b> <a href="_general_configuration_8cs_source.html#l00105">GeneralConfiguration.cs:105</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration_html_a786c0da035badd8742a8dfed1f45e655"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a786c0da035badd8742a8dfed1f45e655">Tgstation.Server.Host.Configuration.GeneralConfiguration.ConfigVersion</a></div><div class="ttdeci">Version? ConfigVersion</div><div class="ttdoc">The Version the file says it is.</div><div class="ttdef"><b>Definition:</b> <a href="_general_configuration_8cs_source.html#l00084">GeneralConfiguration.cs:84</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_general_configuration_8cs_source.html#l00084">Tgstation.Server.Host.Configuration.GeneralConfiguration.ConfigVersion</a>, <a class="el" href="_general_configuration_8cs_source.html#l00079">Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion</a>, and <a class="el" href="_general_configuration_8cs_source.html#l00135">Tgstation.Server.Host.Configuration.GeneralConfiguration.DeploymentDirectoryCopyTasksPerCore</a>.</p>
<p class="reference">References <a class="el" href="_general_configuration_8cs_source.html#l00105">Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout</a>, <a class="el" href="_general_configuration_8cs_source.html#l00084">Tgstation.Server.Host.Configuration.GeneralConfiguration.ConfigVersion</a>, <a class="el" href="_general_configuration_8cs_source.html#l00079">Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion</a>, and <a class="el" href="_general_configuration_8cs_source.html#l00135">Tgstation.Server.Host.Configuration.GeneralConfiguration.DeploymentDirectoryCopyTasksPerCore</a>.</p>
<p class="reference">Referenced by <a class="el" href="_instance_manager_8cs_source.html#l00668">Tgstation.Server.Host.Components.InstanceManager.CheckSystemCompatibility()</a>.</p>
<div class="dynheader">
@@ -713,7 +717,7 @@ Here is the caller graph for this function:</div>
<div class="fragment"><div class="line"><span class="lineno"> 105</span>{ <span class="keyword">get</span>; <span class="keyword">set</span>; } = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a9f825b6fe4bb53fd2c8317b271b57157">DefaultByondTopicTimeout</a>;</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration_html_a9f825b6fe4bb53fd2c8317b271b57157"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html#a9f825b6fe4bb53fd2c8317b271b57157">Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultByondTopicTimeout</a></div><div class="ttdeci">const uint DefaultByondTopicTimeout</div><div class="ttdoc">The default value for ByondTopicTimeout.</div><div class="ttdef"><b>Definition:</b> <a href="_general_configuration_8cs_source.html#l00054">GeneralConfiguration.cs:54</a></div></div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_database_seeder_8cs_source.html#l00195">Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase()</a>.</p>
<p class="reference">Referenced by <a class="el" href="_general_configuration_8cs_source.html#l00168">Tgstation.Server.Host.Configuration.GeneralConfiguration.CheckCompatibility()</a>, and <a class="el" href="_database_seeder_8cs_source.html#l00195">Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase()</a>.</p>
</div>
</div>