SwarmInterface

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public class

FAlertMessage

Implementation of a alert message, which includes:

Public class

FInfoMessage

Implementation of a generic info message, which just includes generic text.

Public class

FJobSpecification

Encapsulates information about a Job specification passed into BeginJobSpecification

Public class

FJobState

Encapsulates information about a Job's state, used to communicate back to the Instigator

Public class

FMessage

A simple base class for messages.

Public class

FSwarmInterface

The primary interface to the Swarm system

Public class

FTaskRequestResponse

Implementation of a task request response message.

Public class

FTaskSpecification

Encapsulates information about a Task specification passed into AddTask and later sent in response to a TASK_REQUEST message

Public class

FTaskState

Encapsulates information about a Task's state, used to communicate back to the Instigator

Public class

FTimingMessage

Implementation of a generic info message, which just includes generic text.

Typedefs

Name

Description

FConnectionCallback

A simple callback used by the Agent to send messages back to the Instigator

Enums

Name

Description

Public enum

NSwarm::

Public enum

NSwarm::TAlertLevel

The alert levels

Public enum

NSwarm::TChannelFlags

Flags that define the intended behavior of the channel.

Public enum

NSwarm::TJobTaskFlags

Flags used when creating a Job or Task

Public enum

NSwarm::TJobTaskState

All possible states a Job or Task can be in

Public enum

NSwarm::TLogColour

Available colours used in log text.

Public enum

NSwarm::TLogFlags

Flags to determine the level of logging

Public enum

NSwarm::TMessageType

Public enum

NSwarm::TProgressionState

The current state of the lighting build process

Public enum

NSwarm::TSwarmVersionValue

Consistent version enum used by messages, Jobs, Tasks, etc.

Public enum

NSwarm::TTaskRequestResponseType

Public enum

NSwarm::TVerbosityLevel

The level of debug info spewed to the log files