-/* Copyright (c) 2006-2015, 2017. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
#define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
+#include <simgrid/forward.h>
+#include <xbt/Extendable.hpp>
+#include <xbt/base.h>
+
#include <map>
-#include <simgrid/s4u/forward.hpp>
-#include <simgrid/simix.h>
#include <string>
#include <unordered_map>
-#include <xbt/base.h>
namespace simgrid {
+namespace xbt {
+extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
+}
namespace s4u {
-XBT_ATTRIB_PUBLIC std::map<std::string, Storage*>* allStorages();
+XBT_ATTRIB_DEPRECATED_v322(
+ "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22")
+ XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
-XBT_PUBLIC_CLASS Storage
-{
+class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
friend s4u::Engine;
friend simgrid::surf::StorageImpl;
public:
- explicit Storage(surf::StorageImpl * pimpl) : pimpl_(pimpl) {}
+ explicit Storage(std::string name, surf::StorageImpl * pimpl);
virtual ~Storage() = default;
/** Retrieve a Storage by its name. It must exist in the platform file */
- static Storage* byName(const char* name);
- const char* name();
- const char* type();
- Host* host();
- sg_size_t sizeFree();
- sg_size_t sizeUsed();
- /** Retrieve the total amount of space of this storage element */
- sg_size_t size();
-
- xbt_dict_t properties();
- const char* property(const char* key);
- void setProperty(const char* key, char* value);
- std::map<std::string, sg_size_t>* content();
+ static Storage* byName(std::string name);
+
+ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
+ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
+
+ /** @brief Retrieves the name of that storage as a C++ string */
+ std::string const& get_name() const;
+ /** @brief Retrieves the name of that storage as a C string */
+ const char* get_cname() const;
+
+ const char* getType();
+ Host* getHost();
+
+ std::map<std::string, std::string>* getProperties();
+ const char* getProperty(std::string key);
+ void setProperty(std::string, std::string value);
void setUserdata(void* data) { userdata_ = data; }
- void* userdata() { return userdata_; }
+ void* getUserdata() { return userdata_; }
+
+ sg_size_t read(sg_size_t size);
+ sg_size_t write(sg_size_t size);
+ surf::StorageImpl* getImpl() { return pimpl_; }
/* The signals */
/** @brief Callback signal fired when a new Link is created */
static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
Host* attached_to_ = nullptr;
- surf::StorageImpl* const pimpl_ = nullptr;
private:
+ surf::StorageImpl* const pimpl_ = nullptr;
std::string name_;
void* userdata_ = nullptr;
};