cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-26 14:37:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Deploy code docs to GitHub Pages for workflow run 3317

Browse Source 
Commit: 6ab17dd3e7
This commit is contained in:
tgstation-server-ci[bot]
2024-09-10 00:12:34 +00:00
parent dbda4d4a7e
commit a5c0cc4e84
1643 changed files with 32037 additions and 15983 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_swarm_controller_8cs_source.html
+4 -4
View File
@@ -148,7 +148,7 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">if</span> (registrationRequest.ServerVersion != <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a3b75126b441bc6bb8f7d313ba7f7285e">assemblyInformationProvider</a>.<a class="code hl_property" href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html#a600df9ffd79d4f94f59dfefccbcec099">Version</a>)</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> StatusCode((<span class="keywordtype">int</span>)HttpStatusCode.UpgradeRequired);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> var registrationResult = await <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a16304a5cba8be41beb3cb5515b34cc47">swarmOperations</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a3964b58ba09bd622599faf058e362e35">RegisterNode</a>(registrationRequest, RequestRegistrationId, cancellationToken);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> var registrationResult = await <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a16304a5cba8be41beb3cb5515b34cc47">swarmOperations</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a79bac4e53bb5abeaea2bf3ab24d9c53f">RegisterNode</a>(registrationRequest, RequestRegistrationId, cancellationToken);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">if</span> (!registrationResult)</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordflow">return</span> Conflict();</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordflow">return</span> NoContent();</div>
@@ -195,7 +195,7 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a26fce6c0c9aebd0086ef4cb1ba3d942f">ValidateRegistration</a>())</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keywordflow">return</span> Forbid();</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a16304a5cba8be41beb3cb5515b34cc47">swarmOperations</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a2ba1740a5fd62d86167cb46c1440f280">UpdateSwarmServersList</a>(serversUpdateRequest.SwarmServers);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html#a16304a5cba8be41beb3cb5515b34cc47">swarmOperations</a>.<a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#afb0606a66b859b7b0cdcca479c3a251d">UpdateSwarmServersList</a>(serversUpdateRequest.SwarmServers);</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <span class="keywordflow">return</span> NoContent();</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> }</div>
</div>
@@ -328,12 +328,12 @@ $(document).ready(function() { init_codefold(0); });
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_serilog_context_helper_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_serilog_context_helper.html">Tgstation.Server.Host.Utils.SerilogContextHelper</a></div><div class="ttdoc">Helpers for manipulating the Serilog.Context.LogContext.</div><div class="ttdef"><b>Definition</b> <a href="_serilog_context_helper_8cs_source.html#l00006">SerilogContextHelper.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_serilog_context_helper_html_a7f89c3849eed49a11fa1a7e1541fe9e5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_serilog_context_helper.html#a7f89c3849eed49a11fa1a7e1541fe9e5">Tgstation.Server.Host.Utils.SerilogContextHelper.RequestPathContextProperty</a></div><div class="ttdeci">const string RequestPathContextProperty</div><div class="ttdoc">The Serilog.Context.LogContext property name for Models.User Api.Models.EntityId.Ids.</div><div class="ttdef"><b>Definition</b> <a href="_serilog_context_helper_8cs_source.html#l00021">SerilogContextHelper.cs:21</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html">Tgstation.Server.Host.Swarm.ISwarmOperations</a></div><div class="ttdoc">Swarm service operations for the Controllers.SwarmController.</div><div class="ttdef"><b>Definition</b> <a href="_i_swarm_operations_8cs_source.html#l00013">ISwarmOperations.cs:14</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a2ba1740a5fd62d86167cb46c1440f280"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a2ba1740a5fd62d86167cb46c1440f280">Tgstation.Server.Host.Swarm.ISwarmOperations.UpdateSwarmServersList</a></div><div class="ttdeci">void UpdateSwarmServersList(IEnumerable&lt; SwarmServerResponse &gt; swarmServers)</div><div class="ttdoc">Pass in an updated list of swarmServers to the node.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a34a25b0431db9e68c67653afc95954ae"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a34a25b0431db9e68c67653afc95954ae">Tgstation.Server.Host.Swarm.ISwarmOperations.UnregisterNode</a></div><div class="ttdeci">ValueTask UnregisterNode(Guid registrationId, CancellationToken cancellationToken)</div><div class="ttdoc">Attempt to unregister a node with a given registrationId with the controller.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a3964b58ba09bd622599faf058e362e35"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a3964b58ba09bd622599faf058e362e35">Tgstation.Server.Host.Swarm.ISwarmOperations.RegisterNode</a></div><div class="ttdeci">ValueTask&lt; bool &gt; RegisterNode(Api.Models.Internal.SwarmServer node, Guid registrationId, CancellationToken cancellationToken)</div><div class="ttdoc">Attempt to register a given node with the controller.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a57c5e7330722cd5de88f512432712b35"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a57c5e7330722cd5de88f512432712b35">Tgstation.Server.Host.Swarm.ISwarmOperations.RemoteCommitReceived</a></div><div class="ttdeci">ValueTask&lt; bool &gt; RemoteCommitReceived(Guid registrationId, CancellationToken cancellationToken)</div><div class="ttdoc">Notify the controller that the node with the given registrationId is ready to commit or notify the n...</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a79bac4e53bb5abeaea2bf3ab24d9c53f"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a79bac4e53bb5abeaea2bf3ab24d9c53f">Tgstation.Server.Host.Swarm.ISwarmOperations.RegisterNode</a></div><div class="ttdeci">ValueTask&lt; bool &gt; RegisterNode(SwarmServer node, Guid registrationId, CancellationToken cancellationToken)</div><div class="ttdoc">Attempt to register a given node with the controller.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_a7e8067294cc6dec3fcf9617703f3b85f"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a7e8067294cc6dec3fcf9617703f3b85f">Tgstation.Server.Host.Swarm.ISwarmOperations.PrepareUpdateFromController</a></div><div class="ttdeci">ValueTask&lt; bool &gt; PrepareUpdateFromController(SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)</div><div class="ttdoc">Notify the node of an update request from the controller.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_aa15c22a966aef83c93a0b6c429edf9fb"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa15c22a966aef83c93a0b6c429edf9fb">Tgstation.Server.Host.Swarm.ISwarmOperations.ValidateRegistration</a></div><div class="ttdeci">bool ValidateRegistration(Guid registrationId)</div><div class="ttdoc">Validate a given registrationId .</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations_html_afb0606a66b859b7b0cdcca479c3a251d"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#afb0606a66b859b7b0cdcca479c3a251d">Tgstation.Server.Host.Swarm.ISwarmOperations.UpdateSwarmServersList</a></div><div class="ttdeci">void UpdateSwarmServersList(IEnumerable&lt; SwarmServerInformation &gt; swarmServers)</div><div class="ttdoc">Pass in an updated list of swarmServers to the node.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_update_aborter_html_ac68948445b85942f29d2b618dfea9763"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_update_aborter.html#ac68948445b85942f29d2b618dfea9763">Tgstation.Server.Host.Swarm.ISwarmUpdateAborter.AbortUpdate</a></div><div class="ttdeci">ValueTask AbortUpdate()</div><div class="ttdoc">Attempt to abort an uncommitted update.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html">Tgstation.Server.Host.System.IAssemblyInformationProvider</a></div><div class="ttdoc">For retrieving the Assembly's location.</div><div class="ttdef"><b>Definition</b> <a href="_i_assembly_information_provider_8cs_source.html#l00010">IAssemblyInformationProvider.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider_html_a600df9ffd79d4f94f59dfefccbcec099"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_system_1_1_i_assembly_information_provider.html#a600df9ffd79d4f94f59dfefccbcec099">Tgstation.Server.Host.System.IAssemblyInformationProvider.Version</a></div><div class="ttdeci">Version Version</div><div class="ttdoc">The version of the assembly.</div><div class="ttdef"><b>Definition</b> <a href="_i_assembly_information_provider_8cs_source.html#l00035">IAssemblyInformationProvider.cs:35</a></div></div>