Navigation
Unreal Engine C++ API Reference > Editor > SwarmInterface
References
Module | SwarmInterface |
Header | /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h |
Include | #include "SwarmInterface.h" |
Syntax
class FSwarmInterface
Remarks
The primary interface to the Swarm system
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
int32 | AddChannel
(
const TCHAR* FullPath, |
Adds an existing file to the cache. |
![]() |
int32 | AddTask
(
const FTaskSpecification& Specification |
Adds a Task to the current Job |
![]() |
int32 | BeginJobSpecification
(
const FJobSpecification& Specification32, |
Begins a Job specification, which allows a series of Tasks to be specified via AddTask. |
![]() |
int32 | CloseChannel
(
int32 Channel |
Closes an open channel |
![]() |
int32 | Closes an existing connection to the Swarm | |
![]() |
int32 | CloseJob () |
Ends the Job, after which all Job-related API usage (except OpenJob) will be rejected |
![]() |
int32 | Ends the Job specification, after which no additional Tasks may be defined. | |
![]() ![]() |
FSwarmInterface & | Get () |
|
![]() ![]() |
bool | Initialize
(
const TCHAR* SwarmInterfacePath |
Initializes the Swarm singleton, must be called before FSwarmInterface::Get(). |
![]() ![]() |
bool | IsJobProcessRunning
(
int32* OutStatus |
Checks if the job's process is still running |
![]() |
int32 | Log
(
TVerbosityLevel Verbosity, |
Adds a line of text to the Agent log window |
![]() |
int32 | OpenChannel
(
const TCHAR* ChannelName, |
Opens a data channel for streaming data into the cache associated with an Agent |
![]() |
int32 | OpenConnection
(
FConnectionCallback CallbackFunc, |
Opens a new connection to the Swarm |
![]() |
int32 | Opens a Job session, which allows a Job to be specified, Tasks added, Job channels opened and used, etc. | |
![]() |
int32 | ReadChannel
(
int32 Channel, |
Reads data from a channel opened for READ into the provided buffer |
![]() |
int32 | SendMessage
(
const FMessage& Message |
Sends a message to an Agent (return messages are sent via the FConnectionCallback) |
![]() ![]() |
void | SetJobGuid
(
const FGuid& JobGuid |
|
![]() |
int32 | TestChannel
(
const TCHAR* ChannelName |
Determines if the named channel is in the cache |
![]() |
int32 | WriteChannel
(
int32 Channel, |
Writes the provided data to the open channel opened for WRITE |
Constants
Name | Description |
---|---|
GInstance |