FWorkerComputeSocket | Unreal Engine 5.7 Documentation

Socket used by a worker process to communicate with a host running on the same machine using shared memory to attach new buffers.


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

Syntax

class FWorkerComputeSocket : public FComputeSocket

Name	Remarks	Include Path	Unreal Specifiers
FWorkerComputeSocket()		Compute/ComputeSocket.h

Name	Remarks	Include Path	Unreal Specifiers
~FWorkerComputeSocket()		Compute/ComputeSocket.h

Name	Remarks
EMessageType

Name	Type	Remarks	Include Path
IpcEnvVar	const char *const		Compute/ComputeSocket.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Buffers	std::vector< FComputeBuffer >		Compute/ComputeSocket.h
CommandBufferWriter	FComputeBufferWriter		Compute/ComputeSocket.h

Name	Remarks	Include Path
void Close()	Close the current connection.	Compute/ComputeSocket.h
bool Open ()	Opens a connection to the agent process using a command buffer read from an environment variable (EnvVarName)	Compute/ComputeSocket.h
bool Open ( const char* CommandBufferName )	Opens a connection to the agent process using a specific command buffer name.	Compute/ComputeSocket.h

Name	Remarks	Include Path
virtual void AttachRecvBuffer ( int ChannelId, FComputeBuffer RecvBuffer )	Attaches a new buffer for receiving data.	Compute/ComputeSocket.h
virtual void AttachSendBuffer ( int ChannelId, FComputeBuffer SendBuffer )	Attaches a new buffer for sending data.	Compute/ComputeSocket.h
virtual void StartCommunication()	Begin communication with agent.	Compute/ComputeSocket.h

Name	Remarks	Include Path
static size_t ReadString ( const unsigned char* Pos, char* OutText, size_t OutTextMaxLen )		Compute/ComputeSocket.h
static size_t ReadVarUInt ( const unsigned char* Pos, unsigned int* OutValue )		Compute/ComputeSocket.h
static void RunServer ( FComputeBufferReader& CommandBufferReader, FComputeSocket& Socket )	Reads and handles a command from the command buffer.	Compute/ComputeSocket.h
static size_t WriteString ( unsigned char* Pos, const char* Text )		Compute/ComputeSocket.h
static size_t WriteVarUInt ( unsigned char* Pos, unsigned int Value )		Compute/ComputeSocket.h