UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUnixPlatformMemory::FUnixSharedMemoryRegion Struct Reference

#include <UnixPlatformMemory.h>

+ Inheritance diagram for FUnixPlatformMemory::FUnixSharedMemoryRegion:

Public Member Functions

int GetFileDescriptor () const
 
bool NeedsToUnlinkRegion () const
 
 FUnixSharedMemoryRegion (const FString &InName, uint32 InAccessMode, void *InAddress, SIZE_T InSize, int InFd, bool bInCreatedThisRegion)
 
- Public Member Functions inherited from FGenericPlatformMemory::FSharedMemoryRegion
const TCHARGetName () const
 
voidGetAddress ()
 
const voidGetAddress () const
 
SIZE_T GetSize () const
 
 FSharedMemoryRegion (const FString &InName, uint32 InAccessMode, void *InAddress, SIZE_T InSize)
 

Protected Attributes

int Fd
 
bool bCreatedThisRegion
 
- Protected Attributes inherited from FGenericPlatformMemory::FSharedMemoryRegion
TCHAR Name [MaxSharedMemoryName]
 
uint32 AccessMode
 
voidAddress
 
SIZE_T Size
 

Additional Inherited Members

- Protected Types inherited from FGenericPlatformMemory::FSharedMemoryRegion
enum  Limits { MaxSharedMemoryName = 128 }
 

Detailed Description

Unix representation of a shared memory region

Constructor & Destructor Documentation

◆ FUnixSharedMemoryRegion()

FUnixPlatformMemory::FUnixSharedMemoryRegion::FUnixSharedMemoryRegion ( const FString &  InName,
uint32  InAccessMode,
void InAddress,
SIZE_T  InSize,
int  InFd,
bool  bInCreatedThisRegion 
)
inline

Member Function Documentation

◆ GetFileDescriptor()

int FUnixPlatformMemory::FUnixSharedMemoryRegion::GetFileDescriptor ( ) const
inline

Returns file descriptor of a shared memory object

◆ NeedsToUnlinkRegion()

bool FUnixPlatformMemory::FUnixSharedMemoryRegion::NeedsToUnlinkRegion ( ) const
inline

Returns true if we need to unlink this region on destruction (no other process will be able to access it)

Member Data Documentation

◆ bCreatedThisRegion

bool FUnixPlatformMemory::FUnixSharedMemoryRegion::bCreatedThisRegion
protected

Whether we created this region

◆ Fd

int FUnixPlatformMemory::FUnixSharedMemoryRegion::Fd
protected

File descriptor of a shared region


The documentation for this struct was generated from the following file: