+Go to the documentation of this file.
-
+
-
-
-
diff --git a/_master_versions_attribute_8cs_source.html b/_master_versions_attribute_8cs_source.html
index c238e39eb0..13239c3935 100644
--- a/_master_versions_attribute_8cs_source.html
+++ b/_master_versions_attribute_8cs_source.html
@@ -106,32 +106,37 @@
-
-
-
-
-
-
-
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
-
+
Represents a JWT returned by the API.
Definition TokenResponse.cs:9
For creating TokenResponses.
Definition ITokenFactory.cs:11
For creating TokenResponses.
Definition ITokenFactory.cs:13
TokenResponse CreateToken(Models.User user, bool oAuth)
Create a TokenResponse for a given user .
TokenValidationParameters ValidationParameters
The TokenValidationParameters for the ITokenFactory.
Definition ITokenFactory.cs:15
TokenValidationParameters ValidationParameters
The TokenValidationParameters for the ITokenFactory.
Definition ITokenFactory.cs:22
ReadOnlySpan< byte > SigningKeyBytes
Gets or sets the ITokenFactory's signing key bytes.
Definition ITokenFactory.cs:17
-
-
-
-
-
-
-
-
-
+
59 RawConfigurationVersion = rawConfigurationVersion ?? throw new ArgumentNullException(nameof(rawConfigurationVersion));
- 60 RawInteropVersion = rawInteropVersion ?? throw new ArgumentNullException(nameof(rawInteropVersion));
- 61 RawWebpanelVersion = rawWebpanelVersion ?? throw new ArgumentNullException(nameof(rawWebpanelVersion));
- 62 RawHostWatchdogVersion = rawHostWatchdogVersion ?? throw new ArgumentNullException(nameof(rawHostWatchdogVersion));
- 63 RawMariaDBRedistVersion = rawMariaDBRedistVersion ?? throw new ArgumentNullException(nameof(rawMariaDBRedistVersion));
-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
66 RawConfigurationVersion = rawConfigurationVersion ?? throw new ArgumentNullException(nameof(rawConfigurationVersion));
+ 67 RawInteropVersion = rawInteropVersion ?? throw new ArgumentNullException(nameof(rawInteropVersion));
+ 68 RawWebpanelVersion = rawWebpanelVersion ?? throw new ArgumentNullException(nameof(rawWebpanelVersion));
+ 69 RawHostWatchdogVersion = rawHostWatchdogVersion ?? throw new ArgumentNullException(nameof(rawHostWatchdogVersion));
+ 70 RawMariaDBRedistVersion = rawMariaDBRedistVersion ?? throw new ArgumentNullException(nameof(rawMariaDBRedistVersion));
+ 71 RawSwarmProtocolVersion = rawSwarmProtocolVersion ?? throw new ArgumentNullException(nameof(rawSwarmProtocolVersion));
+
Attribute for bringing in the master versions list from MSBuild that aren't embedded into assemblies ...
Definition MasterVersionsAttribute.cs:11
MasterVersionsAttribute(string rawConfigurationVersion, string rawInteropVersion, string rawWebpanelVersion, string rawHostWatchdogVersion, string rawMariaDBRedistVersion)
Initializes a new instance of the MasterVersionsAttribute class.
Definition MasterVersionsAttribute.cs:52
MasterVersionsAttribute(string rawConfigurationVersion, string rawInteropVersion, string rawWebpanelVersion, string rawHostWatchdogVersion, string rawMariaDBRedistVersion, string rawSwarmProtocolVersion)
Initializes a new instance of the MasterVersionsAttribute class.
Definition MasterVersionsAttribute.cs:58
string RawMariaDBRedistVersion
The Version string of the MariaDB server bundled with TGS installs.
Definition MasterVersionsAttribute.cs:42
string RawHostWatchdogVersion
The Version string of the control panel version built.
Definition MasterVersionsAttribute.cs:37
string RawWebpanelVersion
The Version string of the control panel version built.
Definition MasterVersionsAttribute.cs:32
string RawInteropVersion
The Version string of the DMAPI interop version used.
Definition MasterVersionsAttribute.cs:27
string RawSwarmProtocolVersion
The Version string of the MariaDB server bundled with TGS installs.
Definition MasterVersionsAttribute.cs:47
string RawConfigurationVersion
The Version string of the Configuration version built.
Definition MasterVersionsAttribute.cs:22
static MasterVersionsAttribute Instance
Return the Assembly's instance of the MasterVersionsAttribute.
Definition MasterVersionsAttribute.cs:15
IFileStreamProvider FileStreamProvider
The IFileStreamProvider that contains the update zip file.
Definition ServerUpdateOperation.cs:16
ServerUpdateOperation(IFileStreamProvider fileStreamProvider, ISwarmService swarmService, Version targetVersion)
Initializes a new instance of the ServerUpdateOperation class.
Definition ServerUpdateOperation.cs:34
Helps keep servers connected to the same database in sync by coordinating updates.
Definition SwarmService.cs:37
Helps keep servers connected to the same database in sync by coordinating updates.
Definition SwarmService.cs:41
Interface for asynchronously consuming Streams of files.
Definition IFileStreamProvider.cs:12
Used for swarm operations. Functions may be no-op based on configuration.
Definition ISwarmService.cs:15
Definition Application.cs:70
-
-
-
-
-
-
-
-
77 this.swarmOperations = swarmOperations ?? throw new ArgumentNullException(nameof(swarmOperations));
- 78 this.assemblyInformationProvider = assemblyInformationProvider ?? throw new ArgumentNullException(nameof(assemblyInformationProvider));
- 79 this.transferService = transferService ?? throw new ArgumentNullException(nameof(transferService));
- 80 swarmConfiguration = swarmConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(swarmConfigurationOptions));
-
-
+
+
+
+
+
+
+
+
-
-
- 70 this.swarmOperations = swarmOperations ?? throw new ArgumentNullException(nameof(swarmOperations));
+ 71 this.transferService = transferService ?? throw new ArgumentNullException(nameof(transferService));
+ 72 swarmConfiguration = swarmConfigurationOptions?.Value ?? throw new ArgumentNullException(nameof(swarmConfigurationOptions));
+
+
-
91 public async ValueTask<IActionResult> Register([FromBody] SwarmRegistrationRequest registrationRequest, CancellationToken cancellationToken)
-
-
+
+
+
+
-
-
- 83 public async ValueTask<IActionResult> Register([FromBody] SwarmRegistrationRequest registrationRequest, CancellationToken cancellationToken)
+
+
+
+ 87 var swarmProtocolVersion = Version.Parse(MasterVersionsAttribute.Instance.RawSwarmProtocolVersion);
+
+
+
+ 91 var registrationResult = await swarmOperations.RegisterNode(registrationRequest, RequestRegistrationId, cancellationToken);
+
+
-
-
+
+ 96 logger.LogWarning("Allowed node {identifier} to register despite having a slightly different swarm protocol version!", registrationRequest.Identifier);
- 98 var registrationResult = await swarmOperations.RegisterNode(registrationRequest, RequestRegistrationId, cancellationToken);
-
-
-
-
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+tgstation-server: src/Tgstation.Server.Host/Swarm/SwarmRegistrationResponse.cs File Reference
+
+
+
+
+
+
+
+
+
+
+Generated by
1.9.8
+
+
+
diff --git a/_swarm_registration_response_8cs_source.html b/_swarm_registration_response_8cs_source.html
new file mode 100644
index 0000000000..f68f8de3f0
--- /dev/null
+++ b/_swarm_registration_response_8cs_source.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+tgstation-server: src/Tgstation.Server.Host/Swarm/SwarmRegistrationResponse.cs Source File
+
+
+
+
+
+
+
+
+
+
+Generated by 1.9.8
+
+
+
diff --git a/_swarm_registration_result_8cs.html b/_swarm_registration_result_8cs.html
index 5f02235f3f..27b7a25e0b 100644
--- a/_swarm_registration_result_8cs.html
+++ b/_swarm_registration_result_8cs.html
@@ -96,10 +96,14 @@
+
+
+
+
+
+
+
-
-
-
- 140 public ValueTask<IActionResult> GetUpdatePackage([FromQuery] string ticket, CancellationToken cancellationToken)
-
-
-
-
-
-
-
+
+
+
+
diff --git a/_swarm_registration_response_8cs.html b/_swarm_registration_response_8cs.html
new file mode 100644
index 0000000000..eeed219fe5
--- /dev/null
+++ b/_swarm_registration_response_8cs.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+ 137 public ValueTask<IActionResult> GetUpdatePackage([FromQuery] string ticket, CancellationToken cancellationToken)
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-
-
-
-
-
+
+
+
-
-
-
-
-
+
170 public async ValueTask<IActionResult> PrepareUpdate([FromBody] SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)
-
-
+
+
+
+
-
-
- 167 public async ValueTask<IActionResult> PrepareUpdate([FromBody] SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)
+
+
+
+
+
-
-
-
- 177 var prepareResult = await swarmOperations.PrepareUpdateFromController(updateRequest, cancellationToken);
-
-
-
-
-
+ 174 var prepareResult = await swarmOperations.PrepareUpdateFromController(updateRequest, cancellationToken);
+
+
+
+
+
-
-
-
-
-
-
diff --git a/_swarm_registration_request_8cs_source.html b/_swarm_registration_request_8cs_source.html
index 6ba514ae4e..f7eac89747 100644
--- a/_swarm_registration_request_8cs_source.html
+++ b/_swarm_registration_request_8cs_source.html
@@ -107,7 +107,7 @@
195 var result = await swarmOperations.RemoteCommitReceived(RequestRegistrationId, cancellationToken);
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
- 192 var result = await swarmOperations.RemoteCommitReceived(RequestRegistrationId, cancellationToken);
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
@@ -303,19 +304,21 @@
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
@@ -330,20 +333,18 @@
-
+
-
-
+
-
+
+
+
+
+
+
+
+
-
-
-
-
+
216 protected override async ValueTask<IActionResult?> HookExecuteAction(Func<Task> executeAction, CancellationToken cancellationToken)
-
- 218 using (LogContext.PushProperty(SerilogContextHelper.RequestPathContextProperty, $"{Request.Method} {Request.Path}"))
-
- 220 logger.LogTrace("Swarm request from {remoteIP}...", Request.HttpContext.Connection.RemoteIpAddress);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 235 if (!(Request.Headers.TryGetValue(SwarmConstants.RegistrationIdHeader, out var registrationHeaderValues)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
-
-
+
+
+
213 protected override async ValueTask<IActionResult?> HookExecuteAction(Func<Task> executeAction, CancellationToken cancellationToken)
+
+ 215 using (LogContext.PushProperty(SerilogContextHelper.RequestPathContextProperty, $"{Request.Method} {Request.Path}"))
+
+ 217 logger.LogTrace("Swarm request from {remoteIP}...", Request.HttpContext.Connection.RemoteIpAddress);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 232 if (!(Request.Headers.TryGetValue(SwarmConstants.RegistrationIdHeader, out var registrationHeaderValues)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration for the server swarm system.
Definition SwarmConfiguration.cs:13
Base class for all API style controllers.
Definition ApiControllerBase.cs:19
readonly ISwarmOperations swarmOperations
The ISwarmOperations for the SwarmController.
Definition SwarmController.cs:40
bool ValidateRegistration()
Check that the RequestRegistrationId is valid.
ValueTask< IActionResult > GetUpdatePackage([FromQuery] string ticket, CancellationToken cancellationToken)
Endpoint to retrieve server update packages.
async ValueTask< IActionResult > Register([FromBody] SwarmRegistrationRequest registrationRequest, CancellationToken cancellationToken)
Registration endpoint.
Definition SwarmController.cs:91
readonly IAssemblyInformationProvider assemblyInformationProvider
The IAssemblyInformationProvider for the SwarmController.
Definition SwarmController.cs:50
override async ValueTask< IActionResult?> HookExecuteAction(Func< Task > executeAction, CancellationToken cancellationToken)
Hook for executing a request.A ValueTask<TResult> resulting in an IActionResult that,...
Definition SwarmController.cs:216
IActionResult UpdateNodeList([FromBody] SwarmServersUpdateRequest serversUpdateRequest)
Node list update endpoint.
Definition SwarmController.cs:149
readonly SwarmConfiguration swarmConfiguration
The SwarmConfiguration for the SwarmController.
Definition SwarmController.cs:60
readonly ILogger< SwarmController > logger
The ILogger for the SwarmController.
Definition SwarmController.cs:55
async ValueTask< IActionResult > PrepareUpdate([FromBody] SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)
Update initiation endpoint.
Definition SwarmController.cs:170
SwarmController(ISwarmOperations swarmOperations, IAssemblyInformationProvider assemblyInformationProvider, IFileTransferStreamHandler transferService, IOptions< SwarmConfiguration > swarmConfigurationOptions, ILogger< SwarmController > logger)
Initializes a new instance of the SwarmController class.
Definition SwarmController.cs:70
async ValueTask< IActionResult > AbortUpdate()
Update abort endpoint.
Definition SwarmController.cs:206
async ValueTask< IActionResult > Register([FromBody] SwarmRegistrationRequest registrationRequest, CancellationToken cancellationToken)
Registration endpoint.
Definition SwarmController.cs:83
override async ValueTask< IActionResult?> HookExecuteAction(Func< Task > executeAction, CancellationToken cancellationToken)
Hook for executing a request.A ValueTask<TResult> resulting in an IActionResult that,...
Definition SwarmController.cs:213
IActionResult UpdateNodeList([FromBody] SwarmServersUpdateRequest serversUpdateRequest)
Node list update endpoint.
Definition SwarmController.cs:146
readonly SwarmConfiguration swarmConfiguration
The SwarmConfiguration for the SwarmController.
Definition SwarmController.cs:55
SwarmController(ISwarmOperations swarmOperations, IFileTransferStreamHandler transferService, IOptions< SwarmConfiguration > swarmConfigurationOptions, ILogger< SwarmController > logger)
Initializes a new instance of the SwarmController class.
Definition SwarmController.cs:64
readonly ILogger< SwarmController > logger
The ILogger for the SwarmController.
Definition SwarmController.cs:50
async ValueTask< IActionResult > PrepareUpdate([FromBody] SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)
Update initiation endpoint.
Definition SwarmController.cs:167
async ValueTask< IActionResult > AbortUpdate()
Update abort endpoint.
Definition SwarmController.cs:203
readonly IFileTransferStreamHandler transferService
The IFileTransferStreamHandler for the SwarmController.
Definition SwarmController.cs:45
async ValueTask< IActionResult > CommitUpdate(CancellationToken cancellationToken)
Update commit endpoint.
Definition SwarmController.cs:190
async ValueTask< IActionResult > UnregisterNode(CancellationToken cancellationToken)
Deregistration endpoint.
Definition SwarmController.cs:110
async ValueTask< IActionResult > CommitUpdate(CancellationToken cancellationToken)
Update commit endpoint.
Definition SwarmController.cs:187
async ValueTask< IActionResult > UnregisterNode(CancellationToken cancellationToken)
Deregistration endpoint.
Definition SwarmController.cs:107
Attribute for bringing in the master versions list from MSBuild that aren't embedded into assemblies ...
Definition MasterVersionsAttribute.cs:11
string RawSwarmProtocolVersion
The Version string of the MariaDB server bundled with TGS installs.
Definition MasterVersionsAttribute.cs:47
static MasterVersionsAttribute Instance
Return the Assembly's instance of the MasterVersionsAttribute.
Definition MasterVersionsAttribute.cs:15
Constants used by the swarm system.
Definition SwarmConstants.cs:14
const string ApiKeyHeader
The header used to pass in the Configuration.SwarmConfiguration.PrivateKey.
Definition SwarmConstants.cs:23
Swarm service operations for the Controllers.SwarmController.
Definition ISwarmOperations.cs:14
ValueTask UnregisterNode(Guid registrationId, CancellationToken cancellationToken)
Attempt to unregister a node with a given registrationId with the controller.
ValueTask< bool > RemoteCommitReceived(Guid registrationId, CancellationToken cancellationToken)
Notify the controller that the node with the given registrationId is ready to commit or notify the n...
ValueTask< bool > RegisterNode(SwarmServer node, Guid registrationId, CancellationToken cancellationToken)
Attempt to register a given node with the controller.
ValueTask< bool > PrepareUpdateFromController(SwarmUpdateRequest updateRequest, CancellationToken cancellationToken)
Notify the node of an update request from the controller.
bool ValidateRegistration(Guid registrationId)
Validate a given registrationId .
ValueTask< SwarmRegistrationResponse?> RegisterNode(SwarmServer node, Guid registrationId, CancellationToken cancellationToken)
Attempt to register a given node with the controller.
void UpdateSwarmServersList(IEnumerable< SwarmServerInformation > swarmServers)
Pass in an updated list of swarmServers to the node.
ValueTask AbortUpdate()
Attempt to abort an uncommitted update.
For retrieving the Assembly's location.
Definition IAssemblyInformationProvider.cs:11
Reads and writes to Streams associated with FileTicketResponses.
Definition IFileTransferStreamHandler.cs:14
@ Unauthorized
The swarm private keys didn't match.
Information about a server in the swarm.
Definition SwarmServer.cs:10
A request to register with a swarm controller.
Definition SwarmRegistrationRequest.cs:12
SwarmRegistrationRequest(Version serverVersion)
Initializes a new instance of the SwarmRegistrationRequest class.
Definition SwarmRegistrationRequest.cs:23
Version ServerVersion
The TGS Version of the sending server.
Definition SwarmRegistrationRequest.cs:17
Version ServerVersion
The swarm protocol Version of the sending server. Named this way due to legacy reasons.
Definition SwarmRegistrationRequest.cs:17
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ tgstation-server 6.10.0
+
+ The /tg/station 13 server suite
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loading...
+Searching...
+No Matches
+
+
+
+
+Classes |
+Namespaces
+ SwarmRegistrationResponse.cs File Reference
+
+
+
+
+
+
+Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.Swarm.SwarmRegistrationResponse |
| Response for a SwarmRegistrationRequest. More... | |
+Namespaces | |
| namespace | Tgstation |
| namespace | Tgstation.Server |
| namespace | Tgstation.Server.Host |
| namespace | Tgstation.Server.Host.Swarm |
+Generated by
1.9.8
+
+
+
diff --git a/_swarm_registration_response_8cs_source.html b/_swarm_registration_response_8cs_source.html
new file mode 100644
index 0000000000..f68f8de3f0
--- /dev/null
+++ b/_swarm_registration_response_8cs_source.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ tgstation-server 6.10.0
+
+ The /tg/station 13 server suite
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loading...
+Searching...
+No Matches
+
+
+
+SwarmRegistrationResponse.cs
+Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Response for a SwarmRegistrationRequest.
Definition SwarmRegistrationResponse.cs:7
required string TokenSigningKeyBase64
The base64 encoded token signing key.
Definition SwarmRegistrationResponse.cs:11
+Generated by
1.9.8
+
+
+
diff --git a/_swarm_registration_result_8cs.html b/_swarm_registration_result_8cs.html
index 5f02235f3f..27b7a25e0b 100644
--- a/_swarm_registration_result_8cs.html
+++ b/_swarm_registration_result_8cs.html
@@ -96,10 +96,14 @@
Properties inherited from 
+
