memory_data.h

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
// software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
// derivative works of the software or any portion of the software, and you may copy and distribute such modifications
// or works. Modified works should carry a notice stating that you changed the software and should note the date and
// nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
// source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
// EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
// WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
// CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
// THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
// are solely responsible for determining the appropriateness of using and distributing the software and you assume
// all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
// with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of 
// operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
// damage to property. The software developed by NIST employees is not subject to copyright protection within the
// United States.


#ifndef HEDGEHOG_MEMORY_DATA_H
#define HEDGEHOG_MEMORY_DATA_H

#include <memory>
#include "abstract_memory_manager.h"

namespace hh {

template<class ManagedMemory>
class MemoryData : public std::enable_shared_from_this<MemoryData<ManagedMemory>> {
 private:
  AbstractMemoryManager <ManagedMemory> *memoryManager_ = nullptr; 
 public:
  MemoryData() = default;

  virtual ~MemoryData() = default;

  [[nodiscard]] AbstractMemoryManager <ManagedMemory> *memoryManager() const { return memoryManager_; }

  void memoryManager(AbstractMemoryManager <ManagedMemory> *memoryManager) { memoryManager_ = memoryManager; }

  void returnToMemoryManager() { this->memoryManager_->recycleMemory(this->shared_from_this()); }

  virtual void used() {};

  virtual bool canBeRecycled() { return true; }

  virtual void recycle() {};
};
}
#endif //HEDGEHOG_MEMORY_DATA_H