1. Epic GamesDeveloper
  3. FAgentMessageChannel

FAgentMessageChannel

Channel for receiving agent messages.

API > API/Developer > API/Developer/Horde

Channel for receiving agent messages.

   
Name FAgentMessageChannel
Type class
Header File /Engine/Source/Developer/Horde/Public/Compute/AgentMessage.h
Include Path #include "Compute/AgentMessage.h"

Syntax

class FAgentMessageChannel

Constructors

Name Remarks Include Path Unreal Specifiers

FAgentMessageChannel ( TSharedPtr< FComputeChannel > InChannel
)

   Compute/AgentMessage.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAgentMessageChannel()

   Compute/AgentMessage.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChannelBuffers TSharedPtr< FComputeChannel >   Compute/AgentMessage.h  
MaxRequestSize size_t   Compute/AgentMessage.h  
MessageHeaderLength const size_t   Compute/AgentMessage.h  
RequestData unsigned char *   Compute/AgentMessage.h  
RequestSize size_t   Compute/AgentMessage.h  
ResponseData const unsigned char *   Compute/AgentMessage.h  
ResponseLength size_t   Compute/AgentMessage.h  
ResponseType EAgentMessageType   Compute/AgentMessage.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Attach()

 Notifies the remote that a buffer has been attached. Compute/AgentMessage.h  

void Blob ( const unsigned char* Data,
size_t Length
)

 Writes a blob requested by the remote. Compute/AgentMessage.h  

void Close()

 Closes the remote message loop. Compute/AgentMessage.h  

void DeleteFiles ( const char*const* Paths,
size_t Count
)

 Deletes files matching a set of wildcards. Compute/AgentMessage.h  

void Exception ( const char* Description,
const char* Trace
)

 Sends an exception response to the remote. Compute/AgentMessage.h  

void Execute ( const char* Exe,
const char*const* Args,
size_t NumArgs,
const char* WorkingDir,
const char*const* EnvVars,
size_t NumEnvVars,
EExecuteProcessFlags Flags
)

 Executes a process on the remote machine. Compute/AgentMessage.h  

void Fork ( int ChannelId,
int BufferSize
)

 Requests that the remote message loop be forked. Compute/AgentMessage.h  

const void * GetResponseData()

 Gets the raw data from a response. Compute/AgentMessage.h  

size_t GetResponseSize()

 Gets the size of the response. Compute/AgentMessage.h  

void Ping()

 Sends a ping message to the remote. Compute/AgentMessage.h  

void ReadBlobRequest ( AgentMessage::FBlobRequest& Ex
)

 Reads a blob request message. Compute/AgentMessage.h  

void ReadException ( AgentMessage::FException& Ex
)

 Reads an exception response. Compute/AgentMessage.h  

int ReadExecuteResult()

 Reads the result from executing a process. Compute/AgentMessage.h  

EAgentMessageType ReadResponse ( int32 TimeoutMS,
bool* bOutTimedOut
)

 Reads a response from the remote. Other Read methods can be used to access response data. Compute/AgentMessage.h  

void UploadFiles ( const char* Path,
const char* Locator
)

 Extracts a bundle containing files to a particular path. Compute/AgentMessage.h  

void Xor ( const unsigned char* Data,
size_t Length,
unsigned char Value
)

 Send a message to request that a byte string be xor'ed with a particular value. Compute/AgentMessage.h  

Static

Name Remarks Include Path Unreal Specifiers

static size_t MeasureUnsignedVarInt ( size_t Value
)

   Compute/AgentMessage.h  

static const unsigned char * ReadFixedLengthBytes ( const unsigned char** Pos,
size_t Length
)

   Compute/AgentMessage.h  

static int ReadInt32 ( const unsigned char** Pos
)

   Compute/AgentMessage.h  

static FUtf8StringView ReadString ( const unsigned char** Pos
)

   Compute/AgentMessage.h  

static size_t ReadUnsignedVarInt ( const unsigned char** Pos
)

   Compute/AgentMessage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page