WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Classes | Public Member Functions | List of all members
wrench::DataMovementManager Class Reference

A helper daemon (co-located with an execution controler) that handles data movement operations. More...

#include <DataMovementManager.h>

Inheritance diagram for wrench::DataMovementManager:
wrench::Service

Public Member Functions

void doSynchronousFileCopy (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > src, std::shared_ptr< FileLocation > dst, std::shared_ptr< FileRegistryService > file_registry_service=nullptr)
 Ask the data manager to perform a synchronous file copy. More...
 
void initiateAsynchronousFileCopy (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > src, std::shared_ptr< FileLocation > dst, std::shared_ptr< FileRegistryService > file_registry_service=nullptr)
 Ask the data manager to initiate an asynchronous file copy. More...
 
void kill ()
 Kill the manager (brutally terminate the daemon)
 
void stop () override
 Stop the manager. More...
 
- Public Member Functions inherited from wrench::Service
void assertServiceIsUp ()
 Throws an exception if the service is not up. More...
 
std::string getHostname ()
 Get the name of the host on which the service is / will be running. More...
 
double getNetworkTimeoutValue ()
 Returns the service's network timeout value. More...
 
std::string getPhysicalHostname ()
 Get the physical name of the host on which the service is / will be running. More...
 
bool getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a boolean. More...
 
double getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a double. More...
 
std::string getPropertyValueAsString (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as a string. More...
 
unsigned long getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
 Get a property of the Service as an unsigned long. More...
 
bool isUp ()
 Returns true if the service is UP, false otherwise. More...
 
void resume ()
 Resume the service. More...
 
void setNetworkTimeoutValue (double value)
 Sets the service's network timeout value. More...
 
void start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
 Start the service. More...
 
void suspend ()
 Suspend the service.
 

Detailed Description

A helper daemon (co-located with an execution controler) that handles data movement operations.

Member Function Documentation

◆ doSynchronousFileCopy()

void wrench::DataMovementManager::doSynchronousFileCopy ( std::shared_ptr< DataFile file,
std::shared_ptr< FileLocation src,
std::shared_ptr< FileLocation dst,
std::shared_ptr< FileRegistryService file_registry_service = nullptr 
)

Ask the data manager to perform a synchronous file copy.

Parameters
filethe file to copy
srcthe source location
dstthe destination location
file_registry_servicea file registry service to update once the file copy has (successfully) completed (none if nullptr)
Exceptions
std::invalid_argument
ExecutionException

◆ initiateAsynchronousFileCopy()

void wrench::DataMovementManager::initiateAsynchronousFileCopy ( std::shared_ptr< DataFile file,
std::shared_ptr< FileLocation src,
std::shared_ptr< FileLocation dst,
std::shared_ptr< FileRegistryService file_registry_service = nullptr 
)

Ask the data manager to initiate an asynchronous file copy.

Parameters
filethe file to copy
srcthe source location
dstthe destination location
file_registry_servicea file registry service to update once the file copy has (successfully) completed (none if nullptr)
Exceptions
std::invalid_argument
ExecutionException

◆ stop()

void wrench::DataMovementManager::stop ( )
overridevirtual

Stop the manager.

Exceptions
ExecutionException
std::runtime_error

Reimplemented from wrench::Service.


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