LocalMemorySlot Class Reference

HiCR: HiCR::backend::mpi::LocalMemorySlot Class Reference
HiCR
HiCR::backend::mpi::LocalMemorySlot Class Referencefinal

#include <localMemorySlot.hpp>

Inheritance diagram for HiCR::backend::mpi::LocalMemorySlot:
HiCR::LocalMemorySlot

Public Member Functions

 LocalMemorySlot (void *const pointer, const size_t size, std::shared_ptr< HiCR::MemorySpace > memorySpace)
 
 ~LocalMemorySlot () override=default
 
- Public Member Functions inherited from HiCR::LocalMemorySlot
 LocalMemorySlot (void *const pointer, const size_t size, std::shared_ptr< HiCR::MemorySpace > memorySpace=nullptr)
 
__INLINE__ void *& getPointer () noexcept
 
__INLINE__ size_t getSize () const noexcept
 
__INLINE__ std::shared_ptr< HiCR::MemorySpacegetMemorySpace () const noexcept
 
__INLINE__ size_t getMessagesRecv () const noexcept
 
__INLINE__ size_t getMessagesSent () const noexcept
 

Friends

class HiCR::backend::mpi::CommunicationManager
 

Detailed Description

This class represents an abstract definition for a Memory Slot resource in HiCR that:

  • Represents a contiguous segment within a memory space, with a starting address and a size

Constructor & Destructor Documentation

◆ LocalMemorySlot()

HiCR::backend::mpi::LocalMemorySlot::LocalMemorySlot ( void *const  pointer,
const size_t  size,
std::shared_ptr< HiCR::MemorySpace memorySpace 
)
inline

Constructor for a MemorySlot class for the MPI backend

Parameters
[in]pointerIf this is a local slot (same rank as this the running process), this pointer indicates the address of the local memory segment
[in]sizeThe size (in bytes) of the memory slot, assumed to be contiguous
[in]memorySpaceThe memory space from whence this memory slot was created

◆ ~LocalMemorySlot()

HiCR::backend::mpi::LocalMemorySlot::~LocalMemorySlot ( )
overridevirtualdefault

Default destructor

Reimplemented from HiCR::LocalMemorySlot.


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