Classes
interface	ISwarmOperations
	Swarm service operations for the Controllers.SwarmController. More...

interface	ISwarmService
	Used for swarm operations. Functions may be no-op based on configuration. More...

interface	ISwarmServiceController
	Start and stop controllers for a swarm service. More...

interface	ISwarmUpdateAborter
	Allows aborting a swarm distributed update operation. More...

class	SwarmConstants
	Constants used by the swarm system. More...

class	SwarmRegistrationRequest
	A request to register with a swarm controller. More...

class	SwarmRegistrationResponse
	Response for a SwarmRegistrationRequest. More...

class	SwarmServersUpdateRequest
	A request to update a nodes list of SwarmServers. More...

class	SwarmService
	Helps keep servers connected to the same database in sync by coordinating updates. More...

class	SwarmUpdateOperation
	Represents the state of a distributed swarm update. More...

class	SwarmUpdateRequest
	A request to update the swarm's TGS version. More...

Enumerations
enum	SwarmCommitResult { AbortUpdate , ContinueUpdateNonCommitted , MustCommitUpdate }
	How to proceed on the commit step of an update. More...

enum	SwarmPrepareResult { Failure , SuccessHoldProviderUntilCommit , SuccessProviderNotRequired }
	Indicates the result of a swarm update prepare operation. More...

enum	SwarmRegistrationResult { Success , Unauthorized , VersionMismatch , CommunicationFailure , PayloadFailure }
	Result of attempting to register with a swarm controller. More...

enum	SwarmUpdateAbortResult { Aborted , AlreadyAborted , CantAbortCommitted }
	Result of attempting to abort a SwarmUpdateOperation. More...

Enumeration Type Documentation

◆ SwarmCommitResult

How to proceed on the commit step of an update.

Enumerator
AbortUpdate	The update should be aborted.
ContinueUpdateNonCommitted	The update should be committed.
MustCommitUpdate	The update MUST be committed.

Definition at line 6 of file SwarmCommitResult.cs.

    {
        AbortUpdate,
 
        ContinueUpdateNonCommitted,
 
        MustCommitUpdate,
    }

Indicates the result of a swarm update prepare operation.

Enumerator
Failure	Preparation failed.
SuccessHoldProviderUntilCommit	Preparation succeeded. The input IO.ISeekableFileStreamProvider must be kept available until after the swarm commit.
SuccessProviderNotRequired	Preparation succeeded. The input IO.ISeekableFileStreamProvider is not longer required.

Definition at line 6 of file SwarmPrepareResult.cs.

    {
        Failure,
 
        SuccessHoldProviderUntilCommit,
 
        SuccessProviderNotRequired,
    }

Result of attempting to register with a swarm controller.

Enumerator
Success	The registration succeeded.
Unauthorized	The swarm private keys didn't match.
VersionMismatch	The swarm controller is running a different server version.
CommunicationFailure	A communication error occurred.
PayloadFailure	Response could not be deserialized.

Definition at line 6 of file SwarmRegistrationResult.cs.

    {
        Success,
 
        Unauthorized,
 
        VersionMismatch,
 
        CommunicationFailure,
 
        PayloadFailure,
    }

Result of attempting to abort a SwarmUpdateOperation.

Enumerator
Aborted	The operation was successfully aborted by the caller and followup actions should be perform.
AlreadyAborted	The operation was already successfully aborted by another caller.
CantAbortCommitted	The operation cannot abort because it has committed.

Definition at line 6 of file SwarmUpdateAbortResult.cs.

    {
        Aborted,
 
        AlreadyAborted,
 
        CantAbortCommitted,
    }