mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-28 15:40:56 +01:00
132 lines
16 KiB
HTML
132 lines
16 KiB
HTML
<!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/Swarm/ISwarmOperations.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"> 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&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&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&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_d79e310510566c78de096c61d055de81.html">Swarm</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">ISwarmOperations.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_i_swarm_operations_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;</div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Collections.Generic;</div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Threading;</div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Threading.Tasks;</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_api_1_1_models_1_1_internal.html">Tgstation.Server.Api.Models.Internal</a>;</div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_host_1_1_swarm.html"> 8</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_swarm.html">Tgstation.Server.Host.Swarm</a></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
|
|
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html">ISwarmOperations</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_update_aborter.html">ISwarmUpdateAborter</a></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#afb0606a66b859b7b0cdcca479c3a251d"> 19</a></span> <span class="keywordtype">void</span> <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>(IEnumerable<SwarmServerInformation> swarmServers);</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</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_swarm_1_1_i_swarm_operations.html#a7e8067294cc6dec3fcf9617703f3b85f"> 27</a></span> ValueTask<bool> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a7e8067294cc6dec3fcf9617703f3b85f">PrepareUpdateFromController</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_update_request.html">SwarmUpdateRequest</a> updateRequest, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa15c22a966aef83c93a0b6c429edf9fb"> 34</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa15c22a966aef83c93a0b6c429edf9fb">ValidateRegistration</a>(Guid registrationId);</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa39ec096499dc538fa993a30f0713e4b"> 43</a></span> ValueTask<SwarmRegistrationResponse?> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa39ec096499dc538fa993a30f0713e4b">RegisterNode</a>(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html">SwarmServer</a> node, Guid registrationId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a34a25b0431db9e68c67653afc95954ae"> 51</a></span> ValueTask <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a34a25b0431db9e68c67653afc95954ae">UnregisterNode</a>(Guid registrationId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a57c5e7330722cd5de88f512432712b35"> 59</a></span> ValueTask<bool> <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#a57c5e7330722cd5de88f512432712b35">RemoteCommitReceived</a>(Guid registrationId, CancellationToken cancellationToken);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>}</div>
|
|
</div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html">Tgstation.Server.Api.Models.Internal.SwarmServer</a></div><div class="ttdoc">Information about a server in the swarm.</div><div class="ttdef"><b>Definition</b> <a href="_swarm_server_8cs_source.html#l00009">SwarmServer.cs:10</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_update_request_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_update_request.html">Tgstation.Server.Host.Swarm.SwarmUpdateRequest</a></div><div class="ttdoc">A request to update the swarm's TGS version.</div><div class="ttdef"><b>Definition</b> <a href="_swarm_update_request_8cs_source.html#l00012">SwarmUpdateRequest.cs:13</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_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_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< bool > 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_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< bool > 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_aa39ec096499dc538fa993a30f0713e4b"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_operations.html#aa39ec096499dc538fa993a30f0713e4b">Tgstation.Server.Host.Swarm.ISwarmOperations.RegisterNode</a></div><div class="ttdeci">ValueTask< SwarmRegistrationResponse?> 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_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< SwarmServerInformation > 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"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_i_swarm_update_aborter.html">Tgstation.Server.Host.Swarm.ISwarmUpdateAborter</a></div><div class="ttdoc">Allows aborting a swarm distributed update operation.</div><div class="ttdef"><b>Definition</b> <a href="_i_swarm_update_aborter_8cs_source.html#l00008">ISwarmUpdateAborter.cs:9</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal.html">Tgstation.Server.Api.Models.Internal</a></div><div class="ttdef"><b>Definition</b> <a href="_chat_bot_api_base_8cs_source.html#l00005">ChatBotApiBase.cs:6</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_swarm_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_swarm.html">Tgstation.Server.Host.Swarm</a></div><div class="ttdef"><b>Definition</b> <a href="_i_swarm_operations_8cs_source.html#l00008">ISwarmOperations.cs:9</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|