1. Epic GamesDeveloper
  3. Horde

Horde

API > API/Developer

   
Name Horde
Type Developer
Location /Engine/Source/Developer/Horde/
Module Build Rules Horde.Build.cs

Classes

Name Remarks
FAgentMessageChannel Channel for receiving agent messages.
FBlobAlias Target for an aliased blob name
FBlobHandle Handle to a blob.
FBlobHandleData Base interface for a blob.
FBlobLocator Identifies the location of a blob. Meaning of this string is implementation defined.
FBlobReader Reads data from a blob object
FBlobWriter Interface for writing data to the storage system.
FBufferTransport Implementation of FComputeTransport which uses in-memory buffers to transport data
FBundleStorageClient Base class for an implementation of IStorageClient, providing implementations for some common functionality using bundles.
FBundleWriter Writes blobs into bundles
FChunkedBufferWriter Writes data to a series of memory blocks
FChunkNode Node containing a chunk of data
FChunkNodeReader Utility class for reading data a data stream from a tree of chunk nodes
FChunkNodeWriter Utility class for writing new data to a tree of chunk nodes
FComputeBuffer Implements a ring buffer using shared memory, with one writer and multiple readers.
FComputeBufferReader Facilitates reading data from a compute buffer
FComputeBufferWriter Facilitates writing data to a compute buffer
FComputeChannel Allows bi-directional communication between two nodes using compute buffers
FComputeSocket Connection to a remote machine that multiplexes data into and out-of multiple buffers attached to different channel numbers.
FComputeTransport Interface for a transport mechanism that can be used by a compute socket
FDirectoryEntry Entry for a directory within a directory node
FDirectoryNode Stores the contents of a directory in a blob
FExportHandleData Implementation of export handle data.
FFileStorageClient Implementation of FStorageClient which writes data to files on disk.
FHordeHttpClient  
FKeyValueStorageClient Base class for storage clients that wrap a diirect key/value type store without any merging/splitting.
FMemoryStorageClient Implementation of FStorageClient which stores data in memory.
FPacket Accessor for data structures stored into a serialized bundle packet.
FPacketHandleData Data for FPacketHandle.
FPacketReader Utility class for constructing BlobData objects from a packet, caching any computed handles to other blobs.
FPacketWriter Writes exports into a new bundle packet
FSharedBufferView View into a buffer with shared ownership
FStorageClient Interface for the storage system.
FWorkerComputeSocket Socket used by a worker process to communicate with a host running on the same machine using shared memory to attach new buffers.
TBlobHandle Handle to a blob with a particular state representation

Structs

Name Remarks
FAliasInfo Alias for newly added blobs
FBlob Describes a blob of data in the storage system
FBlobHandleWithHash Stores a blob handle along with a hash of the target node.
FBlobRequest  
FBlobType Identifies the type of a blob
FBundle General bundle properties
FBundleCompression Utility methods for compressing bundles
FBundleOptions Options for configuring a bundle serializer
FBundleSignature Signature for a bundle
FChunkingOptions Options for chunking data
FException  
FGetAuthConfigResponse Describes the auth config for this server
FGetServerInfoResponse Server Info
FHorde  
FPacketExport Data for an exported node in a packet
FPacketImport Specifies the path to an imported node
FRefCacheTime Specifies a relative or absolute time value for returning cached ref values
FRefName Identifier for a ref in the storage system. Refs serve as GC roots, and are persistent entry points to expanding data structures within the store.
FRefOptions Options for adding a new ref

Typedefs

Name Type Remarks Include Path
FExportHandle TBlobHandle< FExportHandleData > Handle to an export within a packet. Storage/Bundles/V2/ExportHandle.h
FPacketHandle TBlobHandle< FPacketHandleData > Handle to an packet within a bundle. Storage/Bundles/V2/PacketHandle.h

Enums

Public

Name Remarks
EAgentMessageType Type of a compute message.
EBundleCompressionFormat Indicates the compression format in a bundle
EBundleVersion Bundle version number
EComputeSocketEndpoint Enum identifying which end of the socket a particular machine is
EDirectoryFlags Flags for a directory node
EExecuteProcessFlags Flags describing how to execute a compute task process on the agent.
EFileEntryFlags Flags for a file entry

Functions

Public

Name Remarks Include Path Unreal Specifiers

TUniquePtr< FComputeSocket > CreateComputeSocket ( TUniquePtr< FComputeTransport > Transport,
EComputeSocketEndpoint Endpoint
)

 Creates a socket using a custom transport. Also returns the default channel (channel 0) Compute/ComputeSocket.h  

ENUM_CLASS_FLAGS ( EFileEntryFlags
)

 Entry for a file within a directory node Storage/Nodes/FileEntry.h  

size_t MeasureString ( const char* Text
)

   Storage/BlobWriter.h  

size_t MeasureString ( const FUtf8StringView& Text
)

   Storage/BlobWriter.h  

size_t MeasureUnsignedVarInt ( size_t Value
)

   Storage/BlobWriter.h  

FBlobHandle ReadBlobHandle ( FBlobReader& Reader
)

   Storage/BlobReader.h  

FBlobHandleWithHash ReadBlobHandleWithHash ( FBlobReader& Reader
)

   Storage/BlobReader.h  

FMemoryView ReadFixedLengthBytes ( FBlobReader& Reader,
size_t Length
)

   Storage/BlobReader.h  

int ReadInt32 ( FBlobReader& Reader
)

   Storage/BlobReader.h  

FIoHash ReadIoHash ( FBlobReader& Reader
)

   Storage/BlobReader.h  

FUtf8String ReadString ( FBlobReader& Reader
)

   Storage/BlobReader.h  

FMemoryView ReadStringSpan ( FBlobReader& Reader
)

   Storage/BlobReader.h  

size_t ReadUnsignedVarInt ( FBlobReader& Reader
)

   Storage/BlobReader.h  

void WriteBlobHandle ( FBlobWriter& Writer,
FBlobHandle Handle
)

   Storage/BlobWriter.h  

void WriteBlobHandleWithHash ( FBlobWriter& Writer,
FBlobHandleWithHash Target
)

   Storage/BlobWriter.h  

void WriteFixedLengthBytes ( FBlobWriter& Writer,
const FMemoryView& View
)

   Storage/BlobWriter.h  

void WriteFixedLengthBytes ( FBlobWriter& Writer,
const void* Data,
size_t Length
)

   Storage/BlobWriter.h  

void WriteIoHash ( FBlobWriter& Writer,
const FIoHash& Hash
)

   Storage/BlobWriter.h  

void WriteString ( FBlobWriter& Writer,
const char* Text
)

   Storage/BlobWriter.h  

void WriteString ( FBlobWriter& Writer,
const FUtf8StringView& Text
)

   Storage/BlobWriter.h  

void WriteString ( FBlobWriter& Writer,
const FUtf8String& Text
)

   Storage/BlobWriter.h  

size_t WriteUnsignedVarInt ( void* Buffer,
size_t Value
)

   Storage/BlobWriter.h  

void WriteUnsignedVarInt ( FBlobWriter& Writer,
size_t Value
)

   Storage/BlobWriter.h  

void WriteUnsignedVarIntWithKnownLength ( void* Buffer,
size_t Value,
size_t NumBytes
)

   Storage/BlobWriter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page