triton_cpp::SharedMemoryRegion Class Reference

Own a POSIX shared-memory mapping used by the Triton client. More...

#include <shm.hpp>

Public Member Functions
	SharedMemoryRegion (const std::string &key, std::int64_t size)
	Create and map a system shared-memory region.
	SharedMemoryRegion (const SharedMemoryRegion &)=delete
SharedMemoryRegion &	operator= (const SharedMemoryRegion &)=delete
	SharedMemoryRegion (SharedMemoryRegion &&) noexcept=default
SharedMemoryRegion &	operator= (SharedMemoryRegion &&)=delete
	~SharedMemoryRegion ()=default
uint8_t *	getAddress () const
std::string	getKey () const

Detailed Description

Own a POSIX shared-memory mapping used by the Triton client.

Construction creates, sizes, and maps the region. Destruction unmaps and unlinks it.

Definition at line 114 of file shm.hpp.

Constructor & Destructor Documentation

SharedMemoryRegion() [1/3]

triton_cpp::SharedMemoryRegion::SharedMemoryRegion ( const std::string & key, std::int64_t size )

inline

Create and map a system shared-memory region.

Parameters

key	POSIX shared-memory key, including its leading slash.
size	Region size in bytes.

Exceptions

std::runtime_error

if the region cannot be created, mapped, or closed.

Definition at line 122 of file shm.hpp.

: memory_{key, size} {}

SharedMemoryRegion() [2/3]

triton_cpp::SharedMemoryRegion::SharedMemoryRegion ( const SharedMemoryRegion & )

delete

SharedMemoryRegion() [3/3]

triton_cpp::SharedMemoryRegion::SharedMemoryRegion ( SharedMemoryRegion && )

defaultnoexcept

~SharedMemoryRegion()

triton_cpp::SharedMemoryRegion::~SharedMemoryRegion ( )

default

Member Function Documentation

getAddress()

uint8_t * triton_cpp::SharedMemoryRegion::getAddress ( ) const

inline

Returns

Host address of the mapped region.

Definition at line 131 of file shm.hpp.

{ return memory_.address(); }

References triton_cpp::detail::PosixSharedMemory::address().

getKey()

std::string triton_cpp::SharedMemoryRegion::getKey ( ) const

inline

Returns

POSIX shared-memory key used for the region.

Definition at line 133 of file shm.hpp.

{ return memory_.key(); }

References triton_cpp::detail::PosixSharedMemory::key().

operator=() [1/2]

SharedMemoryRegion & triton_cpp::SharedMemoryRegion::operator= ( const SharedMemoryRegion & )

delete

operator=() [2/2]

SharedMemoryRegion & triton_cpp::SharedMemoryRegion::operator= ( SharedMemoryRegion && )

delete

---

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

• include/triton_cpp/shm.hpp