Os::Memory Class Reference

memory implementation More...

#include <Os/Memory.hpp>

Inheritance diagram for Os::Memory:

Public Member Functions
	Memory ()
	default constructor More...
	~Memory () final
	default virtual destructor More...
	Memory (const MemoryInterface &other)=delete
	copy constructor is forbidden More...
	Memory (const MemoryInterface *other)=delete
	copy constructor is forbidden More...
MemoryInterface &	operator= (const MemoryInterface &other) override=delete
	assignment operator is forbidden More...
Status	_getUsage (Usage &memory_usage) override
	get system memory usage More...
MemoryHandle *	getHandle () override
	return the underlying memory handle (implementation specific). More...
Public Member Functions inherited from Os::MemoryInterface
	MemoryInterface ()=default
	Default constructor. More...
virtual	~MemoryInterface ()=default
	Default destructor. More...
	MemoryInterface (const MemoryInterface &other)=delete
	copy constructor is forbidden More...

Static Public Member Functions
static void	init ()
	initialize the singleton More...
static Memory &	getSingleton ()
	return singleton More...
static Status	getUsage (Usage &memory)
	get system memory usage More...
Static Public Member Functions inherited from Os::MemoryInterface
static MemoryInterface *	getDelegate (MemoryHandleStorage &aligned_new_memory)
	provide a pointer to a Mutex delegate object More...

Additional Inherited Members
Public Types inherited from Os::MemoryInterface
using	Status = Os::Generic::Status
using	Usage = Os::Generic::UsedTotal

Detailed Description

memory implementation

Definition at line 47 of file Memory.hpp.

Constructor & Destructor Documentation

Memory() [1/3]

Os::Memory::Memory

(

)

default constructor

Definition at line 10 of file Memory.cpp.

~Memory()

Os::Memory::~Memory ( )

final

default virtual destructor

Definition at line 12 of file Memory.cpp.

Memory() [2/3]

Os::Memory::Memory ( const MemoryInterface &  other )

delete

copy constructor is forbidden

Memory() [3/3]

Os::Memory::Memory ( const MemoryInterface *  other )

delete

copy constructor is forbidden

Member Function Documentation

_getUsage()

Memory::Status Os::Memory::_getUsage ( Usage &  memory_usage )

overridevirtual

get system memory usage

This method delegates to the underlying implementation.

Parameters

memory_usage

(output) data structure used to store memory usage

Returns

: ERROR when error occurs, OK otherwise.

Implements Os::MemoryInterface.

Definition at line 25 of file Memory.cpp.

getHandle()

MemoryHandle * Os::Memory::getHandle ( )

overridevirtual

return the underlying memory handle (implementation specific).

Returns

internal task handle representation

Implements Os::MemoryInterface.

Definition at line 34 of file Memory.cpp.

getSingleton()

Memory & Os::Memory::getSingleton ( )

static

return singleton

Definition at line 20 of file Memory.cpp.

getUsage()

Memory::Status Os::Memory::getUsage ( Usage &  memory )

static

get system memory usage

This method wraps delegates to the underlying implementation.

Parameters

memory_usage

(output) data structure used to store memory usage

Returns

: ERROR when error occurs, OK otherwise.

Definition at line 30 of file Memory.cpp.

init()

void Os::Memory::init ( )

static

initialize the singleton

Definition at line 16 of file Memory.cpp.

operator=()

MemoryInterface& Os::Memory::operator= ( const MemoryInterface &  other )

overridevirtualdelete

assignment operator is forbidden

Reimplemented from Os::MemoryInterface.

---

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

• Os/Memory.hpp
• Os/Memory.cpp