1. Epic GamesDeveloper
  3. FSwarmInterface

FSwarmInterface

The primary interface to the Swarm system

API > API/Editor > API/Editor/SwarmInterface

The primary interface to the Swarm system

   
Name FSwarmInterface
Type class
Header File /Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h
Include Path #include "SwarmInterface.h"

Syntax

class FSwarmInterface

Constructors

Name Remarks Include Path Unreal Specifiers

FSwarmInterface()

   SwarmInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FSwarmInterface()

   SwarmInterface.h  

Constants

Name Type Remarks Include Path
GInstance FSwarmInterface *   SwarmInterface.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddChannel ( const TCHAR* FullPath,
const TCHAR* ChannelName
)

 Adds an existing file to the cache. SwarmInterface.h  

int32 AddTask ( const FTaskSpecification& Specification
)

 Adds a Task to the current Job SwarmInterface.h  

int32 BeginJobSpecification ( const FJobSpecification& Specification32,
const FJobSpecification& Specification64
)

 Begins a Job specification, which allows a series of Tasks to be specified via AddTask. SwarmInterface.h  

int32 CloseChannel ( int32 Channel
)

 Closes an open channel SwarmInterface.h  

int32 CloseConnection()

 Closes an existing connection to the Swarm SwarmInterface.h  

int32 CloseJob()

 Ends the Job, after which all Job-related API usage (except OpenJob) will be rejected SwarmInterface.h  
Ends the Job specification, after which no additional Tasks may be defined. SwarmInterface.h  

virtual bool IsJobProcessRunning ( int32* OutStatus
)

 Checks if the job's process is still running SwarmInterface.h  

int32 Log ( TVerbosityLevel Verbosity,
TLogColour TextColour,
const TCHAR* Message
)

 Adds a line of text to the Agent log window SwarmInterface.h  

int32 OpenChannel ( const TCHAR* ChannelName,
TChannelFlags ChannelFlags
)

 Opens a data channel for streaming data into the cache associated with an Agent SwarmInterface.h  

int32 OpenConnection ( FConnectionCallback CallbackFunc,
void* CallbackData,
TLogFlags LoggingFlags,
const TCHAR* OptionsFolder
)

 Opens a new connection to the Swarm SwarmInterface.h  

int32 OpenJob ( const FGuid& JobGuid
)

 Opens a Job session, which allows a Job to be specified, Tasks added, Job channels opened and used, etc. SwarmInterface.h  

int32 ReadChannel ( int32 Channel,
void* Data,
int32 DataSize
)

 Reads data from a channel opened for READ into the provided buffer SwarmInterface.h  

int32 SendMessage ( const FMessage& Message
)

 Sends a message to an Agent (return messages are sent via the FConnectionCallback) SwarmInterface.h  

virtual void SetJobGuid ( const FGuid& JobGuid
)

   SwarmInterface.h  

int32 TestChannel ( const TCHAR* ChannelName
)

 Determines if the named channel is in the cache SwarmInterface.h  

int32 WriteChannel ( int32 Channel,
const void* Data,
int32 DataSize
)

 Writes the provided data to the open channel opened for WRITE SwarmInterface.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static FSwarmInterface & Get()

   SwarmInterface.h  

static bool Initialize ( const TCHAR* SwarmInterfacePath
)

 Initializes the Swarm singleton, must be called before FSwarmInterface::Get(). SwarmInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page