FSwarmInterface

The primary interface to the Swarm system

Windows
MacOS
Linux

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

Name Description

Protected function

FSwarmInterface()

Destructors

Name Description

Protected function Virtual

~FSwarmInterface()

Functions

Name Description

Public function

int32

 

AddChannel

(
    const TCHAR* FullPath,
    const TCHAR* ChannelName
)

Adds an existing file to the cache.

Public function

int32

 

AddTask

(
    const FTaskSpecification& Specific...
)

Adds a Task to the current Job

Public function

int32

 

BeginJobSpecification

(
    const FJobSpecification& Specifica...,
    const FJobSpecification& Specifica...
)

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

Public function

int32

 

CloseChannel

(
    int32 Channel
)

Closes an open channel

Public function

int32

 

CloseConnection()

Closes an existing connection to the Swarm

Public function

int32

 

CloseJob()

Ends the Job, after which all Job-related API usage (except OpenJob) will be rejected

Public function

int32

 

EndJobSpecification()

Ends the Job specification, after which no additional Tasks may be defined.

Public function Static

FSwarmInterf...

 

Get()

Public function Static

bool

 

Initialize

(
    const TCHAR* SwarmInterfacePat...
)

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

Public function Virtual

bool

 

IsJobProcessRunning

(
    int32* OutStatus
)

Checks if the job's process is still running

Public function

int32

 

Log

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

Adds a line of text to the Agent log window

Public function

int32

 

OpenChannel

(
    const TCHAR* ChannelName,
    TChannelFlags ChannelFlags
)

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

Public function

int32

 

OpenConnection

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

Opens a new connection to the Swarm

Public function

int32

 

OpenJob

(
    const FGuid& JobGuid
)

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

Public function

int32

 

ReadChannel

(
    int32 Channel,
    void* Data,
    int32 DataSize
)

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

Public function

int32

 

SendMessage

(
    const FMessage& Message
)

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

Public function Virtual

void

 

SetJobGuid

(
    const FGuid& JobGuid
)

Public function

int32

 

TestChannel

(
    const TCHAR* ChannelName
)

Determines if the named channel is in the cache

Public function

int32

 

WriteChannel

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

Writes the provided data to the open channel opened for WRITE

Constants

Name

Description

GInstance
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss